Blazor

Upgrade Guide User Guide Demos Support Forums Download
  • 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
    Syncfusion.Blazor.SfBaseComponent
    SfDataBoundComponent
    KanbanDialogSettings
    Inherited Members
    SfDataBoundComponent.SetDataManager<T>(Object)
    SfDataBoundComponent.OnParametersSetAsync()
    SfDataBoundComponent.OnAfterRenderAsync(Boolean)
    SfDataBoundComponent.DataManager
    SfDataBoundComponent.MainParent
    Namespace: Syncfusion.Blazor.Kanban
    Assembly: Syncfusion.Blazor.dll
    Syntax
    public class KanbanDialogSettings : SfDataBoundComponent

    Constructors

    KanbanDialogSettings()

    Declaration
    public KanbanDialogSettings()

    Properties

    AllowDragging

    Specifies the value that indicates whether the dialog component can be dragged by the end-user or not. 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

    AnimationSettings

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

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

    ChildContent

    Defines the child content

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

    CloseOnEscape

    Specifies the boolean value that indicates whether the dialog can be closed with the escape key ( used to control the dialog's closing behavior) or not.

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

    EnableResize

    Specifies the value that indicates whether the dialog component can be resized by the end-user or not. If enableResize is true, the dialog component creates a grip to resize its diagonal direction.

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

    Height

    Specifies the height of the dialog component.

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

    IsModal

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

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

    KanbanDialogFields

    Defines the Kanban Dialog Settings fields 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>

    MinHeight

    Specifies the min-height of the dialog component.

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

    ShowCloseIcon

    Specifies the value that represents whether the close icon can be shown in the dialog component or not.

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

    Template

    Defines the dialog template

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

    Width

    Specifies the width of the dialog.

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

    ZIndex

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

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

    Methods

    BuildRenderTree(RenderTreeBuilder)

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

    OnInitializedAsync()

    Declaration
    protected override Task OnInitializedAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task
    Overrides
    SfDataBoundComponent.OnInitializedAsync()
    Back to top Generated by DocFX
    Copyright © 2001 - 2021 Syncfusion Inc. All Rights Reserved