Class KanbanPropertiesBuilder

Represents a class for KanbanPropertiesBuilder which includes data source, key field, width, height, query, fields, columns and edit settings, etc.

Inheritance

System.Object

KanbanPropertiesBuilder

Implements

IPropertiesBuilder

System.Web.IHtmlString

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.JavaScript

Assembly: Syncfusion.EJ.dll

Syntax

public class KanbanPropertiesBuilder : IPropertiesBuilder, IHtmlString

Constructors

KanbanPropertiesBuilder()

Initializes a new instance of the KanbanPropertiesBuilder class.

Declaration

public KanbanPropertiesBuilder()

KanbanPropertiesBuilder(Kanban)

Initializes a new instance of the KanbanPropertiesBuilder class.

Declaration

public KanbanPropertiesBuilder(Kanban Kanban)

Parameters

Type	Name	Description
Kanban	Kanban	Kanban

Methods

AllowDragAndDrop(Boolean)

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

Declaration

public KanbanPropertiesBuilder AllowDragAndDrop(bool allowDragAndDrop)

Parameters

Type	Name	Description
System.Boolean	allowDragAndDrop	If set to , then ; otherwise, .

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

AllowExternalDragAndDrop(Boolean)

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

Declaration

public KanbanPropertiesBuilder AllowExternalDragAndDrop(bool allowExternalDragAndDrop)

Parameters

Type	Name	Description
System.Boolean	allowExternalDragAndDrop	If set to , then ; otherwise, .

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

AllowFiltering(Boolean)

To enable or disable filtering.

Declaration

public KanbanPropertiesBuilder AllowFiltering(bool allowFiltering)

Parameters

Type	Name	Description
System.Boolean	allowFiltering	If set to , then ; otherwise, .

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

AllowHover(Boolean)

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

Declaration

public KanbanPropertiesBuilder AllowHover(bool allowHover)

Parameters

Type	Name	Description
System.Boolean	allowHover	If set to , then ; otherwise, .

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

AllowKeyboardNavigation(Boolean)

To allow keyboard navigation actions.

Declaration

public KanbanPropertiesBuilder AllowKeyboardNavigation(bool allowKeyboardNavigation)

Parameters

Type	Name	Description
System.Boolean	allowKeyboardNavigation	If set to , then ; otherwise, .

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

AllowPrinting(Boolean)

To enable or disable the Printing

Declaration

public KanbanPropertiesBuilder AllowPrinting(bool allowPrinting)

Parameters

Type	Name	Description
System.Boolean	allowPrinting	If set to , then ; otherwise, .

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

AllowScrolling(Boolean)

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 KanbanPropertiesBuilder AllowScrolling(bool allowScrolling)

Parameters

Type	Name	Description
System.Boolean	allowScrolling	If set to , then ; otherwise, .

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

AllowSearching(Boolean)

To enable Searching operation in Kanban.

Declaration

public KanbanPropertiesBuilder AllowSearching(bool allowSearching)

Parameters

Type	Name	Description
System.Boolean	allowSearching	If set to , then ; otherwise, .

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

AllowSelection(Boolean)

Gets or sets a value that indicates whether to enable allowSelection behavior on Kanban.User can select card and the selected card will be highlighted on Kanban.

Declaration

public KanbanPropertiesBuilder AllowSelection(bool allowSelection)

Parameters

Type	Name	Description
System.Boolean	allowSelection	If set to , then ; otherwise, .

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

AllowTitle(Boolean)

To enable or disable the title of the card.

Declaration

public KanbanPropertiesBuilder AllowTitle(bool allowTitle)

Parameters

Type	Name	Description
System.Boolean	allowTitle	If set to , then ; otherwise, .

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

AllowToggleColumn(Boolean)

To enable or disable the column expand /collapse.

Declaration

public KanbanPropertiesBuilder AllowToggleColumn(bool allowToggleColumn)

Parameters

Type	Name	Description
System.Boolean	allowToggleColumn	If set to , then ; otherwise, .

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

CardSettings(Action<CardSettingsBuilder>)

Gets or sets an object that indicates whether to Customize the card settings.

Declaration

public KanbanPropertiesBuilder CardSettings(Action<CardSettingsBuilder> cardSettings)

Parameters

Type	Name	Description
System.Action<CardSettingsBuilder>	cardSettings	It accepts the list of CardSettings through lambda expression

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

ClientSideEvents(Action<KanbanClientSideEventsBuilder>)

It sets the list of Events to perform some Kanban functionalities.

Declaration

public KanbanPropertiesBuilder ClientSideEvents(Action<KanbanClientSideEventsBuilder> clientSideEvents)

Parameters

Type	Name	Description
System.Action<KanbanClientSideEventsBuilder>	clientSideEvents	It accepts the list of events through lambda expression.

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

Columns(Action<KanbanColumnBuilder>)

It sets an object that indicates to render the Kanban with specified columns

Declaration

public KanbanPropertiesBuilder Columns(Action<KanbanColumnBuilder> column)

Parameters

Type	Name	Description
System.Action<KanbanColumnBuilder>	column	It displays the list of columns through lambda expression

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

Columns(List<KanbanColumn>)

It sets an object that indicates to render the Kanban with specified columns

Declaration

public KanbanPropertiesBuilder Columns(List<KanbanColumn> column)

Parameters

Type	Name	Description
System.Collections.Generic.List<KanbanColumn>	column	It displays the list of columns

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

ContextMenuSettings(Action<KanbanContextMenuSettingsBuilder>)

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

Declaration

public KanbanPropertiesBuilder ContextMenuSettings(Action<KanbanContextMenuSettingsBuilder> contextMenuSettings)

Parameters

Type	Name	Description
System.Action<KanbanContextMenuSettingsBuilder>	contextMenuSettings	It displays the list of contextMenu settings option through lambda expression

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

CssClass(String)

It sets a value that indicates to provide custom CSS for Kanban.

Declaration

public KanbanPropertiesBuilder CssClass(string cssclass)

Parameters

Type	Name	Description
System.String	cssclass	It accepts the string value and displays the custom css for Kanban

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

CustomToolbarItems(Action<CustomToolBarSettingsBuilder>)

It sets an object that adds custom toolbar items in Kanban.

Declaration

public KanbanPropertiesBuilder CustomToolbarItems(Action<CustomToolBarSettingsBuilder> customToolbarItems)

Parameters

Type	Name	Description
System.Action<CustomToolBarSettingsBuilder>	customToolbarItems	It displays the list of customToolbarItems

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

CustomToolbarItems(List<KanbanCustomToolBarItems>)

Gets or sets a value that indicates whether to add customToolbarItems within the toolbar to perform any action in the Kanban.

Declaration

public KanbanPropertiesBuilder CustomToolbarItems(List<KanbanCustomToolBarItems> customToolbarItems)

Parameters

Type	Name	Description
System.Collections.Generic.List<KanbanCustomToolBarItems>	customToolbarItems	The customToolbarItems

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

DataSource(DataSource)

It sets the data to render the Kanban with cards.

Declaration

public KanbanPropertiesBuilder DataSource(DataSource dataSource)

Parameters

Type	Name	Description
DataSource	dataSource	It displays the list of records

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

DataSource(Action<DataSourceBuilder>)

It sets the data to render the Kanban with cards.

Declaration

public KanbanPropertiesBuilder DataSource(Action<DataSourceBuilder> dataSource)

Parameters

Type	Name	Description
System.Action<DataSourceBuilder>	dataSource	It displays the list of records through lambda expression

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

DataSource(IEnumerable)

It sets the data to render the Kanban with cards.

Declaration

public KanbanPropertiesBuilder DataSource(IEnumerable dataSource)

Parameters

Type	Name	Description
System.Collections.IEnumerable	dataSource	It display the list of records of type IEnumerable

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

DataSource(String)

It communicates with data source and returns the desired result based on the url provided.

Declaration

public KanbanPropertiesBuilder DataSource(string dataUrl)

Parameters

Type	Name	Description
System.String	dataUrl	It accepts the string value and provides the datasource

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

EditSettings(Action<KanbanEditSettingsBuilder>)

It sets a value that indicates whether to customize editing behavior in Kanban.

Declaration

public KanbanPropertiesBuilder EditSettings(Action<KanbanEditSettingsBuilder> editSettings)

Parameters

Type	Name	Description
System.Action<KanbanEditSettingsBuilder>	editSettings	It displays the list of EditSettings through lambda expression

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

EnableRTL(Boolean)

Align content in the Kanban control from right to left by setting the property as true.

Declaration

public KanbanPropertiesBuilder EnableRTL(bool enableRTL)

Parameters

Type	Name	Description
System.Boolean	enableRTL	If set to , then ; otherwise, .

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

EnableTotalCount(Boolean)

To show Total count of cards in column wise.

Declaration

public KanbanPropertiesBuilder EnableTotalCount(bool enableTotalCount)

Parameters

Type	Name	Description
System.Boolean	enableTotalCount	If set to , then ; otherwise, .

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

EnableTouch(Boolean)

To enable or disable the touch behaviour in Kanban.

Declaration

public KanbanPropertiesBuilder EnableTouch(bool enableTouch)

Parameters

Type	Name	Description
System.Boolean	enableTouch	If set to , then ; otherwise, .

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

Fields(Action<CardFieldsBuilder>)

To customize field mappings for card , editing title and control key parameters

Declaration

public KanbanPropertiesBuilder Fields(Action<CardFieldsBuilder> fields)

Parameters

Type	Name	Description
System.Action<CardFieldsBuilder>	fields	It accepts datasource mapping fields

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

FilterSettings(Action<KanbanFilterSettingsBuilder>)

It sets an object that indicates whether to customize the filtering of the Kanban.

Declaration

public KanbanPropertiesBuilder FilterSettings(Action<KanbanFilterSettingsBuilder> filterSettings)

Parameters

Type	Name	Description
System.Action<KanbanFilterSettingsBuilder>	filterSettings	It displays the list of FilterSettings through lambda expression

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

FilterSettings(List<KanbanFilterSetting>)

It sets an object that indicates whether to customize the filtering of the Kanban.

Declaration

public KanbanPropertiesBuilder FilterSettings(List<KanbanFilterSetting> filterSettings)

Parameters

Type	Name	Description
System.Collections.Generic.List<KanbanFilterSetting>	filterSettings	It displays the list of FilterSettings

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

Height(Object)

It gets or sets an object that indicates to render the Kanban with specified height.

Declaration

public KanbanPropertiesBuilder Height(object height)

Parameters

Type	Name	Description
System.Object	height	The accepts height of Kanban

Returns

Type	Description
KanbanPropertiesBuilder

IsResponsive(Boolean)

When its set to true, adapts the Kanban layout to fit the screen size of devices on which it renders.

Declaration

public KanbanPropertiesBuilder IsResponsive(bool isResponsive)

Parameters

Type	Name	Description
System.Boolean	isResponsive	If set to , then ; otherwise, .

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

KeyField(String)

To map datasource field for column values mapping to render cards for specific column.

Declaration

public KanbanPropertiesBuilder KeyField(string keyField)

Parameters

Type	Name	Description
System.String	keyField	It accepts datasouce field name as KeyField

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

Locale(String)

It 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 KanbanPropertiesBuilder Locale(string locale)

Parameters

Type	Name	Description
System.String	locale	It accepts the string and displays in customized language

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

MinWidth(Int32)

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

Declaration

public KanbanPropertiesBuilder MinWidth(int minWidth)

Parameters

Type	Name	Description
System.Int32	minWidth	It accepts minwidth for Kanban

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

Query(String)

Query the dataSource from the Kanban.

Declaration

public KanbanPropertiesBuilder Query(string query)

Parameters

Type	Name	Description
System.String	query	It accepts the string value and query the datasource based on the value

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

Render()

Creates a Kanban control

Declaration

public void Render()

ScrollSettings(Action<ScrollSettingsBuilder>)

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

Declaration

public KanbanPropertiesBuilder ScrollSettings(Action<ScrollSettingsBuilder> scrollSettings)

Parameters

Type	Name	Description
System.Action<ScrollSettingsBuilder>	scrollSettings	It accepts the list of ScrollSettings options through lambda expression

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

SearchSettings(Action<KanbanSearchSettingsBuilder>)

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

Declaration

public KanbanPropertiesBuilder SearchSettings(Action<KanbanSearchSettingsBuilder> searchSettings)

Parameters

Type	Name	Description
System.Action<KanbanSearchSettingsBuilder>	searchSettings	It displays the list of SearchSettings through lambda expression

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

SelectionType(SelectionType)

The card selection behavior of Kanban. Accepting types are “single” and “multiple”.

Declaration

public KanbanPropertiesBuilder SelectionType(SelectionType selectionType)

Parameters

Type	Name	Description
SelectionType	selectionType	It displays the list of SelectionType options

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

ShowColumnWhenEmpty(Boolean)

To enable or disable the rendering of Kanban empty columns in the sample.

Declaration

public KanbanPropertiesBuilder ShowColumnWhenEmpty(bool showColumnWhenEmpty)

Parameters

Type	Name	Description
System.Boolean	showColumnWhenEmpty	If set to , then ; otherwise, .

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

StackedHeaderRows(Action<KanbanStackedHeaderRowsBuilder>)

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

Declaration

public KanbanPropertiesBuilder StackedHeaderRows(Action<KanbanStackedHeaderRowsBuilder> stackedHeaderRows)

Parameters

Type	Name	Description
System.Action<KanbanStackedHeaderRowsBuilder>	stackedHeaderRows	It displays the collection of stackedHeader Rows through lambda expression

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

StackedHeaderRows(List<KanbanStackedHeaderRow>)

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

Declaration

public KanbanPropertiesBuilder StackedHeaderRows(List<KanbanStackedHeaderRow> stackedHeaderRows)

Parameters

Type	Name	Description
System.Collections.Generic.List<KanbanStackedHeaderRow>	stackedHeaderRows	It displays the collection of stackedHeader Rows

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

SwimlaneSettings(Action<SwimlaneSettingsBuilder>)

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

Declaration

public KanbanPropertiesBuilder SwimlaneSettings(Action<SwimlaneSettingsBuilder> swimlaneSettings)

Parameters

Type	Name	Description
System.Action<SwimlaneSettingsBuilder>	swimlaneSettings	It displays the list of SwimlaneSettings through lambda expression

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

ToHtmlString()

It converts the Kanban properties into Html elements.

Declaration

public string ToHtmlString()

Returns

Type	Description
System.String	KanbanPropertiesBuilder

TooltipSettings(Action<KanbanTooltipSettingsBuilder>)

It sets an object that indicates whether to enable the tooltip and its templating option in the Kanban.

Declaration

public KanbanPropertiesBuilder TooltipSettings(Action<KanbanTooltipSettingsBuilder> tooltipSettings)

Parameters

Type	Name	Description
System.Action<KanbanTooltipSettingsBuilder>	tooltipSettings	It displays the list of TooltipSettings through lambda expression

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

Width(Object)

It gets or sets an object that indicates to render the Kanban with specified width.

Declaration

public KanbanPropertiesBuilder Width(object width)

Parameters

Type	Name	Description
System.Object	width	The accepts width for Kanban

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

Workflows(Action<KanbanWorkflowBuilder>)

It sets an object that indicates to define workflow fro specified columns.

Declaration

public KanbanPropertiesBuilder Workflows(Action<KanbanWorkflowBuilder> workflow)

Parameters

Type	Name	Description
System.Action<KanbanWorkflowBuilder>	workflow	It displays the list of workflow through lambda expression

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

Workflows(List<KanbanWorkflow>)

Add or remove workflow in Kanban workflows collections

Declaration

public KanbanPropertiesBuilder Workflows(List<KanbanWorkflow> workflow)

Parameters

Type	Name	Description
System.Collections.Generic.List<KanbanWorkflow>	workflow	The workflows

Returns

Type	Description
KanbanPropertiesBuilder	KanbanPropertiesBuilder

Implements

IPropertiesBuilder

System.Web.IHtmlString