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

object

ComponentBase

OwningComponentBase

SfOwningComponentBase

SfBaseComponent

SfDataBoundComponent

KanbanCardSettings

Implements

IComponent

IHandleEvent

IHandleAfterRender

IDisposable

Inherited Members

ComponentBase.Assets

ComponentBase.AssignedRenderMode

ComponentBase.DispatchExceptionAsync(Exception)

ComponentBase.InvokeAsync(Action)

ComponentBase.InvokeAsync(Func<Task>)

ComponentBase.OnAfterRender(bool)

ComponentBase.OnInitialized()

ComponentBase.OnParametersSet()

ComponentBase.RendererInfo

ComponentBase.SetParametersAsync(ParameterView)

ComponentBase.ShouldRender()

ComponentBase.StateHasChanged()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

OwningComponentBase.IsDisposed

OwningComponentBase.ScopedServices

SfBaseComponent.Dispose()

SfBaseComponent.Dispose(bool)

SfBaseComponent.GetEffectivePlatform()

SfBaseComponent.GetMainComponentPlatform()

SfBaseComponent.IsMainLicenseComponent()

SfBaseComponent.LicenseContext

SfBaseComponent.OnObservableChange(string, object, bool, NotifyCollectionChangedEventArgs)

SfBaseComponent.ValidateLicense()

SfDataBoundComponent.DataManager

SfDataBoundComponent.MainParent

SfDataBoundComponent.OnAfterRenderAsync(bool)

SfDataBoundComponent.OnParametersSetAsync()

SfDataBoundComponent.SetDataManager<T>(object)

Namespace: Syncfusion.Blazor.Kanban

Assembly: Syncfusion.Blazor.dll

Syntax

public class KanbanCardSettings : SfDataBoundComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

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

[Parameter]
public RenderFragment ChildContent { get; set; }

Property Value

Type	Description
RenderFragment	The 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

[Parameter]
public string ContentField { get; set; }

Property Value

Type	Description
string	A 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

[Parameter]
public string FooterCssField { get; set; }

Property Value

Type	Description
string	A 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

[Parameter]
public string GrabberField { get; set; }

Property Value

Type	Description
string	A 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

[Parameter]
public string HeaderField { get; set; }

Property Value

Type	Description
string	A 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

[Parameter]
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

[Parameter]
public bool ShowHeader { get; set; }

Property Value

Type	Description
bool	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

[Parameter]
public string TagsField { get; set; }

Property Value

Type	Description
string	A 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

[Parameter]
public RenderFragment<object> Template { get; set; }

Property Value

Type	Description
RenderFragment<object>	A RenderFragment<TValue> 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
RenderTreeBuilder	__builder

Overrides

ComponentBase.BuildRenderTree(RenderTreeBuilder)

OnInitializedAsync()

Method invoked when the component is ready to start.

Declaration

protected override Task OnInitializedAsync()

Returns

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

Overrides

SfDataBoundComponent.OnInitializedAsync()

Implements

IComponent

IHandleEvent

IHandleAfterRender

IDisposable