Class Dialog

Inheritance
System.Object
TagHelper
EJTagHelper
Dialog
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.EJ2.Popups
Assembly: Syncfusion.EJ2.dll
Syntax
public class Dialog : EJTagHelper

Constructors

Dialog()

Declaration
public Dialog()

Properties

AllowDragging

Specifies the value whether the dialog component can be dragged by the end-user. The dialog allows to drag by selecting the header and dragging it for re-position the dialog.

Declaration
[HtmlAttributeName("allowDragging")]
public bool AllowDragging { get; set; }
Property Value
Type Description
System.Boolean

AnimationSettings

Specifies the animation settings of the dialog component. The animation effect can be applied on open and close the dialog with duration and delay.

Declaration
[HtmlAttributeName("animationSettings")]
public DialogAnimationSettings AnimationSettings { get; set; }
Property Value
Type Description
DialogAnimationSettings

BeforeClose

Event triggers before the dialog is closed. If you cancel this event, the dialog remains opened. Set the cancel argument to true to cancel the closure of a dialog.

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

BeforeOpen

Event triggers when the dialog is being opened. If you cancel this event, the dialog remains closed. Set the cancel argument to true to cancel the open of a dialog.

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

BeforeSanitizeHtml

Event triggers before sanitize the value.

Declaration
[HtmlAttributeName("beforeSanitizeHtml")]
public string BeforeSanitizeHtml { get; set; }
Property Value
Type Description
System.String

Buttons

Configures the action buttons that contains button properties with primary attributes and click events. One or more action buttons can be configured to the dialog.

Declaration
[HtmlAttributeName("buttons")]
public List<DialogDialogButton> Buttons { get; set; }
Property Value
Type Description
System.Collections.Generic.List<DialogDialogButton>

ClassName

Declaration
protected override string ClassName { get; }
Property Value
Type Description
System.String
Overrides

Close

Event triggers after the dialog has been closed.

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

CloseOnEscape

Specifies the boolean value whether the dialog can be closed with the escape key that is used to control the dialog's closing behavior.

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

Content

Specifies the value that can be displayed in dialog's content area. It can be information, list, or other HTML elements. The content of dialog can be loaded with dynamic data such as database, AJAX content, and more.

Declaration
[HtmlAttributeName("content")]
public string Content { get; set; }
Property Value
Type Description
System.String

ContentTemplate

To get or set value for ContentTemplate.

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

Created

Event triggers when the dialog is created.

Declaration
[HtmlAttributeName("created")]
public string Created { get; set; }
Property Value
Type Description
System.String

CssClass

Specifies the CSS class name that can be appended with root element of the dialog. One or more custom CSS classes can be added to a dialog.

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

Destroyed

Event triggers when the dialog is destroyed.

Declaration
[HtmlAttributeName("destroyed")]
public string Destroyed { get; set; }
Property Value
Type Description
System.String

Drag

Event triggers when the user drags the dialog.

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

DragStart

Event triggers when the user begins dragging the dialog.

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

DragStop

Event triggers when the user stop dragging the dialog.

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

EnableHtmlSanitizer

Defines whether to allow the cross-scripting site or not.

Declaration
[HtmlAttributeName("enableHtmlSanitizer")]
public bool EnableHtmlSanitizer { get; set; }
Property Value
Type Description
System.Boolean

EnablePersistence

Enable or disable persisting component's state between page reloads.

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

EnableResize

Specifies the value whether the dialog component can be resized by the end-user. If enableResize is true, the dialog component creates grip to resize it diagonal direction.

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

EnableRtl

Enable or disable rendering component in right to left direction.

Declaration
[HtmlAttributeName("enableRtl")]
public bool EnableRtl { get; set; }
Property Value
Type Description
System.Boolean

FooterTemplate

Specifies the template value that can be displayed with dialog's footer area. This is optional property and can be used only when the footer is occupied with information or custom components. By default, the footer is configured with action buttons. If footer template is configured to dialog, the action buttons property will be disabled.

Declaration
[HtmlAttributeName("footerTemplate")]
public string FooterTemplate { get; set; }
Property Value
Type Description
System.String

Header

Specifies the value that can be displayed in the dialog's title area that can be configured with plain text or HTML elements. This is optional property and the dialog can be displayed without header, if the header property is null.

Declaration
[HtmlAttributeName("header")]
public string Header { get; set; }
Property Value
Type Description
System.String

Height

Specifies the height of the dialog component.

Declaration
[HtmlAttributeName("height")]
public string Height { get; set; }
Property Value
Type Description
System.String

HtmlAttributes

Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.

Declaration
[HtmlAttributeName("htmlAttributes")]
public object HtmlAttributes { get; set; }
Property Value
Type Description
System.Object

IsFor

Declaration
protected override bool IsFor { get; }
Property Value
Type Description
System.Boolean
Overrides

IsModal

Specifies the Boolean value whether the dialog can be displayed as modal or non-modal. Modal: It creates overlay that disable interaction with the parent application and user should respond with modal before continuing with other applications. Modeless: It does not prevent user interaction with parent application.

Declaration
[HtmlAttributeName("isModal")]
public bool IsModal { get; set; }
Property Value
Type Description
System.Boolean

Locale

Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

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

MinHeight

Specify the min-height of the dialog component.

Declaration
[HtmlAttributeName("minHeight")]
public string MinHeight { get; set; }
Property Value
Type Description
System.String

NameSpace

Declaration
protected override string NameSpace { get; }
Property Value
Type Description
System.String
Overrides

Open

Event triggers when a dialog is opened.

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

OverlayClick

Event triggers when the overlay of dialog is clicked.

Declaration
[HtmlAttributeName("overlayClick")]
public string OverlayClick { get; set; }
Property Value
Type Description
System.String

Position

Specifies the value where the dialog can be positioned within the document or target. The position can be represented with pre-configured positions or specific X and Y values. X value: left, center, right, or offset value. Y value: top, center, bottom, or offset value.

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

ResizeStart

Event triggers when the user begins to resize a dialog.

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

ResizeStop

Event triggers when the user stop to resize a dialog.

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

Resizing

Event triggers when the user resize the dialog.

Declaration
[HtmlAttributeName("resizing")]
public string Resizing { get; set; }
Property Value
Type Description
System.String

ShowCloseIcon

Specifies the value that represents whether the close icon is shown in the dialog component.

Declaration
[HtmlAttributeName("showCloseIcon")]
public bool ShowCloseIcon { get; set; }
Property Value
Type Description
System.Boolean

TagName

Declaration
protected override string TagName { get; }
Property Value
Type Description
System.String
Overrides

Target

Specifies the target element in which to display the dialog. The default value is null, which refers the document.body element.

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

Visible

Specifies the value that represents whether the dialog component is visible.

Declaration
[HtmlAttributeName("visible")]
public bool Visible { get; set; }
Property Value
Type Description
System.Boolean

Width

Specifies the width of the dialog.

Declaration
[HtmlAttributeName("width")]
public string Width { get; set; }
Property Value
Type Description
System.String

ZIndex

Specifies the z-order for rendering that determines whether the dialog is displayed in front or behind of another component.

Declaration
[HtmlAttributeName("zIndex")]
public double ZIndex { get; set; }
Property Value
Type Description
System.Double