Class Kanban

Inheritance
System.Object
TagHelper
EJTagHelper
Kanban
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
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
[HtmlAttributeName("actionBegin")]
public string ActionBegin { get; set; }
Property Value
Type Description
System.String

The default value is null

ActionComplete

Triggers on successful completion of the Kanban actions.

Declaration
[HtmlAttributeName("actionComplete")]
public string ActionComplete { get; set; }
Property Value
Type Description
System.String

The default value is null

ActionFailure

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

Declaration
[HtmlAttributeName("actionFailure")]
public string ActionFailure { get; set; }
Property Value
Type Description
System.String

The default value is null

AllowDragAndDrop

Enables or disables the drag and drop actions in Kanban.

Declaration
[HtmlAttributeName("allowDragAndDrop")]
public bool AllowDragAndDrop { get; set; }
Property Value
Type Description
System.Boolean

The default value is true

AllowKeyboard

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

Declaration
[HtmlAttributeName("allowKeyboard")]
public bool AllowKeyboard { get; set; }
Property Value
Type Description
System.Boolean

The default value is true

CardClick

Triggers on single-clicking the Kanban cards.

Declaration
[HtmlAttributeName("cardClick")]
public string CardClick { get; set; }
Property Value
Type Description
System.String

The default value is null

CardDoubleClick

Triggers on double-clicking the Kanban cards.

Declaration
[HtmlAttributeName("cardDoubleClick")]
public string CardDoubleClick { get; set; }
Property Value
Type Description
System.String

The default value is null

CardRendered

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

Declaration
[HtmlAttributeName("cardRendered")]
public string CardRendered { get; set; }
Property Value
Type Description
System.String

The default value is null

CardSettings

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

Declaration
[HtmlAttributeName("cardSettings")]
public KanbanCardSettings CardSettings { get; set; }
Property Value
Type Description
KanbanCardSettings

The default value is null

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
[HtmlAttributeName("columns")]
public List<KanbanColumn> Columns { get; set; }
Property Value
Type Description
System.Collections.Generic.List<KanbanColumn>

The default value is null

ConstraintType

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

Declaration
[HtmlAttributeName("constraintType")]
public ConstraintType ConstraintType { get; set; }
Property Value
Type Description
ConstraintType

The default value is ConstraintType.Column

Created

Triggers after the kanban component is created.

Declaration
[HtmlAttributeName("created")]
public string Created { get; set; }
Property Value
Type Description
System.String

The default value is null

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
[HtmlAttributeName("cssClass")]
public string CssClass { get; set; }
Property Value
Type Description
System.String

The default value is null

DataBinding

Triggers before the data binds to the Kanban.

Declaration
[HtmlAttributeName("dataBinding")]
public string DataBinding { get; set; }
Property Value
Type Description
System.String

The default value is null

DataBound

Triggers once the event data is bound to the Kanban.

Declaration
[HtmlAttributeName("dataBound")]
public string DataBound { get; set; }
Property Value
Type Description
System.String

The default value is null

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
[HtmlAttributeName("dataSource")]
public object DataSource { get; set; }
Property Value
Type Description
System.Object

The default value is null

DataSourceChanged

Triggers when the grid data is added, deleted and updated.

Declaration
[HtmlAttributeName("dataSourceChanged")]
public string DataSourceChanged { get; set; }
Property Value
Type Description
System.String

The default value is null

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
[HtmlAttributeName("dataStateChange")]
public string DataStateChange { get; set; }
Property Value
Type Description
System.String

The default value is null

DialogClose

Triggers before the dialog closes.

Declaration
[HtmlAttributeName("dialogClose")]
public string DialogClose { get; set; }
Property Value
Type Description
System.String

The default value is null

DialogOpen

Triggers before the dialog opens.

Declaration
[HtmlAttributeName("dialogOpen")]
public string DialogOpen { get; set; }
Property Value
Type Description
System.String

The default value is null

DialogSettings

Defines the dialog settings such as template and fields.

Declaration
[HtmlAttributeName("dialogSettings")]
public KanbanDialogSettings DialogSettings { get; set; }
Property Value
Type Description
KanbanDialogSettings

The default value is null

Drag

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

Declaration
[HtmlAttributeName("drag")]
public string Drag { get; set; }
Property Value
Type Description
System.String

The default value is null

DragStart

Triggers when the card drag actions starts.

Declaration
[HtmlAttributeName("dragStart")]
public string DragStart { get; set; }
Property Value
Type Description
System.String

The default value is null

DragStop

Triggers when the card drag actions stops.

Declaration
[HtmlAttributeName("dragStop")]
public string DragStop { get; set; }
Property Value
Type Description
System.String

The default value is null

EnableHtmlSanitizer

Determine whether to prevent cross-site scripting code in Kanban data entry fields.

Declaration
[HtmlAttributeName("enableHtmlSanitizer")]
public bool EnableHtmlSanitizer { get; set; }
Property Value
Type Description
System.Boolean

The default value is true

EnablePersistence

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

Declaration
[HtmlAttributeName("enablePersistence")]
public bool EnablePersistence { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableRtl

Enable or disable rendering component in right to left direction.

Declaration
[HtmlAttributeName("enableRtl")]
public bool EnableRtl { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableTooltip

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

Declaration
[HtmlAttributeName("enableTooltip")]
public bool EnableTooltip { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

ExternalDropId

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

Declaration
[HtmlAttributeName("externalDropId")]
public string[] ExternalDropId { get; set; }
Property Value
Type Description
System.String[]

The default value is null

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
[HtmlAttributeName("height")]
public string Height { get; set; }
Property Value
Type Description
System.String

The default value is "auto"

HtmlAttributes

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

Declaration
[HtmlAttributeName("htmlAttributes")]
public object HtmlAttributes { get; set; }
Property Value
Type Description
System.Object

KeyField

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

Declaration
[HtmlAttributeName("keyField")]
public string KeyField { get; set; }
Property Value
Type Description
System.String

The default value is null

Locale

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

Declaration
[HtmlAttributeName("locale")]
public string Locale { get; set; }
Property Value
Type Description
System.String

The default value is ""

Query

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

Declaration
[HtmlAttributeName("query")]
public string Query { get; set; }
Property Value
Type Description
System.String

The default value is null

QueryCellInfo

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

Declaration
[HtmlAttributeName("queryCellInfo")]
public string QueryCellInfo { get; set; }
Property Value
Type Description
System.String

The default value is null

ShowEmptyColumn

Enable or disable the columns when empty dataSource.

Declaration
[HtmlAttributeName("showEmptyColumn")]
public bool ShowEmptyColumn { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

SortSettings

Defines the sort settings such as field and direction.

Declaration
[HtmlAttributeName("sortSettings")]
public KanbanSortSettings SortSettings { get; set; }
Property Value
Type Description
KanbanSortSettings

The default value is null

StackedHeaders

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

Declaration
[HtmlAttributeName("stackedHeaders")]
public List<KanbanStackedHeader> StackedHeaders { get; set; }
Property Value
Type Description
System.Collections.Generic.List<KanbanStackedHeader>

The default value is null

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
[HtmlAttributeName("swimlaneSettings")]
public KanbanSwimlaneSettings SwimlaneSettings { get; set; }
Property Value
Type Description
KanbanSwimlaneSettings

The default value is null

TooltipTemplate

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

Declaration
[HtmlAttributeName("tooltipTemplate")]
public string TooltipTemplate { get; set; }
Property Value
Type Description
System.String

The default value is null

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
[HtmlAttributeName("width")]
public string Width { get; set; }
Property Value
Type Description
System.String

The default value is "auto"