Class KanbanColumn

Represents a Kanban column, providing functionality for property limits, column titles, item grouping, and card drag-and-drop operations.

Inheritance
System.Object
KanbanColumn
Implements
System.ComponentModel.INotifyPropertyChanged
Namespace: Syncfusion.UI.Xaml.Kanban
Assembly: Syncfusion.SfKanban.WPF.dll
Syntax
public class KanbanColumn : ItemsControl, INotifyPropertyChanged

Constructors

KanbanColumn()

Initializes a new instance of the KanbanColumn class.

Declaration
public KanbanColumn()

Fields

AllowDragProperty

Using a DependencyProperty as the backing store for AllowDrag. This enables animation, styling, binding, etc...

Declaration
public static readonly DependencyProperty AllowDragProperty
Field Value
Type
System.Windows.DependencyProperty

CardsProperty

Using a DependencyProperty as the backing store for Cards. This enables animation, styling, binding, etc...

Declaration
public static readonly DependencyProperty CardsProperty
Field Value
Type
System.Windows.DependencyProperty

CategoriesProperty

Using a DependencyProperty as the backing store for Categories. This enables animation, styling, binding, etc...

Declaration
public static readonly DependencyProperty CategoriesProperty
Field Value
Type
System.Windows.DependencyProperty

ErrorBarSettingsProperty

Using a DependencyProperty as the backing store for WIPLimit. This enables animation, styling, binding, etc...

Declaration
public static readonly DependencyProperty ErrorBarSettingsProperty
Field Value
Type
System.Windows.DependencyProperty

IsExpandedProperty

Using a DependencyProperty as the backing store for IsExpanded. This enables animation, styling, binding, etc...

Declaration
public static readonly DependencyProperty IsExpandedProperty
Field Value
Type
System.Windows.DependencyProperty

MaximumLimitProperty

Using a DependencyProperty as the backing store for MaximumLimit. This enables animation, styling, binding, etc...

Declaration
public static readonly DependencyProperty MaximumLimitProperty
Field Value
Type
System.Windows.DependencyProperty

MinimumLimitProperty

Using a DependencyProperty as the backing store for MinimumLimit. This enables animation, styling, binding, etc...

Declaration
public static readonly DependencyProperty MinimumLimitProperty
Field Value
Type
System.Windows.DependencyProperty

TitleProperty

Using a DependencyProperty as the backing store for Title. This enables animation, styling, binding, etc...

Declaration
public static readonly DependencyProperty TitleProperty
Field Value
Type
System.Windows.DependencyProperty

Properties

AllowDrag

Gets or sets a value indicating whether items can be dragged within or out of this KanbanColumn.

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

The default value of AllowDrag is true.
Remarks

Setting this property to true enables drag operations for the column, allowing cards to be moved within the column or to other columns. This is useful for managing tasks and workflow in a Kanban board.

See Also

Cards

Declaration
public KanbanCardCollection Cards { get; set; }
Property Value
Type
KanbanCardCollection

Categories

Gets or sets a string that specifies the fields used for grouping in KanbanColumn.

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

The default value of Categories is System.String.Empty.
Remarks

This property allows you to define which categories or fields will be used for data grouping, enabling effective categorization within the Kanban model.

See Also

ErrorBarSettings

Gets or sets ErrorBarSettings which used to set minimum and maximum validation color for KanbanColumn.

Declaration
public ErrorBarSettings ErrorBarSettings { get; set; }
Property Value
Type
ErrorBarSettings

IsExpanded

Gets or sets a value indicating whether the KanbanColumn is in an expanded or collapsed state.

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

The default value of IsExpanded is true.
Remarks

When set, this property determines the visibility and layout of the column content based on its state. Expanding the column shows all its cards, while collapsing hides them, providing a more compact view.

See Also

Items

Gets a collection of KanbanCardItem.

Declaration
public KanbanCardCollection Items { get; }
Property Value
Type
KanbanCardCollection

MaximumLimit

Gets or sets a value that indicates maximum validation limit using validation color.

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

MinimumLimit

Gets or sets a value that indicates minimum validation limit using validation color.

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

Tags

Gets or sets a ColumnTag which used to customize header properties like Header, Minimum, Maximum, IsExpanded.

Declaration
public ColumnTag Tags { get; set; }
Property Value
Type
ColumnTag

Title

Gets or sets a object that indicates header for KanbanColumn.

Declaration
public object Title { get; set; }
Property Value
Type
System.Object

ValidationColor

Gets a brush that specifies the color of the error bar for the KanbanColumn.

Declaration
public Brush ValidationColor { get; }
Property Value
Type Description
System.Windows.Media.Brush

The default value of ValidationColor is System.Windows.Media.Colors.Gray.
Remarks

This property allows customization of the error bar's appearance by specifying a System.Windows.Media.Brush. It helps in visually indicating validation states within the Kanban column. Based on the values of MinimumLimit, MaximumLimit, MinValidationColor, and MaxValidationColor, this property value will be set for the specific column.

Methods

GetContainerForItemOverride()

Provides a container for each item in the KanbanColumn.

Declaration
protected override DependencyObject GetContainerForItemOverride()
Returns
Type Description
System.Windows.DependencyObject

The new instance of KanbanCardItem.

IsItemItsOwnContainerOverride(Object)

Method to check whether the item is kanban card item or not.

Declaration
protected override bool IsItemItsOwnContainerOverride(object item)
Parameters
Type Name Description
System.Object item

The item to check.
Returns
Type Description
System.Boolean

True if the item is a KanbanCardItem; otherwise, false.

Events

PropertyChanged

Occurs when a property value changes.

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type
System.ComponentModel.PropertyChangedEventHandler

Implements

System.ComponentModel.INotifyPropertyChanged