Class KanbanColumn

Defines the Kanban board column and their properties such as header text, key field, template, allow toggle, expand or collapse state, min or max count, and show or hide item count.

Inheritance

System.Object

SfBaseComponent

SfDataBoundComponent

KanbanColumn

Inherited Members

SfBaseComponent.Dispose()

SfBaseComponent.Dispose(Boolean)

SfBaseComponent.GetEffectivePlatform()

SfBaseComponent.GetMainComponentPlatform()

SfBaseComponent.IsMainLicenseComponent()

SfBaseComponent.LicenseContext

SfBaseComponent.OnObservableChange(String, Object, Boolean, NotifyCollectionChangedEventArgs)

SfBaseComponent.ValidateLicense()

SfDataBoundComponent.DataManager

SfDataBoundComponent.MainParent

SfDataBoundComponent.OnAfterRenderAsync(Boolean)

SfDataBoundComponent.SetDataManager<T>(Object)

Namespace: Syncfusion.Blazor.Kanban

Assembly: Syncfusion.Blazor.dll

Syntax

public class KanbanColumn : SfDataBoundComponent

Remarks

The KanbanColumn class provides options to manage the state and behavior of Kanban columns within a Blazor application.

Constructors

KanbanColumn()

Declaration

public KanbanColumn()

Properties

AllowAdding

Gets or sets a value indicating whether an add button is enabled in the column.

Declaration

public bool AllowAdding { get; set; }

Property Value

Type	Description
System.Boolean	true if adding cards is permitted; otherwise, false.

Remarks

When enabled, this allows users to add new cards directly into the column.

AllowDrag

Gets or sets a value indicating whether items in the column can be dragged.

Declaration

public bool AllowDrag { get; set; }

Property Value

Type	Description
System.Boolean	true if dragging items is permissible; otherwise, false.

Remarks

This is utilized to allow or restrict users from dragging items out of the column to other columns or lists.

AllowDrop

Gets or sets a value indicating whether items can be dropped into the column.

Declaration

public bool AllowDrop { get; set; }

Property Value

Type	Description
System.Boolean	true if dropping items into the column is allowed; otherwise, false.

Remarks

This feature enables drag-and-drop functionality to add cards from other columns or lists.

AllowToggle

Gets or sets a value indicating whether the column toggle feature is enabled.

Declaration

public bool AllowToggle { get; set; }

Property Value

Type	Description
System.Boolean	true if the column can be toggled; otherwise, false.

Remarks

When enabled, users can expand or collapse the column in the Kanban board.

ChildContent

Defines the child content of this Kanban Column.

Declaration

public RenderFragment ChildContent { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment	The rendered content inside the column.

Remarks

This is often used to customize the content within the Kanban column.

Count

Gets or sets the count of cards within the column.

Declaration

public int Count { get; set; }

Property Value

Type	Description
System.Int32	An integer representing the number of cards in the column.

Remarks

This property is useful for conditional rendering or logic based on the card count.

HeaderText

Gets or sets the header text of the column.

Declaration

public string HeaderText { get; set; }

Property Value

Type	Description
System.String	The string that represents the header title of the column.

Remarks

The header text is displayed at the top of the column to denote the column's purpose or status.

Index

Gets or sets the index order of the column.

Declaration

public int Index { get; set; }

Property Value

Type	Description
System.Int32	An integer representing the order of the column.

Remarks

This determines the column's position within the Kanban board. Indexes are useful when columns need to be reordered by logic.

IsExpanded

Gets or sets a value indicating whether the column is expanded by default.

Declaration

public bool IsExpanded { get; set; }

Property Value

Type	Description
System.Boolean	true if the column is expanded; otherwise, false.

Remarks

This property allows the column to be initially displayed in a collapsed or expanded state depending on the user's preference.

KeyField

Gets or sets the key field(s) of the column.

Declaration

public List<string> KeyField { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.String>	A list of strings representing the key(s) that categorize items in this column.

Remarks

These keys are used for filtering and organizing items under the appropriate column.

MaxCount

Gets or sets the maximum card count allowed in the column.

Declaration

public Nullable<int> MaxCount { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>	The maximum number of cards that can be added to this column.

Remarks

This helps to impose a limit on the number of items that can be placed within a column, if applicable.

MinCount

Gets or sets the minimum card count that must be maintained in the column.

Declaration

public Nullable<int> MinCount { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>	The minimum number of cards that should be available in this column.

Remarks

This feature ensures that the column meets the specified criteria concerning the minimum card count.

ShowItemCount

Gets or sets a value indicating whether the card count should be displayed in the column.

Declaration

public bool ShowItemCount { get; set; }

Property Value

Type	Description
System.Boolean	true to show card count; otherwise, false.

Remarks

This property aids in displaying the count of cards in a column, often to analyze workflow efficiency.

Template

Gets or sets the template for the column.

Declaration

public RenderFragment<KanbanColumn> Template { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment<KanbanColumn>	A render fragment that defines the custom layout of the column.

Remarks

Using this template, developers can customize the appearance and layout of columns.

TransitionColumns

Gets or sets the transition columns of this column.

Declaration

public List<string> TransitionColumns { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.String>	A list of column names where cards can be moved to or from as part of a transition.

Remarks

Transition columns define the path items can follow across the Kanban board.

Visible

Gets or sets a value indicating whether the column is visible.

Declaration

public bool Visible { get; set; }

Property Value

Type	Description
System.Boolean	true if the column is visible; otherwise, false.

Remarks

This setting can be used to hide columns from view without removing them from the DOM.

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

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