menu

Blazor

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

    Show / Hide Table of Contents

    Class KanbanSwimlaneSettings

    Defines the swimlane settings for the Kanban board, including key field, text field, template, drag-and-drop settings, visibility of empty rows, item count display, and more.

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

    Use these settings to configure the appearance and behavior of swimlane sections on the Kanban board, enabling a customized and efficient workflow management experience.

    Constructors

    KanbanSwimlaneSettings()

    Declaration
    public KanbanSwimlaneSettings()

    Properties

    AllowDragAndDrop

    Gets or sets a value indicating whether drag and drop actions are enabled for swimlane cards.

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

    true if drag and drop is enabled; otherwise, false.

    Remarks

    This property controls the ability to rearrange cards between swimlanes via drag and drop.

    ChildContent

    Gets or sets the child content within the swimlane settings.

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

    A Microsoft.AspNetCore.Components.RenderFragment containing custom content to render in the swimlane section.

    Remarks

    This property can be used to include additional elements or decorations within the swimlane settings.

    EnableFrozenRows

    Gets or sets a value indicating whether to freeze swimlane rows.

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

    true if swimlane rows are frozen; otherwise, false.

    Remarks

    This feature locks swimlane rows in place, enhancing the navigation and handling of items.

    KeyField

    Gets or sets the key field used for swimlane identification.

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

    A System.String that represents the identifying key for each swimlane.

    Remarks

    This property determines which data field is used to uniquely identify and categorize each swimlane.

    ShowEmptyRow

    Gets or sets a value indicating whether to show or hide empty swimlanes.

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

    true if empty swimlanes are visible; otherwise, false.

    Remarks

    By setting this property, users can control the visibility of swimlanes that have no content.

    ShowItemCount

    Gets or sets a value indicating whether the item count is displayed in the swimlanes.

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

    true if the item count is displayed; otherwise, false. The default is true.

    Remarks

    This property allows displaying the number of cards in each swimlane, assisting in resource management.

    SortDirection

    Gets or sets the direction for sorting swimlane resources.

    Declaration
    public SortDirection SortDirection { get; set; }
    Property Value
    Type Description
    SortDirection

    A SortDirection value indicating the sort order, either Ascending or Descending.

    Remarks

    Set this property to define the sort order of swimlane resources for better organization.

    Template

    Gets or sets the template for swimlane rows.

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

    A Microsoft.AspNetCore.Components.RenderFragment<> that defines a custom layout for swimlane rows.

    Remarks

    Use this property to customize the appearance and structure of swimlane rows within the Kanban board.

    TextField

    Gets or sets the text field displayed in the swimlane header.

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

    A System.String representing the text shown above swimlane sections.

    Remarks

    This property sets the header text for the swimlanes, providing context for their content.

    Methods

    BuildRenderTree(RenderTreeBuilder)

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

    OnAfterRenderAsync(Boolean)

    Method invoked after each time the component has been rendered.

    Declaration
    protected override Task OnAfterRenderAsync(bool firstRender)
    Parameters
    Type Name Description
    System.Boolean firstRender

    Set to true if this is the first time OnAfterRender(Boolean) has been invoked.

    Returns
    Type Description
    System.Threading.Tasks.Task

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

    Overrides
    SfDataBoundComponent.OnAfterRenderAsync(Boolean)

    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()

    OnParametersSetAsync()

    Method invoked when the component has received parameters from its parent.

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

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

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