menu

Blazor

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class DialogSettings - Blazor API Reference | Syncfusion

    Show / Hide Table of Contents

    Class DialogSettings

    Defines model for Dialog.

    Inheritance
    System.Object
    DialogSettings
    Namespace: Syncfusion.Blazor.Grids
    Assembly: Syncfusion.Blazor.dll
    Syntax
    public class DialogSettings : Object

    Constructors

    DialogSettings()

    Declaration
    public DialogSettings()

    Properties

    AllowDragging

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

    Declaration
    public Nullable<bool> AllowDragging { get; set; }
    Property Value
    Type
    System.Nullable<System.Boolean>

    AnimationDelay

    Specifies the delay in milliseconds to start the animation.

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

    AnimationDuration

    Specifies the duration in milliseconds that the animation takes to open or close the dialog.

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

    AnimationEffect

    Specifies the animation name that should be applied on while opening and closing the dialog. If the user sets Fade animation, the dialog will open with the FadeIn effect and close with the FadeOut effect. The following are the list of animation effects available to configure to the dialog:

    1. Fade
    2. FadeZoom
    3. FlipLeftDown
    4. FlipLeftUp
    5. FlipRightDown
    6. FlipRightUp
    7. FlipXDown
    8. FlipXUp
    9. FlipYLeft
    10. FlipYRight
    11. SlideBottom
    12. SlideLeft
    13. SlideRight
    14. SlideTop
    15. Zoom
    16. None.
    Declaration
    public Nullable<DialogEffect> AnimationEffect { get; set; }
    Property Value
    Type
    System.Nullable<DialogEffect>

    CloseOnEscape

    Specifies the Boolean value whether the dialog can be closed on pressing the escape (ESC) key that is used to control the dialog's closing behavior.

    Declaration
    public Nullable<bool> CloseOnEscape { get; set; }
    Property Value
    Type
    System.Nullable<System.Boolean>

    CssClass

    Specifies the CSS class name that can be appended with the 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
    System.String

    EnableResize

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

    Declaration
    public Nullable<bool> EnableResize { get; set; }
    Property Value
    Type
    System.Nullable<System.Boolean>

    Height

    Specifies the height of the Dialog.

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

    MinHeight

    Specifies the minheight of the Dialog.

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

    ShowCloseIcon

    Specifies the value that represents whether the close icon can be shown in the dialog’s title section.

    Declaration
    public Nullable<bool> ShowCloseIcon { get; set; }
    Property Value
    Type
    System.Nullable<System.Boolean>

    Target

    Specifies the target element in which the dialog should be displayed. The default value is null, which refers to the Document.body element.

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

    Width

    Specifies the width of the Dialog.

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

    XValue

    Specifies the offset left value to position the dialog.

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

    YValue

    Specifies the offset top value to position the dialog.

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

    ZIndex

    Gets or sets the z-index value that determines the stack order of the edit dialog displayed by the Grid when using dialog editing mode.

    Declaration
    public int ZIndex { get; set; }
    Property Value
    Type Description
    System.Int32

    Specifies an integer z-index value. The default is 1001. Setting a higher value ensures the add or edit dialog appears above other UI elements with lower z-index values.

    Remarks

    This property is only applicable when the Grid's Mode is set to Dialog.

    A higher ZIndex can help avoid dialog overlap issues with other layered components or third-party UI elements.

    Accessibility: Ensure that modifying the visual stack order does not block important interactive elements or compromise keyboard navigation for users relying on assistive technologies.

    Changing this property at runtime will dynamically affect the dialog's rendered stacking order.

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