menu

Blazor

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

    Show / Hide Table of Contents

    Class KanbanDialogSettings

    Defines the Kanban board dialog settings and their properties such as allow dragging, animation, template, close on escape, css class, enable resize, height, enable Modal, minimum height, position, target, show close icon, width, fields and z-index.

    Inheritance
    System.Object
    SfBaseComponent
    SfDataBoundComponent
    KanbanDialogSettings
    Inherited Members
    SfBaseComponent.Dispose()
    SfBaseComponent.Dispose(Boolean)
    SfBaseComponent.OnObservableChange(String, Object, Boolean, NotifyCollectionChangedEventArgs)
    SfDataBoundComponent.DataManager
    SfDataBoundComponent.MainParent
    SfDataBoundComponent.OnAfterRenderAsync(Boolean)
    SfDataBoundComponent.OnParametersSetAsync()
    SfDataBoundComponent.SetDataManager<T>(Object)
    Namespace: Syncfusion.Blazor.Kanban
    Assembly: Syncfusion.Blazor.dll
    Syntax
    public class KanbanDialogSettings : SfDataBoundComponent
    Remarks

    The KanbanDialogSettings class allows configuration of dialog properties such as size, position, modal behavior, and more, enhancing user interaction within the Kanban component.

    Constructors

    KanbanDialogSettings()

    Declaration
    public KanbanDialogSettings()

    Properties

    AllowDragging

    Specifies whether the dialog component can be moved (dragged) by the end-user.

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

    true if the dialog can be dragged; otherwise, false.

    Remarks

    Enabling dragging allows users to reposition the dialog by selecting and moving its header.

    AnimationSettings

    Specifies the animation settings of the dialog component.

    Declaration
    public DialogAnimationSettings AnimationSettings { get; set; }
    Property Value
    Type Description
    DialogAnimationSettings

    Contains animation effects applied to the open and close actions of the dialog.

    Remarks

    These settings are used to provide interactive effects when showing or hiding the dialog.

    ChildContent

    Defines the child content for the Kanban dialog.

    Declaration
    public RenderFragment ChildContent { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.RenderFragment

    Represents the content that will be rendered inside the dialog.

    Remarks

    Used to embed custom content within the dialog's structure.

    CloseOnEscape

    Indicates whether the dialog can be closed using the escape key.

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

    true if closing with the escape key is allowed; otherwise, false.

    Remarks

    This feature allows users to dismiss dialogs easily through keyboard shortcuts.

    CssClass

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

    A string representing additional CSS classes for styling the dialog.

    Remarks

    Use this property to apply additional styling by assigning custom CSS classes to the dialog component. This facilitates UI customization, allowing developers to implement unique designs and themes matching the application's overall aesthetic.

    EnableResize

    Indicates whether the dialog component can be resized by the end-user.

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

    true if resizing is enabled; otherwise, false.

    Remarks

    When enabled, a grip is provided in the dialog's corner for users to resize it.

    Height

    Specifies the height of the dialog component.

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

    A string indicating the height dimension of the dialog.

    Remarks

    Acceptable values include percentages and pixel values (e.g., "100px", "50%").

    IsModal

    Indicates whether the dialog is displayed as a modal or modeless window.

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

    true if the dialog is modal, meaning it creates an overlay preventing interaction with the parent application until it is dismissed; false if it is modeless, allowing continued interaction with the parent application.

    Remarks

    Modal dialogs create an overlay that demands interaction with the dialog itself before the user can return to the main application. This is typically used for alert messages or confirmations that require user attention. Modeless dialogs do not block the main application, letting users engage with other interfaces while the dialog remains open.

    KanbanDialogFields

    Defines the fields within the Kanban dialog and their properties such as key, text, and type.

    Declaration
    public List<KanbanDialogSettingsField> KanbanDialogFields { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<KanbanDialogSettingsField>

    A list of KanbanDialogSettingsField that configures dialog field attributes.

    Remarks

    This collection allows for extensive customization of information presented in the dialog.

    MinHeight

    Specifies the minimum height of the dialog component.

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

    A string indicating the minimum height dimension of the dialog.

    Remarks

    This property ensures that the dialog does not shrink beyond a specific height, maintaining usability.

    Position

    Specifies where the dialog is positioned within the document or its target element.

    Declaration
    public DialogPositionData Position { get; set; }
    Property Value
    Type Description
    DialogPositionData

    The DialogPositionData object that defines position specifics.

    Remarks

    Positions can be set using predefined alignments or by specifying precise X and Y coordinates.

    ShowCloseIcon

    Indicates whether the close icon is displayed in the dialog component.

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

    true if the close icon is visible; otherwise, false.

    Remarks

    A close icon offers an alternative method for users to dismiss the dialog.

    Target

    Defines the target element where the dialog will be displayed.

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

    A string representing the CSS selector or ID of the target element for the dialog. The default is null, which indicates the dialog will be shown in the document.body.

    Remarks

    If Target is not set (null), the dialog will default to being displayed within the document.body element. You can specify a CSS selector or an element ID to control where the dialog appears.

    Template

    Defines the template used for the dialog's visual structure.

    Declaration
    public RenderFragment<object> Template { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.RenderFragment<System.Object>

    A render fragment that provides a customized dialog layout.

    Remarks

    This templating technique enables versatile design control within application-specific dialogs.

    Width

    Specifies the width of the dialog.

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

    A string representing the width dimension of the dialog.

    Remarks

    Similar to height, width can also be defined using relative or absolute values.

    ZIndex

    Sets the z-index to control the stacking order of the dialog relative to other elements on the page.

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

    An integer designating the z-index value for the dialog. The default is 1000, typically sufficient for ensuring the dialog is displayed above most standard elements.

    Remarks

    The z-index influences which components appear in front of or behind others. Adjust this value to manage the visibility and overlap of the dialog with surrounding elements. Increasing the z-index moves the dialog to the foreground.

    Methods

    BuildRenderTree(RenderTreeBuilder)

    Declaration
    protected override void BuildRenderTree(RenderTreeBuilder __builder)
    Parameters
    Type Name Description
    Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder __builder

    OnInitializedAsync()

    Method invoked when the component is ready to start.

    Declaration
    protected override Task OnInitializedAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task

    A System.Threading.Tasks.Task representing any asynchronous operation.

    Overrides
    SfDataBoundComponent.OnInitializedAsync()
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved