Class KanbanBuilder
Inheritance
System.Object
KanbanBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class KanbanBuilder : ControlBuilder
Constructors
KanbanBuilder()
Declaration
KanbanBuilder(Kanban)
Declaration
public KanbanBuilder(Kanban model)
Parameters
Type |
Name |
Description |
Kanban |
model |
|
Fields
model
Declaration
Field Value
Properties
HtmlAttr
Declaration
public IDictionary<string, object> HtmlAttr { get; set; }
Property Value
Type |
Description |
System.Collections.Generic.IDictionary<System.String, System.Object> |
|
ID
Declaration
public string ID { get; set; }
Property Value
Type |
Description |
System.String |
|
Output
Declaration
public override TextWriter Output { get; set; }
Property Value
Type |
Description |
System.IO.TextWriter |
|
Overrides
Methods
ActionBegin(String)
Triggers on beginning of every Kanban action.
Declaration
public KanbanBuilder ActionBegin(string actionBegin)
Parameters
Type |
Name |
Description |
System.String |
actionBegin |
|
Returns
ActionComplete(String)
Triggers on successful completion of the Kanban actions.
Declaration
public KanbanBuilder ActionComplete(string actionComplete)
Parameters
Type |
Name |
Description |
System.String |
actionComplete |
|
Returns
ActionFailure(String)
Triggers when a Kanban action gets failed or interrupted and an error information will be returned.
Declaration
public KanbanBuilder ActionFailure(string actionFailure)
Parameters
Type |
Name |
Description |
System.String |
actionFailure |
|
Returns
AllowDragAndDrop(Boolean)
Enables or disables the drag and drop actions in Kanban.
Declaration
public KanbanBuilder AllowDragAndDrop(bool allowDragAndDrop = true)
Parameters
Type |
Name |
Description |
System.Boolean |
allowDragAndDrop |
|
Returns
AllowKeyboard(Boolean)
When this property is set to true, it allows the keyboard interaction in Kanban.
Declaration
public KanbanBuilder AllowKeyboard(bool allowKeyboard = true)
Parameters
Type |
Name |
Description |
System.Boolean |
allowKeyboard |
|
Returns
CardClick(String)
Triggers on single-clicking the Kanban cards.
Declaration
public KanbanBuilder CardClick(string cardClick)
Parameters
Type |
Name |
Description |
System.String |
cardClick |
|
Returns
CardDoubleClick(String)
Triggers on double-clicking the Kanban cards.
Declaration
public KanbanBuilder CardDoubleClick(string cardDoubleClick)
Parameters
Type |
Name |
Description |
System.String |
cardDoubleClick |
|
Returns
CardHeight(String)
Sets the height
of the each card in the kanban.
The string type includes pixel.
When height
is set with specific pixel value, then the card will be rendered to that specified height.
In case, if auto
value is set, then the height of the card gets auto-adjusted based on the content.
Declaration
public KanbanBuilder CardHeight(string cardHeight)
Parameters
Type |
Name |
Description |
System.String |
cardHeight |
|
Returns
CardRendered(String)
Triggers before each card of the Kanban rendering on the page.
Declaration
public KanbanBuilder CardRendered(string cardRendered)
Parameters
Type |
Name |
Description |
System.String |
cardRendered |
|
Returns
CardSettings(KanbanCardSettings)
Defines the Kanban board related settings such as header field, content field, template,
show or hide header, and single or multiple selection.
Declaration
public KanbanBuilder CardSettings(KanbanCardSettings cardSettings)
Parameters
Returns
CardSettings(Action<KanbanCardSettingsBuilder>)
Declaration
public KanbanBuilder CardSettings(Action<KanbanCardSettingsBuilder> cardSettings)
Parameters
Returns
Columns(Action<KanbanColumnBuilder>)
Declaration
public KanbanBuilder Columns(Action<KanbanColumnBuilder> columns)
Parameters
Returns
Columns(List<KanbanColumn>)
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 KanbanBuilder Columns(List<KanbanColumn> columns)
Parameters
Type |
Name |
Description |
System.Collections.Generic.List<KanbanColumn> |
columns |
|
Returns
ConstraintType(ConstraintType)
Defines the constraint type used to apply validation based on column or swimlane. The possible values are:
Column
Swimlane
Declaration
public KanbanBuilder ConstraintType(ConstraintType constraintType)
Parameters
Returns
Created(String)
Triggers after the kanban board is created.
Declaration
public KanbanBuilder Created(string created)
Parameters
Type |
Name |
Description |
System.String |
created |
|
Returns
CssClass(String)
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 KanbanBuilder CssClass(string cssClass)
Parameters
Type |
Name |
Description |
System.String |
cssClass |
|
Returns
DataBinding(String)
Triggers before the data binds to the Kanban.
Declaration
public KanbanBuilder DataBinding(string dataBinding)
Parameters
Type |
Name |
Description |
System.String |
dataBinding |
|
Returns
DataBound(String)
Triggers once the event data is bound to the Kanban.
Declaration
public KanbanBuilder DataBound(string dataBound)
Parameters
Type |
Name |
Description |
System.String |
dataBound |
|
Returns
DataSource(Action<DataManagerBuilder>)
Declaration
public KanbanBuilder DataSource(Action<DataManagerBuilder> dataSource)
Parameters
Returns
DataSource(Object)
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 KanbanBuilder DataSource(object dataSource)
Parameters
Type |
Name |
Description |
System.Object |
dataSource |
|
Returns
DataSourceChanged(String)
Triggers when the grid data is added, deleted and updated.
Declaration
public KanbanBuilder DataSourceChanged(string dataSourceChanged)
Parameters
Type |
Name |
Description |
System.String |
dataSourceChanged |
|
Returns
DataStateChange(String)
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 KanbanBuilder DataStateChange(string dataStateChange)
Parameters
Type |
Name |
Description |
System.String |
dataStateChange |
|
Returns
DialogClose(String)
Triggers before the dialog closes.
Declaration
public KanbanBuilder DialogClose(string dialogClose)
Parameters
Type |
Name |
Description |
System.String |
dialogClose |
|
Returns
DialogOpen(String)
Triggers before the dialog opens.
Declaration
public KanbanBuilder DialogOpen(string dialogOpen)
Parameters
Type |
Name |
Description |
System.String |
dialogOpen |
|
Returns
DialogSettings(KanbanDialogSettings)
Defines the dialog settings such as template and fields.
Declaration
public KanbanBuilder DialogSettings(KanbanDialogSettings dialogSettings)
Parameters
Returns
DialogSettings(Action<KanbanDialogSettingsBuilder>)
Declaration
public KanbanBuilder DialogSettings(Action<KanbanDialogSettingsBuilder> dialogSettings)
Parameters
Returns
Drag(String)
Triggers when the card is dragging to other stage or other swimlane.
Declaration
public KanbanBuilder Drag(string drag)
Parameters
Type |
Name |
Description |
System.String |
drag |
|
Returns
DragStart(String)
Triggers when the card drag actions starts.
Declaration
public KanbanBuilder DragStart(string dragStart)
Parameters
Type |
Name |
Description |
System.String |
dragStart |
|
Returns
DragStop(String)
Triggers when the card drag actions stops.
Declaration
public KanbanBuilder DragStop(string dragStop)
Parameters
Type |
Name |
Description |
System.String |
dragStop |
|
Returns
EnableHtmlSanitizer(Boolean)
Determine whether to prevent cross-site scripting code in Kanban data entry fields.
Declaration
public KanbanBuilder EnableHtmlSanitizer(bool enableHtmlSanitizer = true)
Parameters
Type |
Name |
Description |
System.Boolean |
enableHtmlSanitizer |
|
Returns
EnablePersistence(Boolean)
Enables or disables the persisting Kanban board's state between page reloads.
If enabled, columns, dataSource properties will be persisted in kanban.
Declaration
public KanbanBuilder EnablePersistence(bool enablePersistence = true)
Parameters
Type |
Name |
Description |
System.Boolean |
enablePersistence |
|
Returns
EnableRtl(Boolean)
Enable or disable rendering component in right to left direction.
Declaration
public KanbanBuilder EnableRtl(bool enableRtl = true)
Parameters
Type |
Name |
Description |
System.Boolean |
enableRtl |
|
Returns
Enables or disables the tooltip in Kanban board. The property relates to the tooltipTemplate property.
Declaration
public KanbanBuilder EnableTooltip(bool enableTooltip = true)
Parameters
Type |
Name |
Description |
System.Boolean |
enableTooltip |
|
Returns
EnableVirtualization(Boolean)
When the enableVirtualization property is set to true in a Kanban,
it will only render the cards that are currently visible within the viewport,
and will load additional cards as the user scrolls vertically through the Kanban.
This can be helpful for improving the performance of the Kanban when working with large datasets,
as it reduces the number of elements that need to be rendered and managed by the browser at any given time.
Declaration
public KanbanBuilder EnableVirtualization(bool enableVirtualization = true)
Parameters
Type |
Name |
Description |
System.Boolean |
enableVirtualization |
|
Returns
ExternalDropId(String[])
Defines the ID of drop Kanban on which drop should occur.
Declaration
public KanbanBuilder ExternalDropId(string[] externalDropId)
Parameters
Type |
Name |
Description |
System.String[] |
externalDropId |
|
Returns
Height(Double)
Sets the height
of the Kanban board, 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 KanbanBuilder Height(double height)
Parameters
Type |
Name |
Description |
System.Double |
height |
|
Returns
Height(String)
Sets the height
of the Kanban board, 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 KanbanBuilder Height(string height)
Parameters
Type |
Name |
Description |
System.String |
height |
|
Returns
HtmlAttributes(Object)
Allows additional HTML attributes such as title, name, etc., and
accepts n number of attributes in a key-value pair format.
Declaration
public KanbanBuilder HtmlAttributes(object htmlAttributes)
Parameters
Type |
Name |
Description |
System.Object |
htmlAttributes |
|
Returns
KeyField(String)
Defines the key field of Kanban board. The Kanban renders its layout based on this key field.
Declaration
public KanbanBuilder KeyField(string keyField)
Parameters
Type |
Name |
Description |
System.String |
keyField |
|
Returns
Locale(String)
Overrides the global culture and localization value for this component. Default global culture is 'en-US'.
Declaration
public KanbanBuilder Locale(string locale)
Parameters
Type |
Name |
Description |
System.String |
locale |
|
Returns
Query(String)
Defines the external query
that will be executed along with the data processing.
Declaration
public KanbanBuilder Query(string query)
Parameters
Type |
Name |
Description |
System.String |
query |
|
Returns
QueryCellInfo(String)
Triggers before each column of the Kanban rendering on the page.
Declaration
public KanbanBuilder QueryCellInfo(string queryCellInfo)
Parameters
Type |
Name |
Description |
System.String |
queryCellInfo |
|
Returns
Render()
Declaration
public HtmlString Render()
Returns
Type |
Description |
Microsoft.AspNetCore.Html.HtmlString |
|
ShowEmptyColumn(Boolean)
Enable or disable the columns when empty dataSource.
Declaration
public KanbanBuilder ShowEmptyColumn(bool showEmptyColumn = true)
Parameters
Type |
Name |
Description |
System.Boolean |
showEmptyColumn |
|
Returns
SortSettings(KanbanSortSettings)
Defines the sort settings such as field and direction.
Declaration
public KanbanBuilder SortSettings(KanbanSortSettings sortSettings)
Parameters
Returns
SortSettings(Action<KanbanSortSettingsBuilder>)
Declaration
public KanbanBuilder SortSettings(Action<KanbanSortSettingsBuilder> sortSettings)
Parameters
Returns
Declaration
public KanbanBuilder StackedHeaders(Action<KanbanStackedHeaderBuilder> stackedHeaders)
Parameters
Returns
Defines the stacked header for Kanban columns with text and key fields.
Declaration
public KanbanBuilder StackedHeaders(List<KanbanStackedHeader> stackedHeaders)
Parameters
Returns
SwimlaneSettings(KanbanSwimlaneSettings)
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 KanbanBuilder SwimlaneSettings(KanbanSwimlaneSettings swimlaneSettings)
Parameters
Returns
SwimlaneSettings(Action<KanbanSwimlaneSettingsBuilder>)
Declaration
public KanbanBuilder SwimlaneSettings(Action<KanbanSwimlaneSettingsBuilder> swimlaneSettings)
Parameters
Returns
Defines the template content to card’s tooltip. The property works by enabling the ‘enableTooltip’ property.
Declaration
public KanbanBuilder TooltipTemplate(string tooltipTemplate)
Parameters
Type |
Name |
Description |
System.String |
tooltipTemplate |
|
Returns
Width(Double)
Sets the width
of the Kanban board, 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 KanbanBuilder Width(double width)
Parameters
Type |
Name |
Description |
System.Double |
width |
|
Returns
Width(String)
Sets the width
of the Kanban board, 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 KanbanBuilder Width(string width)
Parameters
Type |
Name |
Description |
System.String |
width |
|
Returns