menu

ASP.NET MVC - EJ2

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class Dialog - ASP.NETMVC-EJ2 API Reference | Syncfusion

    Show / Hide Table of Contents

    Class Dialog

    Inheritance
    System.Object
    Syncfusion.EJ2.EJTagHelper
    Dialog
    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
    public bool AllowDragging { get; set; }
    Property Value
    Type Description
    System.Boolean

    The default value is false

    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
    public DialogAnimationSettings AnimationSettings { get; set; }
    Property Value
    Type Description
    DialogAnimationSettings

    The default value is null

    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
    public string BeforeClose { get; set; }
    Property Value
    Type Description
    System.String

    The default value is null

    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
    public string BeforeOpen { get; set; }
    Property Value
    Type Description
    System.String

    The default value is null

    BeforeSanitizeHtml

    Event triggers before sanitize the value.

    Declaration
    public string BeforeSanitizeHtml { get; set; }
    Property Value
    Type Description
    System.String

    The default value is null

    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
    public List<DialogDialogButton> Buttons { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<DialogDialogButton>

    The default value is null

    Close

    Event triggers after the dialog has been closed.

    Declaration
    public string Close { get; set; }
    Property Value
    Type Description
    System.String

    The default value is null

    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
    public bool CloseOnEscape { get; set; }
    Property Value
    Type Description
    System.Boolean

    The default value is true

    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
    public string Content { get; set; }
    Property Value
    Type Description
    System.String

    The default value is ""

    ContentTemplate

    To get or set value for ContentTemplate.

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

    Created

    Event triggers when the dialog is created.

    Declaration
    public string Created { get; set; }
    Property Value
    Type Description
    System.String

    The default value is null

    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
    public string CssClass { get; set; }
    Property Value
    Type Description
    System.String

    The default value is ""

    Destroyed

    Event triggers when the dialog is destroyed.

    Declaration
    public string Destroyed { get; set; }
    Property Value
    Type Description
    System.String

    The default value is null

    Drag

    Event triggers when the user drags the dialog.

    Declaration
    public string Drag { get; set; }
    Property Value
    Type Description
    System.String

    The default value is null

    DragStart

    Event triggers when the user begins dragging the dialog.

    Declaration
    public string DragStart { get; set; }
    Property Value
    Type Description
    System.String

    The default value is null

    DragStop

    Event triggers when the user stop dragging the dialog.

    Declaration
    public string DragStop { get; set; }
    Property Value
    Type Description
    System.String

    The default value is null

    EnableHtmlSanitizer

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

    Declaration
    public bool EnableHtmlSanitizer { get; set; }
    Property Value
    Type Description
    System.Boolean

    The default value is true

    EnablePersistence

    Enables or disables the persistence of the dialog's dimensions and position state between page reloads.

    Declaration
    public bool EnablePersistence { get; set; }
    Property Value
    Type Description
    System.Boolean

    The default value is false

    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
    public bool EnableResize { get; set; }
    Property Value
    Type Description
    System.Boolean

    The default value is false

    EnableRtl

    Enable or disable rendering component in right to left direction.

    Declaration
    public bool EnableRtl { get; set; }
    Property Value
    Type Description
    System.Boolean

    The default value is false

    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
    public string FooterTemplate { get; set; }
    Property Value
    Type Description
    System.String

    The default value is ""

    Header

    Declaration
    public string Header { get; set; }
    Property Value
    Type
    System.String

    Height

    Specifies the height of the dialog component.

    Declaration
    public string Height { get; set; }
    Property Value
    Type Description
    System.String

    The default value is "auto"

    HtmlAttributes

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

    Declaration
    public object HtmlAttributes { get; set; }
    Property Value
    Type
    System.Object

    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
    public bool IsModal { get; set; }
    Property Value
    Type Description
    System.Boolean

    The default value is false

    Locale

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

    Declaration
    public string Locale { get; set; }
    Property Value
    Type Description
    System.String

    The default value is ""

    MinHeight

    Specify the min-height of the dialog component.

    Declaration
    public string MinHeight { get; set; }
    Property Value
    Type Description
    System.String

    The default value is ""

    Open

    Event triggers when a dialog is opened.

    Declaration
    public string Open { get; set; }
    Property Value
    Type Description
    System.String

    The default value is null

    OverlayClick

    Event triggers when the overlay of dialog is clicked.

    Declaration
    public string OverlayClick { get; set; }
    Property Value
    Type Description
    System.String

    The default value is null

    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
    public DialogPositionData Position { get; set; }
    Property Value
    Type Description
    DialogPositionData

    The default value is null

    ResizeHandles

    Specifies the resize handles direction in the dialog component that can be resized by the end-user.

    Declaration
    public object ResizeHandles { get; set; }
    Property Value
    Type Description
    System.Object

    The default value is null

    ResizeStart

    Event triggers when the user begins to resize a dialog.

    Declaration
    public string ResizeStart { get; set; }
    Property Value
    Type Description
    System.String

    The default value is null

    ResizeStop

    Event triggers when the user stop to resize a dialog.

    Declaration
    public string ResizeStop { get; set; }
    Property Value
    Type Description
    System.String

    The default value is null

    Resizing

    Event triggers when the user resize the dialog.

    Declaration
    public string Resizing { get; set; }
    Property Value
    Type Description
    System.String

    The default value is null

    ShowCloseIcon

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

    Declaration
    public bool ShowCloseIcon { get; set; }
    Property Value
    Type Description
    System.Boolean

    The default value is false

    Target

    Declaration
    public string Target { get; set; }
    Property Value
    Type
    System.String

    Visible

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

    Declaration
    public bool Visible { get; set; }
    Property Value
    Type Description
    System.Boolean

    The default value is true

    Width

    Specifies the width of the dialog.

    Declaration
    public string Width { get; set; }
    Property Value
    Type Description
    System.String

    The default value is "100%"

    ZIndex

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

    Declaration
    public double ZIndex { get; set; }
    Property Value
    Type Description
    System.Double

    The default value is 1000

    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved