Class SfKanban

The Kanban control offers an efficient way to visualize workflows at each stage of completion, aiding in planning and providing a clear view of task progression. It offers various features to effectively monitor task progress throughout the software development lifecycle, allowing users to control task transitions between categories (statuses). The control supports easy task binding through the ItemsSource property and enables grouping tasks using horizontal swimlanes to organize and display related tasks by categories, teams, or other groupings. You can customize the control's appearance using ColumnHeaderTemplate, CardTemplate, CardTemplateSelector, SwimlaneHeaderTemplate, and customizable placeholders. It includes a rich set of built-in functionalities such as data binding, swimlanes, card templating, scrolling, drag-and-drop, WIP validations, responsiveness, various built-in themes, and more.

Inheritance

System.Object

SfKanban

Implements

System.IDisposable

Namespace: Syncfusion.UI.Xaml.Kanban

Assembly: Syncfusion.SfKanban.UWP.dll

Syntax

public class SfKanban : Control, IDisposable

Constructors

SfKanban()

Initializes a new instance of the SfKanban class.

Declaration

public SfKanban()

Fields

ActualColumnsProperty

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

Declaration

public static readonly DependencyProperty ActualColumnsProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

ActualColumnWidthProperty

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

Declaration

public static readonly DependencyProperty ActualColumnWidthProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

AutoGenerateColumnsProperty

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

Declaration

public static readonly DependencyProperty AutoGenerateColumnsProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

CardStyleProperty

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

Declaration

public static readonly DependencyProperty CardStyleProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

CardTappedCommandParameterProperty

Gets or sets a parameter that is sent to the CardTappedCommand.

Declaration

public static readonly DependencyProperty CardTappedCommandParameterProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

CardTappedCommandProperty

Using the DependencyProperty as the backing store for CardTappedCommand. It invokes when an item is tapped. The default value is null.

Declaration

public static readonly DependencyProperty CardTappedCommandProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

CardTemplateProperty

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

Declaration

public static readonly DependencyProperty CardTemplateProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

CardTemplateSelectorProperty

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

Declaration

public static readonly DependencyProperty CardTemplateSelectorProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

ColumnAnimationDurationProperty

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

Declaration

public static readonly DependencyProperty ColumnAnimationDurationProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

ColumnHeaderTemplateProperty

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

Declaration

public static readonly DependencyProperty ColumnHeaderTemplateProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

ColumnMappingPathProperty

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

Declaration

public static readonly DependencyProperty ColumnMappingPathProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

ColumnsProperty

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

Declaration

public static readonly DependencyProperty ColumnsProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

ColumnWidthProperty

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

Declaration

public static readonly DependencyProperty ColumnWidthProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

HeaderAlignmentProperty

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

Declaration

public static readonly DependencyProperty HeaderAlignmentProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

HeaderProperty

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

Declaration

public static readonly DependencyProperty HeaderProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

IndicatorColorPaletteProperty

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

Declaration

public static readonly DependencyProperty IndicatorColorPaletteProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

ItemsSourceProperty

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

Declaration

public static readonly DependencyProperty ItemsSourceProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

MaxColumnWidthProperty

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

Declaration

public static readonly DependencyProperty MaxColumnWidthProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

MinColumnWidthProperty

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

Declaration

public static readonly DependencyProperty MinColumnWidthProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

PlaceholderStyleProperty

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

Declaration

public static readonly DependencyProperty PlaceholderStyleProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

SwimlaneHeaderTemplateProperty

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

Declaration

public static readonly DependencyProperty SwimlaneHeaderTemplateProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

SwimlaneKeyProperty

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

Declaration

public static readonly DependencyProperty SwimlaneKeyProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

WorkflowsProperty

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

Declaration

public static readonly DependencyProperty WorkflowsProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

Properties

ActualColumns

Gets a collection of actual KanbanColumn.

Declaration

public KanbanColumnsCollection ActualColumns { get; }

Property Value

Type
KanbanColumnsCollection

ActualColumnWidth

Gets the double value which indicates width of individual column.

Declaration

public double ActualColumnWidth { get; }

Property Value

Type
System.Double

AutoGenerateColumns

Gets or sets a value indicating whether columns generation done by automatically or manually.

Declaration

public bool AutoGenerateColumns { get; set; }

Property Value

Type
System.Boolean

CardStyle

Gets or sets a object that used to customize KanbanCardItem.

Declaration

public KanbanCardStyle CardStyle { get; set; }

Property Value

Type
KanbanCardStyle

CardTappedCommand

Gets or sets a command to invoke when the card item is tapped.

Declaration

public ICommand CardTappedCommand { get; set; }

Property Value

Type
System.Windows.Input.ICommand

CardTappedCommandParameter

Gets or sets a parameter to pass to the CardTappedCommand.

Declaration

public object CardTappedCommandParameter { get; set; }

Property Value

Type
System.Object

CardTemplate

Gets or sets a DataTemplate which used to customize card visual.

Declaration

public DataTemplate CardTemplate { get; set; }

Property Value

Type
Windows.UI.Xaml.DataTemplate

CardTemplateSelector

Gets or sets a DataTemplateSelector which used to customize card visual.

Declaration

public DataTemplateSelector CardTemplateSelector { get; set; }

Property Value

Type
Windows.UI.Xaml.Controls.DataTemplateSelector

ColumnAnimationDuration

Gets or sets the animation duration value for KanbanColumn's transition from expand to collapse state and vice versa.

Declaration

public double ColumnAnimationDuration { get; set; }

Property Value

Type
System.Double

ColumnHeaderTemplate

Gets or sets a DataTemplate used to customize KanbanColumn's header.

Declaration

public DataTemplate ColumnHeaderTemplate { get; set; }

Property Value

Type
Windows.UI.Xaml.DataTemplate

ColumnMappingPath

Gets or sets a string which indicates column grouping field.

Declaration

public string ColumnMappingPath { get; set; }

Property Value

Type
System.String

Columns

Gets or sets a collection of KanbanColumn.

Declaration

public KanbanColumnsCollection Columns { get; set; }

Property Value

Type
KanbanColumnsCollection

ColumnWidth

Gets or sets a double value which indicates each KanbanColumn width.

Declaration

public double ColumnWidth { get; set; }

Property Value

Type
System.Double

Header

Gets or sets object which is used to set title of SfKanban.

Declaration

public object Header { get; set; }

Property Value

Type
System.Object

HeaderAlignment

Gets or sets a alignment value which used to align header horizontally.

Declaration

public HorizontalAlignment HeaderAlignment { get; set; }

Property Value

Type
Windows.UI.Xaml.HorizontalAlignment

IndicatorColorPalette

Gets or sets IndicatorColorPalette which is used to set indication color for card.

Declaration

public IndicatorColorPalette IndicatorColorPalette { get; set; }

Property Value

Type
IndicatorColorPalette

ItemsSource

Gets or sets a IEnumerable which indicates source for SfKanban.

Declaration

public IEnumerable ItemsSource { get; set; }

Property Value

Type
System.Collections.IEnumerable

MaxColumnWidth

Gets or sets a double value which indicates each KanbanColumn width maximum value.

Declaration

public double MaxColumnWidth { get; set; }

Property Value

Type
System.Double

MinColumnWidth

Gets or sets a double value which indicates each KanbanColumn width minimum value.

Declaration

public double MinColumnWidth { get; set; }

Property Value

Type
System.Double

PlaceholderStyle

Gets or sets a PlaceholderStyle which helps to customize place holder.

Declaration

public PlaceholderStyle PlaceholderStyle { get; set; }

Property Value

Type
PlaceholderStyle

SwimlaneHeaderTemplate

Gets or sets a DataTemplate used to customize Syncfusion.UI.Xaml.Kanban.Swimlane's header.

Declaration

public DataTemplate SwimlaneHeaderTemplate { get; set; }

Property Value

Type
Windows.UI.Xaml.DataTemplate

SwimlaneKey

Gets or sets the key value of Syncfusion.UI.Xaml.Kanban.SwimlaneRecord.

Declaration

public string SwimlaneKey { get; set; }

Property Value

Type
System.String

Workflows

Gets or sets a workflow collection which contains the dragging work flows.

Declaration

public WorkflowCollection Workflows { get; set; }

Property Value

Type
WorkflowCollection

Methods

Dispose()

Method to dispose the Kanban's instances.

Declaration

public void Dispose()

OnApplyTemplate()

Method to apply the control template and initializes the Kanban control's elements.

Declaration

protected override void OnApplyTemplate()

OnCardDoubleTapped(KanbanDoubleTappedEventArgs)

Called when CardDoubleTapped event occurs.

Declaration

protected virtual void OnCardDoubleTapped(KanbanDoubleTappedEventArgs args)

Parameters

Type	Name	Description
KanbanDoubleTappedEventArgs	args	Contains arguments relevant to card double tapped event.

OnCardDragEnd(KanbanDragEndEventArgs)

Called when DragEnd event occurs.

Declaration

protected virtual void OnCardDragEnd(KanbanDragEndEventArgs args)

Parameters

Type	Name	Description
KanbanDragEndEventArgs	args	Contains arguments relevant to drag end event.

OnCardDragEnter(KanbanDragEnterEventArgs)

Called when DragEnter event occurs.

Declaration

protected virtual void OnCardDragEnter(KanbanDragEnterEventArgs args)

Parameters

Type	Name	Description
KanbanDragEnterEventArgs	args	Contains arguments relevant to drag enter event.

OnCardDragLeave(KanbanDragLeaveEventArgs)

Called when DragLeave event occurs.

Declaration

protected virtual void OnCardDragLeave(KanbanDragLeaveEventArgs args)

Parameters

Type	Name	Description
KanbanDragLeaveEventArgs	args	Contains arguments relevant to drag leave event.

OnCardDragOver(KanbanDragOverEventArgs)

Called when DragOver event occurs.

Declaration

protected virtual void OnCardDragOver(KanbanDragOverEventArgs args)

Parameters

Type	Name	Description
KanbanDragOverEventArgs	args	Contains arguments relevant to drag over event.

OnCardDragStart(KanbanDragStartEventArgs)

Called when DragStart event occurs.

Declaration

protected virtual void OnCardDragStart(KanbanDragStartEventArgs args)

Parameters

Type	Name	Description
KanbanDragStartEventArgs	args	Contains arguments relevant to drag start event.

OnCardTapped(KanbanTappedEventArgs)

Called when CardTapped event occurs.

Declaration

protected virtual void OnCardTapped(KanbanTappedEventArgs args)

Parameters

Type	Name	Description
KanbanTappedEventArgs	args	Contains arguments relevant to card tapped event.

OnColumnGenerated(KanbanColumnGeneratedEventArgs)

Called when ColumnGenerated event occurs.

Declaration

protected virtual void OnColumnGenerated(KanbanColumnGeneratedEventArgs args)

Parameters

Type	Name	Description
KanbanColumnGeneratedEventArgs	args	Contains arguments relevant to column generated event.

OnColumnsGenerated(KanbanColumnsGeneratedEventArgs)

Called when ColumnsGenerated event occurs.

Declaration

protected virtual void OnColumnsGenerated(KanbanColumnsGeneratedEventArgs args)

Parameters

Type	Name	Description
KanbanColumnsGeneratedEventArgs	args	Contains arguments relevant to columns generated event.

Events

CardDoubleTapped

Occurs when double tapped on the card.

Declaration

public event EventHandler<KanbanDoubleTappedEventArgs> CardDoubleTapped

Event Type

Type
System.EventHandler<KanbanDoubleTappedEventArgs>

CardDragEnd

Occurs when the dragging card is released.

Declaration

public event EventHandler<KanbanDragEndEventArgs> CardDragEnd

Event Type

Type
System.EventHandler<KanbanDragEndEventArgs>

CardDragEnter

Occurs when dragging enter into another column.

Declaration

public event EventHandler<KanbanDragEnterEventArgs> CardDragEnter

Event Type

Type
System.EventHandler<KanbanDragEnterEventArgs>

CardDragLeave

Occurs when leaving the dragging card from one column.

Declaration

public event EventHandler<KanbanDragLeaveEventArgs> CardDragLeave

Event Type

Type
System.EventHandler<KanbanDragLeaveEventArgs>

CardDragOver

Occurs when card dragging over to the KanbanColumn.

Declaration

public event EventHandler<KanbanDragOverEventArgs> CardDragOver

Event Type

Type
System.EventHandler<KanbanDragOverEventArgs>

CardDragStart

Occurs when card drag started in KanbanColumn.

Declaration

public event EventHandler<KanbanDragStartEventArgs> CardDragStart

Event Type

Type
System.EventHandler<KanbanDragStartEventArgs>

CardTapped

Occurs when tapped on the card.

Declaration

public event EventHandler<KanbanTappedEventArgs> CardTapped

Event Type

Type
System.EventHandler<KanbanTappedEventArgs>

ColumnGenerated

Occurred for each column generation completed.

Declaration

public event EventHandler<KanbanColumnGeneratedEventArgs> ColumnGenerated

Event Type

Type
System.EventHandler<KanbanColumnGeneratedEventArgs>

ColumnsGenerated

Occurs when all the columns are generated. Header text can be customized through this event.

Declaration

public event EventHandler<KanbanColumnsGeneratedEventArgs> ColumnsGenerated

Event Type

Type
System.EventHandler<KanbanColumnsGeneratedEventArgs>

Implements

System.IDisposable

Extension Methods

DateTimeExtension.ToDateTime(Object)