Class Kanban

Inheritance
System.Object
EJTagHelper
Kanban
Inherited Members
Namespace: Syncfusion.EJ2.Kanban
Assembly: Syncfusion.EJ2.dll
Syntax
public class Kanban : EJTagHelper

Constructors

Kanban()

Declaration
public Kanban()

Properties

ActionBegin

Triggers on beginning of every Kanban action.

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

ActionComplete

Triggers on successful completion of the Kanban actions.

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

ActionFailure

Triggers when a Kanban action gets failed or interrupted and an error information will be returned.

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

AllowDragAndDrop

Enables or disables the drag and drop actions in Kanban.

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

AllowKeyboard

When this property is set to true, it allows the keyboard interaction in Kanban.

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

CardClick

Triggers on single-clicking the Kanban cards.

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

CardDoubleClick

Triggers on double-clicking the Kanban cards.

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

CardRendered

Triggers before each card of the Kanban rendering on the page.

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

CardSettings

Defines the Kanban board related settings such as header field, content field, template, show or hide header, and single or multiple selection.

Declaration
public KanbanCardSettings CardSettings { get; set; }
Property Value
Type Description
KanbanCardSettings

ClassName

Declaration
protected override string ClassName { get; }
Property Value
Type Description
System.String
Overrides

Columns

Defines the Kanban board columns 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.

Declaration
public List<KanbanColumn> Columns { get; set; }
Property Value
Type Description
System.Collections.Generic.List<KanbanColumn>

ConstraintType

Defines the constraint type used to apply validation based on column or swimlane. The possible values are: Column Swimlane

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

Created

Triggers after the kanban component is created.

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

CssClass

It is used to customize the Kanban, which accepts custom CSS class names that defines specific user-defined styles and themes to be applied on the Kanban element.

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

DataBinding

Triggers before the data binds to the Kanban.

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

DataBound

Triggers once the event data is bound to the Kanban.

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

DataSource

With this property, the card data will be bound to Kanban. The card data can be passed either as an array of JavaScript objects, or else can create an instance of DataManager in case of processing remote data and can be assigned to the dataSource property. With the remote data assigned to dataSource, check the available adaptors to customize the data processing.

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

DataSourceChanged

Triggers when the grid data is added, deleted and updated. Invoke the done method from the argument to start render after edit operation.

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

DataStateChange

Triggers when the grid actions such as Sorting, Paging, Grouping etc., are done. In this event,the current view data and total record count should be assigned to the dataSource based on the action performed.

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

DialogClose

Triggers before the dialog closes.

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

DialogOpen

Triggers before the dialog opens.

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

DialogSettings

Defines the dialog settings such as template and fields.

Declaration
public KanbanDialogSettings DialogSettings { get; set; }
Property Value
Type Description
KanbanDialogSettings

Drag

Triggers when the card is dragging to other stage or other swimlane.

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

DragStart

Triggers when the card drag actions starts.

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

DragStop

Triggers when the card drag actions stops.

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

EnablePersistence

Enables or disables the persisting component's state between page reloads. If enabled, columns, dataSource properties will be persisted in kanban.

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

EnableRtl

Enable or disable rendering component in right to left direction.

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

EnableTooltip

Enables or disables the tooltip in Kanban board. The property relates to the tooltipTemplate property.

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

ExternalDropId

Defines the ID of drop component on which drop should occur.

Declaration
public string[] ExternalDropId { get; set; }
Property Value
Type Description
System.String[]

Height

Sets the height of the Kanban component, accepting both string and number values. The string type includes either pixel or percentage values. When height is set with specific pixel value, then the Kanban will be rendered to that specified space. In case, if auto value is set, then the height of the Kanban gets auto-adjusted within the given container.

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

HtmlAttributes

Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.

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

IsFor

Declaration
protected override bool IsFor { get; }
Property Value
Type Description
System.Boolean
Overrides

KeyField

Defines the key field of Kanban board. The Kanban renders its layout based on this key field.

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

Locale

Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

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

NameSpace

Declaration
protected override string NameSpace { get; }
Property Value
Type Description
System.String
Overrides

Query

Defines the external query that will be executed along with the data processing.

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

QueryCellInfo

Triggers before each column of the Kanban rendering on the page.

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

ShowEmptyColumn

Enable or disable the columns when empty dataSource.

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

SortSettings

Defines the sort settings such as field and direction.

Declaration
public KanbanSortSettings SortSettings { get; set; }
Property Value
Type Description
KanbanSortSettings

StackedHeaders

Defines the stacked header for Kanban columns with text and key fields.

Declaration
public List<KanbanStackedHeader> StackedHeaders { get; set; }
Property Value
Type Description
System.Collections.Generic.List<KanbanStackedHeader>

SwimlaneSettings

Defines the swimlane settings to Kanban board such as key field, text field, template, allow drag-and-drop, show or hide empty row, show or hide items count, and more.

Declaration
public KanbanSwimlaneSettings SwimlaneSettings { get; set; }
Property Value
Type Description
KanbanSwimlaneSettings

TagName

Declaration
protected override string TagName { get; }
Property Value
Type Description
System.String
Overrides

TooltipTemplate

Defines the template content to card’s tooltip. The property works by enabling the ‘enableTooltip’ property.

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

Width

Sets the width of the Kanban component, accepting both string and number values. The string value can be either pixel or percentage format. When set to auto, the Kanban width gets auto-adjusted and display its content related to the viewable screen size.

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