Class Kanban

Class for Kanban control

Inheritance

System.Object

CommonDataBoundControl

Kanban

Implements

System.Web.UI.INamingContainer

System.Web.UI.IPostBackEventHandler

System.Web.UI.IPostBackDataHandler

System.Web.UI.IUrlResolutionService

Inherited Members

CommonDataBoundControl.PerformDataBinding(IEnumerable)

CommonDataBoundControl.RaisePostBackEvent(String)

CommonDataBoundControl.OnLoad(EventArgs)

CommonDataBoundControl.OnPreRender(EventArgs)

CommonDataBoundControl.RenderContents(HtmlTextWriter)

Namespace: Syncfusion.JavaScript.Web

Assembly: Syncfusion.EJ.Web.dll

Syntax

public class Kanban : CommonDataBoundControl, INamingContainer, IPostBackEventHandler, IPostBackDataHandler, IUrlResolutionService

Constructors

Kanban()

Declaration

public Kanban()

Properties

AllowDragAndDrop

Gets or sets a value that indicates whether to allow cards DragAndDrop in Kanban.

Declaration

public bool AllowDragAndDrop { get; set; }

Property Value

Type	Description
System.Boolean	if ; otherwise, .

AllowExternalDragAndDrop

Gets or sets a value that indicates whether to enable allowExternalDragAndDrop behavior on Kanban.

Declaration

public bool AllowExternalDragAndDrop { get; set; }

Property Value

Type	Description
System.Boolean	if ; otherwise, .

AllowFiltering

Gets or sets a value to enable or disable Filtering.

Declaration

public bool AllowFiltering { get; set; }

Property Value

Type	Description
System.Boolean	if ; otherwise, .

AllowHover

Gets or sets a value that indicates whether to allow card hover actions.

Declaration

public bool AllowHover { get; set; }

Property Value

Type	Description
System.Boolean	if ; otherwise, .

AllowKeyboardNavigation

Gets or sets a value to allow keyboard navigation actions in Kanban.

Declaration

public bool AllowKeyboardNavigation { get; set; }

Property Value

Type	Description
System.Boolean	if ; otherwise, .

AllowPrinting

Gets or sets a value that indicates whether to enable or disable Printing in Kanban.

Declaration

public bool AllowPrinting { get; set; }

Property Value

Type	Description
System.Boolean	if ; otherwise, .

AllowScrolling

Gets or sets a value that indicates whether to enable the scrollbar in the Kanban and view the card by scroll through the Kanban manually.

Declaration

public bool AllowScrolling { get; set; }

Property Value

Type	Description
System.Boolean	if ; otherwise, .

AllowSearching

Gets or sets a value to allow Searching operation in Kanban.

Declaration

public bool AllowSearching { get; set; }

Property Value

Type	Description
System.Boolean	if ; otherwise, .

AllowSelection

Gets or sets a value that indicates whether user can select cards in Kanban. On enabling feature, selected card will be highlighted.

Declaration

public bool AllowSelection { get; set; }

Property Value

Type	Description
System.Boolean	if ; otherwise, .

AllowTitle

Gets or sets a value indicating whether to enable or disable the title of the card.

Declaration

public bool AllowTitle { get; set; }

Property Value

Type	Description
System.Boolean	if ; otherwise, .

AllowToggleColumn

Gets or sets a value to enable or disable the column expand /collapse.

Declaration

public bool AllowToggleColumn { get; set; }

Property Value

Type	Description
System.Boolean	if ; otherwise, .

CardSettings

Gets or sets an object that indicates whether to customize the cards behavior of the Kanban.

Declaration

public CardSettings CardSettings { get; set; }

Property Value

Type	Description
CardSettings	The Kanban CardSettings

ClientSideEvents

Gets or sets an objects to add client side events of the Kanban.

Declaration

public KanbanClientSideEvents ClientSideEvents { get; set; }

Property Value

Type	Description
KanbanClientSideEvents	The Kanban ClientSideEvents

Columns

Gets or sets an object that indicates to render the Kanban with specified columns.

Declaration

public List<KanbanColumn> Columns { get; }

Property Value

Type	Description
System.Collections.Generic.List<KanbanColumn>	The Kanban Columns

ContextMenuSettings

Gets or sets an object that indicates whether to customize the context menu behavior of the Kanban.

Declaration

public KanbanContextMenuSettings ContextMenuSettings { get; set; }

Property Value

Type	Description
KanbanContextMenuSettings	The Kanban ContextMenuSettings

CssClass

Declaration

public override string CssClass { get; set; }

Property Value

Type	Description
System.String

CustomToolBarItems

Option to add custom toolbar button items in the Kanban.

Declaration

public List<KanbanCustomToolBarItems> CustomToolBarItems { get; }

Property Value

Type	Description
System.Collections.Generic.List<KanbanCustomToolBarItems>	The Kanban CustomToolBarItems

DataManager

Gets or sets the data to render the Kanban with cards.

Declaration

public DataSource DataManager { get; set; }

Property Value

Type	Description
DataSource

DataSourceCachingMode

Gets or sets the data with caching mode to render the Kanban with cards.

Declaration

public DataSourceCachingMode DataSourceCachingMode { get; set; }

Property Value

Type	Description
DataSourceCachingMode

EditSettings

Gets or sets an object that indicates whether to customize the editing behavior of the Kanban.

Declaration

public KanbanEditSettings EditSettings { get; set; }

Property Value

Type	Description
KanbanEditSettings	The Kanban EditSettings

EnableRTL

Gets or sets the align content in the Kanban control from right to left by setting the property as true.

Declaration

public bool EnableRTL { get; set; }

Property Value

Type	Description
System.Boolean	if ; otherwise, .

EnableTotalCount

Gets or sets a value indicating whether to show Total cards count in each column header.

Declaration

public bool EnableTotalCount { get; set; }

Property Value

Type	Description
System.Boolean	if ; otherwise, .

EnableTouch

To Disable the mouse swipe property as false.

Declaration

public bool EnableTouch { get; set; }

Property Value

Type	Description
System.Boolean	if ; otherwise, .

Fields

Gets or sets an object that indicates to render the Kanban with specified fields setttings.

Declaration

public CardFields Fields { get; set; }

Property Value

Type	Description
CardFields	The Kanban Fields

FilterSettings

Gets or sets an object that indicates whether to customize the filtering options of the Kanban.

Declaration

public List<KanbanFilterSetting> FilterSettings { get; }

Property Value

Type	Description
System.Collections.Generic.List<KanbanFilterSetting>	The Kanban FilterSettings

IsResponsive

Gets or sets a value that indicates whether the Kanban design has be to made responsive.

Declaration

public bool IsResponsive { get; set; }

Property Value

Type	Description
System.Boolean	if ; otherwise, .

KeyField

Mapping of datasource field for column values mapping to render cards for specific column.

Declaration

public string KeyField { get; set; }

Property Value

Type	Description
System.String	The datasouce field name as KeyField

Locale

Gets or sets a value that indicates whether to customizing the user interface (UI) as locale-specific in order to display regional data i.e. in a language and culture specific to a particular country or region.

Declaration

public string Locale { get; set; }

Property Value

Type	Description
System.String	The locale string to be used as Locale for Kanban

MinWidth

Gets or sets a value that indicates whether to set the minimum width of the responsive Kanban while isResponsive property is true.

Declaration

public int MinWidth { get; set; }

Property Value

Type	Description
System.Int32	The Width to use as MinWidth for Kanban

Model

Gets or sets a value that indicates to enable the Kanban property model.

Declaration

public KanbanProperties Model { get; set; }

Property Value

Type	Description
KanbanProperties	The Kanban Model

Query

Gets or sets an object of ej.Query that Queries to perform filtering.

Declaration

public string Query { get; set; }

Property Value

Type	Description
System.String	The ej.Query to be used as Query

ScrollSettings

Gets or sets an object that indicates whether to customize the scrolling behavior of the Kanban.

Declaration

public KanbanScrollSettings ScrollSettings { get; set; }

Property Value

Type	Description
KanbanScrollSettings	The Kanban ScrollSettings

SearchSettings

Gets or sets an object that indicates whether to customize the searching behavior of the Kanban.

Declaration

public KanbanSearchSettings SearchSettings { get; set; }

Property Value

Type	Description
KanbanSearchSettings	The Kanban SearchSettings

SelectionType

Gets or sets card selection behavior of Kanban. Accepting types are “single” and “multiple”.

Declaration

public SelectionType SelectionType { get; set; }

Property Value

Type	Description
SelectionType	The type of selection

ShowColumnWhenEmpty

Gets or sets a value indicating whether to render kanban columns using empty data source.

Declaration

public bool ShowColumnWhenEmpty { get; set; }

Property Value

Type	Description
System.Boolean	if ; otherwise, .

StackedHeaderRows

Gets or sets an object that indicates to managing the collection of stacked header rows for the Kanban.

Declaration

public List<KanbanStackedHeaderRow> StackedHeaderRows { get; }

Property Value

Type	Description
System.Collections.Generic.List<KanbanStackedHeaderRow>	The Kanban StackedHeaderRows

SwimlaneSettings

Gets or sets an object that indicates whether to customize the swimlane settings of the Kanban.

Declaration

public SwimlaneSettings SwimlaneSettings { get; set; }

Property Value

Type	Description
SwimlaneSettings	The Kanban SwimlaneSettings

ToolTipSettings

Gets or sets an object that indicates whether to customize the tooltip behavior of the Kanban.

Declaration

public KanbanTooltipSettings ToolTipSettings { get; set; }

Property Value

Type	Description
KanbanTooltipSettings	The Kanban ToolTipSettings

WorkFlow

Kanban WorkFlow Options

Declaration

public List<KanbanWorkflow> WorkFlow { get; }

Property Value

Type	Description
System.Collections.Generic.List<KanbanWorkflow>	The Column

Methods

DependentScripts()

Gets the refrence of Dependent scripts.

Declaration

public List<string> DependentScripts()

Returns

Type	Description
System.Collections.Generic.List<System.String>	It retruns the String

FetchData(IEnumerable)

Gets or sets the data to render the Kanban with cards.

Declaration

public override void FetchData(IEnumerable data)

Parameters

Type	Name	Description
System.Collections.IEnumerable	data	It accepts the IEnumerable and displays the cards

Overrides

CommonDataBoundControl.FetchData(IEnumerable)

GetCollection<T>(Object)

Declaration

protected List<T> GetCollection<T>(object collection)

Parameters

Type	Name	Description
System.Object	collection

Returns

Type	Description
System.Collections.Generic.List<T>

Type Parameters

Name	Description
T

GetDependentFiles()

Gets the reference of dependent list.

Declaration

public override List<string> GetDependentFiles()

Returns

Type	Description
System.Collections.Generic.List<System.String>	It returns the String

Overrides

CommonDataBoundControl.GetDependentFiles()

LoadViewState(Object)

Gets a object that specifies the model of the Kanban.

Declaration

protected override void LoadViewState(object state)

Parameters

Type	Name	Description
System.Object	state	It accepts the Object and display

Overrides

CommonDataBoundControl.LoadViewState(Object)

PostBackEventHandler(String, Dictionary<String, Object>)

Declaration

public override void PostBackEventHandler(string EventName, Dictionary<string, object> args)

Parameters

Type	Name	Description
System.String	EventName
System.Collections.Generic.Dictionary<System.String, System.Object>	args

Overrides

CommonDataBoundControl.PostBackEventHandler(String, Dictionary<String, Object>)

Render()

Gets a value that specifies to render the Kanban.

Declaration

public string Render()

Returns

Type	Description
System.String	It returns the String

Render(HtmlTextWriter)

Gets a value that specifies to render the Kanban.

Declaration

protected override void Render(HtmlTextWriter writer)

Parameters

Type	Name	Description
System.Web.UI.HtmlTextWriter	writer	It accepts the HtmlTextWriter and display

Overrides

CommonDataBoundControl.Render(HtmlTextWriter)

SaveViewState()

Gets a object that specifies the serializable model of the Kanban.

Declaration

protected override object SaveViewState()

Returns

Type	Description
System.Object	It returns the Object

UpdateServerModel(Dictionary<String, Object>)

Gets the value for the functions to be performed and update on the server.

Declaration

public override void UpdateServerModel(Dictionary<string, object> ClientModel)

Parameters

Type	Name	Description
System.Collections.Generic.Dictionary<System.String, System.Object>	ClientModel	It accepts the string value and object value passed for update.

Overrides

CommonDataBoundControl.UpdateServerModel(Dictionary<String, Object>)

Events

ServerCardClick

Specify the ServerCardClick Event Handler.

Declaration

public event Kanban.KanbanEventHandler ServerCardClick

Event Type

Type	Description
Kanban.KanbanEventHandler

ServerContextClick

Specify the ServerContextClick Event Handler.

Declaration

public event Kanban.KanbanEventHandler ServerContextClick

Event Type

Type	Description
Kanban.KanbanEventHandler

ServerEndAdd

Specify the ServerendAdd Event Handler.

Declaration

public event Kanban.KanbanEventHandler ServerEndAdd

Event Type

Type	Description
Kanban.KanbanEventHandler

ServerEndDelete

Specify the ServerendDelete Event Handler.

Declaration

public event Kanban.KanbanEventHandler ServerEndDelete

Event Type

Type	Description
Kanban.KanbanEventHandler

ServerEndEdit

Specify the ServerendEdit Event Handler.

Declaration

public event Kanban.KanbanEventHandler ServerEndEdit

Event Type

Type	Description
Kanban.KanbanEventHandler

Implements

System.Web.UI.INamingContainer

System.Web.UI.IPostBackEventHandler

System.Web.UI.IPostBackDataHandler

System.Web.UI.IUrlResolutionService