menu

Blazor

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

    Show / Hide Table of Contents

    Class KanbanCardSettings

    Defines the Kanban card settings that include header field, content field, template, visibility of headers, and options for single or multiple selection modes.

    Inheritance
    System.Object
    SfBaseComponent
    SfDataBoundComponent
    KanbanCardSettings
    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 KanbanCardSettings : SfDataBoundComponent
    Remarks

    This class supports detailed customization of how cards are presented and interacted with on a Kanban board, allowing for greater flexibility in task management.

    Constructors

    KanbanCardSettings()

    Declaration
    public KanbanCardSettings()

    Properties

    ChildContent

    Defines the child content of the Kanban card.

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

    The Microsoft.AspNetCore.Components.RenderFragment that represents the child content to be rendered within the card.

    Remarks

    This property allows the embedding of custom content within each card, making it highly adaptable to specific needs.

    ContentField

    Defines the card content text to be displayed.

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

    A System.String specifying the field from the data source that represents the card's text content.

    Remarks

    This field determines what part of the data source is displayed as the main content in each card.

    FooterCssField

    Defines the card icons.

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

    A System.String that provides CSS class definitions for icons associated with the card.

    Remarks

    Icons enhance the card's interface by providing visual cues related to the card's content or status.

    GrabberField

    Defines the card color.

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

    A System.String indicating which field determines the background color of the card.

    Remarks

    Card colors can be used to visually signify status, priority, or any other categorization.

    HeaderField

    Defines the card header text.

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

    A System.String specifying the field from the data source that serves as the card's header.

    Remarks

    Header fields provide titles or identifiers for cards, helping to visually differentiate them on the board.

    SelectionType

    Defines the card selection type, specifying how cards can be selected on the Kanban board.

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

    A SelectionType that indicates the selection mode for cards. It can be:

    • Single - Only one card can be selected at a time.
    • Multiple - Multiple cards can be selected simultaneously.
    • None - No cards can be selected.
    Remarks

    The selection type is crucial for determining user interaction with Kanban cards, influencing how tasks are managed and organized.

    ShowHeader

    Controls the visibility of the card header.

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

    A boolean indicating whether the card header is displayed (true) or hidden (false).

    Remarks

    This property allows for the customization of card presentation by toggling header visibility.

    TagsField

    Defines the card content labels.

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

    A System.String specifying the field that contains tags or labels for each card.

    Remarks

    Tags are useful for categorizing and filtering cards based on specific criteria or attributes.

    Template

    Defines the card template.

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

    A Microsoft.AspNetCore.Components.RenderFragment<> that specifies the rendering template for the card.

    Remarks

    Custom templates provide flexibility to design cards in a unique format suited to the application's needs.

    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