WPF

Code Examples Upgrade Guide User Guide Demos Support Forums Download
  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class SfKanban

    Show / Hide Table of Contents

    Class SfKanban

    SfKanban represents to monitor the tasks in progress of the organization.

    Inheritance
    System.Object
    SfKanban
    Implements
    System.IDisposable
    Namespace: Syncfusion.UI.Xaml.Kanban
    Assembly: Syncfusion.SfKanban.WPF.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 Description
    System.Windows.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 Description
    System.Windows.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 Description
    System.Windows.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 Description
    System.Windows.DependencyProperty

    CardTappedCommandParameterProperty

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

    Declaration
    public static readonly DependencyProperty CardTappedCommandParameterProperty
    Field Value
    Type Description
    System.Windows.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 Description
    System.Windows.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 Description
    System.Windows.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 Description
    System.Windows.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 Description
    System.Windows.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 Description
    System.Windows.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 Description
    System.Windows.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 Description
    System.Windows.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 Description
    System.Windows.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 Description
    System.Windows.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 Description
    System.Windows.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 Description
    System.Windows.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 Description
    System.Windows.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 Description
    System.Windows.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 Description
    System.Windows.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 Description
    System.Windows.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 Description
    System.Windows.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 Description
    System.Windows.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 Description
    System.Windows.DependencyProperty

    Properties

    ActualColumns

    Gets a collection of actual KanbanColumn.

    Declaration
    public KanbanColumnsCollection ActualColumns { get; }
    Property Value
    Type Description
    KanbanColumnsCollection

    ActualColumnWidth

    Gets the double value which indicates width of individual column.

    Declaration
    public double ActualColumnWidth { get; }
    Property Value
    Type Description
    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 Description
    System.Boolean

    CardStyle

    Gets or sets a object that used to customize KanbanCardItem.

    Declaration
    public KanbanCardStyle CardStyle { get; set; }
    Property Value
    Type Description
    KanbanCardStyle

    CardTappedCommand

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

    Declaration
    public ICommand CardTappedCommand { get; set; }
    Property Value
    Type Description
    System.Windows.Input.ICommand

    CardTappedCommandParameter

    Gets or sets a parameter to pass to the CardTappedCommand.

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

    CardTemplate

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

    Declaration
    public DataTemplate CardTemplate { get; set; }
    Property Value
    Type Description
    System.Windows.DataTemplate

    CardTemplateSelector

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

    Declaration
    public DataTemplateSelector CardTemplateSelector { get; set; }
    Property Value
    Type Description
    System.Windows.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 Description
    System.Double

    ColumnHeaderTemplate

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

    Declaration
    public DataTemplate ColumnHeaderTemplate { get; set; }
    Property Value
    Type Description
    System.Windows.DataTemplate

    ColumnMappingPath

    Gets or sets a string which indicates column grouping field.

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

    Columns

    Gets or sets a collection of KanbanColumn.

    Declaration
    public KanbanColumnsCollection Columns { get; set; }
    Property Value
    Type Description
    KanbanColumnsCollection

    ColumnWidth

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

    Declaration
    public double ColumnWidth { get; set; }
    Property Value
    Type Description
    System.Double

    Header

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

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

    HeaderAlignment

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

    Declaration
    public HorizontalAlignment HeaderAlignment { get; set; }
    Property Value
    Type Description
    System.Windows.HorizontalAlignment

    IndicatorColorPalette

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

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

    ItemsSource

    Gets or sets a IEnumerable which indicates source for SfKanban.

    Declaration
    public IEnumerable ItemsSource { get; set; }
    Property Value
    Type Description
    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 Description
    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 Description
    System.Double

    PlaceholderStyle

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

    Declaration
    public PlaceholderStyle PlaceholderStyle { get; set; }
    Property Value
    Type Description
    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 Description
    System.Windows.DataTemplate

    SwimlaneKey

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

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

    Workflows

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

    Declaration
    public WorkflowCollection Workflows { get; set; }
    Property Value
    Type Description
    WorkflowCollection

    Methods

    Dispose()

    To dispose the Kanban's instances.

    Declaration
    public void Dispose()

    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 Description
    System.EventHandler<KanbanDoubleTappedEventArgs>

    CardDragEnd

    Occurs when the dragging card is released.

    Declaration
    public event EventHandler<KanbanDragEndEventArgs> CardDragEnd
    Event Type
    Type Description
    System.EventHandler<KanbanDragEndEventArgs>

    CardDragEnter

    Occurs when dragging enter into another column.

    Declaration
    public event EventHandler<KanbanDragEnterEventArgs> CardDragEnter
    Event Type
    Type Description
    System.EventHandler<KanbanDragEnterEventArgs>

    CardDragLeave

    Occurs when leaving the dragging card from one column.

    Declaration
    public event EventHandler<KanbanDragLeaveEventArgs> CardDragLeave
    Event Type
    Type Description
    System.EventHandler<KanbanDragLeaveEventArgs>

    CardDragOver

    Occurs when card dragging over to the KanbanColumn.

    Declaration
    public event EventHandler<KanbanDragOverEventArgs> CardDragOver
    Event Type
    Type Description
    System.EventHandler<KanbanDragOverEventArgs>

    CardDragStart

    Occurs when card drag started in KanbanColumn.

    Declaration
    public event EventHandler<KanbanDragStartEventArgs> CardDragStart
    Event Type
    Type Description
    System.EventHandler<KanbanDragStartEventArgs>

    CardTapped

    Occurs when tapped on the card.

    Declaration
    public event EventHandler<KanbanTappedEventArgs> CardTapped
    Event Type
    Type Description
    System.EventHandler<KanbanTappedEventArgs>

    ColumnGenerated

    Occurred for each column generation completed.

    Declaration
    public event EventHandler<KanbanColumnGeneratedEventArgs> ColumnGenerated
    Event Type
    Type Description
    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 Description
    System.EventHandler<KanbanColumnsGeneratedEventArgs>

    Implements

    System.IDisposable
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved