Class DialogProperties

Inheritance
System.Object
EJTagHelper
DialogProperties
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Syncfusion.JavaScript.Models
Assembly: Syncfusion.EJ.dll
Syntax
public class DialogProperties : EJTagHelper

Constructors

DialogProperties()

Constructor for DialogProperties model class

Declaration
public DialogProperties()

Properties

ActionButtonClick

Triggered when the custom action button is clicked.

Declaration
[JsonProperty("actionButtonClick")]
public string ActionButtonClick { get; set; }
Property Value
Type Description
System.String

ActionButtons

Adds action buttons like close, minimize, pin, maximize in the dialog header.

Declaration
[JsonProperty("actionButtons")]
public List<string> ActionButtons { get; set; }
Property Value
Type Description
System.Collections.Generic.List<System.String>

AjaxError

This event is triggered whenever the Ajax request fails to retrieve the dialog content.

Declaration
[JsonProperty("ajaxError")]
public string AjaxError { get; set; }
Property Value
Type Description
System.String

AjaxSettings

Specifies the ajaxSettings option to load the content to the dialog control.

Declaration
[JsonProperty("ajaxSettings")]
public object AjaxSettings { get; set; }
Property Value
Type Description
System.Object

AjaxSuccess

This event is triggered whenever the Ajax request to retrieve the dialog content, gets succeed.

Declaration
[JsonProperty("ajaxSuccess")]
public string AjaxSuccess { get; set; }
Property Value
Type Description
System.String

AllowDraggable

Enables or disables draggable.

Declaration
[JsonProperty("allowDraggable")]
public bool AllowDraggable { get; set; }
Property Value
Type Description
System.Boolean

AllowKeyboardNavigation

Enables or disables keyboard interaction.

Declaration
[JsonProperty("allowKeyboardNavigation")]
public bool AllowKeyboardNavigation { get; set; }
Property Value
Type Description
System.Boolean

Animation

Customizes the Dialog widget animations. The Dialog widget can be animated while opening and closing the dialog. In order to customize animation effects, you need to set “enableAnimation” as true.

Declaration
[JsonProperty("animation")]
public Animation Animation { get; set; }
Property Value
Type Description
Animation

BackgroundScroll

Enable or Disable the Modal Dialog background scroller.

Declaration
[JsonProperty("backgroundScroll")]
public bool BackgroundScroll { get; set; }
Property Value
Type Description
System.Boolean

BeforeClose

This event is triggered before the dialog widgets get closed.

Declaration
[JsonProperty("beforeClose")]
public string BeforeClose { get; set; }
Property Value
Type Description
System.String

BeforeOpen

This event is triggered before the dialog widgets gets open.

Declaration
[JsonProperty("beforeOpen")]
public string BeforeOpen { get; set; }
Property Value
Type Description
System.String

Close

This event is triggered after the dialog widget is closed.

Declaration
[JsonProperty("close")]
public string Close { get; set; }
Property Value
Type Description
System.String

CloseIconTooltip

The tooltip text for the dialog close button.

Declaration
[JsonProperty("closeIconTooltip")]
[JsonIgnore]
[Obsolete("The closeIconTooltip property has been deprecated.We have added 'Tooltip' instead of closeIconTooltip")]
public string CloseIconTooltip { get; set; }
Property Value
Type Description
System.String

CloseOnEscape

Closes the dialog widget on pressing the ESC key when it is set to true.

Declaration
[JsonProperty("closeOnEscape")]
public bool CloseOnEscape { get; set; }
Property Value
Type Description
System.Boolean

Collapse

Triggered when the dialog content is collapsed.

Declaration
[JsonProperty("collapse")]
public string Collapse { get; set; }
Property Value
Type Description
System.String

Containment

The selector for the container element. If the property is set, then dialog will append to the selected element and it is restricted to move only within the specified container element.

Declaration
[JsonProperty("containment")]
public string Containment { get; set; }
Property Value
Type Description
System.String

Content

The selector for the container element. If this property is set, the dialog will be displayed (positioned) based on its container.

Declaration
[JsonProperty("content")]
[JsonIgnore]
[Obsolete("The content property has been deprecated.Use Target instead of content ")]
public string Content { get; set; }
Property Value
Type Description
System.String

ContentLoad

Triggered after the dialog content is loaded in DOM.

Declaration
[JsonProperty("contentLoad")]
public string ContentLoad { get; set; }
Property Value
Type Description
System.String

ContentTemplate

To get or set value for ContentTemplate.

Declaration
[JsonIgnore]
public MvcTemplate<object> ContentTemplate { get; set; }
Property Value
Type Description
MvcTemplate<System.Object>

ContentType

The content type to load the dialog content at run time. The possible values are null, AJAX, iframe and image. When it is null (default value), the content inside dialog element will be displayed as content and when it is not null, the content will be loaded from the URL specified in the contentUrl property.

Declaration
[JsonProperty("contentType")]
public string ContentType { get; set; }
Property Value
Type Description
System.String

ContentUrl

Specifies the URL to load the dialog content (such as AJAX, image, and iframe). In order to load content from URL, you need to set contentType as ‘ajax’ or ‘iframe’ or ‘image’ with string argument.

Declaration
[JsonProperty("contentUrl")]
public string ContentUrl { get; set; }
Property Value
Type Description
System.String

Create

Triggered after the dialog is created successfully.

Declaration
[JsonProperty("create")]
public string Create { get; set; }
Property Value
Type Description
System.String

CssClass

The root class for the Dialog widget to customize the existing theme.

Declaration
[JsonProperty("cssClass")]
public string CssClass { get; set; }
Property Value
Type Description
System.String

Destroy

Triggered after the dialog widget is destroyed successfully.

Declaration
[JsonProperty("destroy")]
public string Destroy { get; set; }
Property Value
Type Description
System.String

Drag

Triggered while the dialog is dragged.

Declaration
[JsonProperty("drag")]
public string Drag { get; set; }
Property Value
Type Description
System.String

DragStart

Triggered when the user starts dragging the dialog.

Declaration
[JsonProperty("dragStart")]
public string DragStart { get; set; }
Property Value
Type Description
System.String

DragStop

Triggered when the user stops dragging the dialog.

Declaration
[JsonProperty("dragStop")]
public string DragStop { get; set; }
Property Value
Type Description
System.String

EnableAnimation

Enable or disables animation when the dialog is closed.

Declaration
[JsonProperty("enableAnimation")]
public bool EnableAnimation { get; set; }
Property Value
Type Description
System.Boolean

EnableAutoResize

Enable or disables responsive behavior.

Declaration
[JsonProperty("isResponsive")]
[Obsolete("The EnableAutoResize property has been deprecated. Use 'IsResponsive' instead of EnableAutoResize")]
public bool EnableAutoResize { get; set; }
Property Value
Type Description
System.Boolean

Enabled

Enables or disables the Dialog widget.

Declaration
[JsonProperty("enabled")]
public bool Enabled { get; set; }
Property Value
Type Description
System.Boolean

EnableModal

Enable or disables modal dialog. The modal dialog acts like a child window that is displayed on top of the main window/screen and disables the main window interaction until it is closed.

Declaration
[JsonProperty("enableModal")]
public bool EnableModal { get; set; }
Property Value
Type Description
System.Boolean

EnablePersistence

Allows the current model values to be saved in local storage or browser cookies for state maintenance when it is set to true.

Declaration
[JsonProperty("enablePersistence")]
public bool EnablePersistence { get; set; }
Property Value
Type Description
System.Boolean

EnableResize

Allows the dialog to be resized. The dialog cannot be resized less than the minimum height, width values and greater than the maximum height and width.

Declaration
[JsonProperty("enableResize")]
public bool EnableResize { get; set; }
Property Value
Type Description
System.Boolean

EnableRTL

Displays dialog content from right to left when set to true.By defaults it will be LTR.

Declaration
[JsonProperty("enableRTL")]
public bool EnableRTL { get; set; }
Property Value
Type Description
System.Boolean

Expand

Triggered when the dialog content is expanded.

Declaration
[JsonProperty("expand")]
public string Expand { get; set; }
Property Value
Type Description
System.String

FaviconCSS

The CSS class name to display the favicon in the dialog header. In order to display favicon, you need to set showHeader as true since the favicon will be displayed in the dialog header.

Declaration
[JsonProperty("faviconCSS")]
public string FaviconCSS { get; set; }
Property Value
Type Description
System.String

FooterTemplateId

This content to be displayed in dialog footer. In order to set content, before you need to set showFooter as true.

Declaration
[JsonProperty("footerTemplateId")]
public string FooterTemplateId { get; set; }
Property Value
Type Description
System.String

Height

Sets the height for the dialog widget. It accepts both string and integer values. For example, it can accepts values like “auto”, “100%”, “100px” as string type and “100”, “500” as integer type. The unit of integer type value is “px”.

Declaration
[JsonProperty("height")]
public object Height { get; set; }
Property Value
Type Description
System.Object

HtmlAttributes

Allows to define the characteristics of the Dialog control through the html attributes.

Declaration
[JsonProperty("htmlAttributes")]
public IDictionary<string, object> HtmlAttributes { get; set; }
Property Value
Type Description
System.Collections.Generic.IDictionary<System.String, System.Object>

IsResponsive

Enable or disables responsive behavior.

Declaration
[JsonProperty("isResponsive")]
public bool IsResponsive { get; set; }
Property Value
Type Description
System.Boolean

Locale

Set the localization culture for Dialog Widget.

Declaration
[JsonProperty("locale")]
public string Locale { get; set; }
Property Value
Type Description
System.String

MaxHeight

Sets the maximum height for the dialog widget.

Declaration
[JsonProperty("maxHeight")]
public object MaxHeight { get; set; }
Property Value
Type Description
System.Object

MaxWidth

Sets the maximum width for the dialog widget.

Declaration
[JsonProperty("maxWidth")]
public object MaxWidth { get; set; }
Property Value
Type Description
System.Object

MinHeight

Sets the minimum height for the dialog widget.

Declaration
[JsonProperty("minHeight")]
public object MinHeight { get; set; }
Property Value
Type Description
System.Object

MinWidth

Sets the minimum width for the dialog widget.

Declaration
[JsonProperty("minWidth")]
public object MinWidth { get; set; }
Property Value
Type Description
System.Object

Open

Triggered after the dialog is opened.

Declaration
[JsonProperty("open")]
public string Open { get; set; }
Property Value
Type Description
System.String

Position

Displays the Dialog widget at the given X and Y position.

Declaration
[JsonProperty("position")]
public Position Position { get; set; }
Property Value
Type Description
Position

Resize

Triggered while the dialog is resized.

Declaration
[JsonProperty("resize")]
public string Resize { get; set; }
Property Value
Type Description
System.String

ResizeStart

Triggered when the user starts resizing the dialog.

Declaration
[JsonProperty("resizeStart")]
public string ResizeStart { get; set; }
Property Value
Type Description
System.String

ResizeStop

Triggered when the user stops resizing the dialog.

Declaration
[JsonProperty("resizeStop")]
public string ResizeStop { get; set; }
Property Value
Type Description
System.String

ShowFooter

Shows or hides the dialog footer.

Declaration
[JsonProperty("showFooter")]
public bool ShowFooter { get; set; }
Property Value
Type Description
System.Boolean

ShowHeader

Shows or hides the dialog header.

Declaration
[JsonProperty("showHeader")]
public bool ShowHeader { get; set; }
Property Value
Type Description
System.Boolean

ShowOnInit

The Dialog widget is being opened by default (i.e. on initialization) ,when its boolean value is set to true.

Declaration
[JsonProperty("showOnInit")]
public bool ShowOnInit { get; set; }
Property Value
Type Description
System.Boolean

ShowRoundedCorner

Enables or disables the rounded corner for dialog window.

Declaration
[JsonProperty("showRoundedCorner")]
public bool ShowRoundedCorner { get; set; }
Property Value
Type Description
System.Boolean

Target

The selector for the container element. If this property is set, the dialog will be displayed (positioned) based on its container.

Declaration
[JsonProperty("target")]
public string Target { get; set; }
Property Value
Type Description
System.String

Title

The title text to be displayed in the dialog header. In order to set title, you need to set showHeader as true since the title will be displayed in the dialog header.

Declaration
[JsonProperty("title")]
public string Title { get; set; }
Property Value
Type Description
System.String

Tooltip

Add or configure the tooltip text for actionButtons in the dialog header.

Declaration
[JsonProperty("tooltip")]
public DialogTooltip Tooltip { get; set; }
Property Value
Type Description
DialogTooltip

Width

Sets the width for the dialog widget. It accepts both string and integer values. For example, it can accepts values like “auto”, “100%”, “100px” as string type and “100”, “500” as integer type. The unit of integer type value is “px”.

Declaration
[JsonProperty("width")]
public object Width { get; set; }
Property Value
Type Description
System.Object

ZIndex

Sets the z-index value for the Dialog widget.

Declaration
[JsonProperty("zIndex")]
public int ZIndex { get; set; }
Property Value
Type Description
System.Int32

Methods

GetControlDetails()

Declaration
protected override object GetControlDetails()
Returns
Type Description
System.Object
Overrides

ShouldSerializeAjaxSettings()

ShouldSerialize Method for AjaxSettings

Declaration
public bool ShouldSerializeAjaxSettings()
Returns
Type Description
System.Boolean

ShouldSerializeAnimation()

ShouldSerialize Method for Animation

Declaration
public bool ShouldSerializeAnimation()
Returns
Type Description
System.Boolean

ShouldSerializeIconAction()

ShouldSerialize Method for IconAction

Declaration
public bool ShouldSerializeIconAction()
Returns
Type Description
System.Boolean

ShouldSerializePosition()

ShouldSerialize Method for Position

Declaration
public bool ShouldSerializePosition()
Returns
Type Description
System.Boolean