Class KanbanColumnBuilder
Represents a class for KanbanColumnBuilder which includes header text, key, show add button, header template, allow drag and allow drop, etc.
Inheritance
Inherited Members
Namespace: Syncfusion.JavaScript
Assembly: Syncfusion.EJ.dll
Syntax
public class KanbanColumnBuilder
Constructors
KanbanColumnBuilder()
Initializes a new instance of the KanbanColumnBuilder class.
Declaration
public KanbanColumnBuilder()
KanbanColumnBuilder(Kanban)
Initializes a new instance of the KanbanColumnBuilder class.
Declaration
public KanbanColumnBuilder(Kanban kanban)
Parameters
Type | Name | Description |
---|---|---|
Kanban | kanban | The Kanban. |
Methods
Add()
It adds the current column value.
Declaration
public void Add()
AllowDrag(Boolean)
Gets or sets an object that indicates able to drag a card in specified column or not.
Declaration
public KanbanColumnBuilder AllowDrag(bool allowDrag)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | allowDrag | If set to |
Returns
Type | Description |
---|---|
KanbanColumnBuilder | KanbanColumnBuilder |
AllowDrop(Boolean)
Gets or sets an object that indicates able to drop a card in specified column or not.
Declaration
public KanbanColumnBuilder AllowDrop(bool allowDrop)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | allowDrop | If set to |
Returns
Type | Description |
---|---|
KanbanColumnBuilder | KanbanColumnBuilder |
Constraints(Action<ColumnConstraintsBuilder>)
It sets a value that indicates to define the min or max constraints for a particular column in the Kanban.
Declaration
public KanbanColumnBuilder Constraints(Action<ColumnConstraintsBuilder> constraints)
Parameters
Type | Name | Description |
---|---|---|
System.Action<ColumnConstraintsBuilder> | constraints | It displays the column based constraints validation |
Returns
Type | Description |
---|---|
KanbanColumnBuilder | KanbanColumnBuilder |
HeaderTemplate(String)
It sets a value that indicates to add the template within the header element of the particular column.
Declaration
public KanbanColumnBuilder HeaderTemplate(string headerTemplate)
Parameters
Type | Name | Description |
---|---|---|
System.String | headerTemplate | It accepts the string value and displays the headerTemplate for that column |
Returns
Type | Description |
---|---|
KanbanColumnBuilder | KanbanColumnBuilder |
HeaderText(String)
It sets the value that indicates to display the title of that particular column.
Declaration
public KanbanColumnBuilder HeaderText(string headerText)
Parameters
Type | Name | Description |
---|---|---|
System.String | headerText | It accepts the string value and displays the title for that column |
Returns
Type | Description |
---|---|
KanbanColumnBuilder | KanbanColumnBuilder |
IsCollapsed(Boolean)
It sets a value that indicates whether this column is collapsed in the Kanban.
Declaration
public KanbanColumnBuilder IsCollapsed(bool isCollapsed)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | isCollapsed | If set to |
Returns
Type | Description |
---|---|
KanbanColumnBuilder | KanbanColumnBuilder |
Key(Action<KanbanColumnKeyBuilder>)
Gets or sets an object that indicates to render the Kanban with specified columns key. It sets a value that indicates the rendering of cards for specified column based on given key.
Declaration
public KanbanColumnBuilder Key(Action<KanbanColumnKeyBuilder> key)
Parameters
Type | Name | Description |
---|---|---|
System.Action<KanbanColumnKeyBuilder> | key | It accepts the key as list of records through lambda expression |
Returns
Type | Description |
---|---|
KanbanColumnBuilder | KanbanColumnBuilder |
Key(List<String>)
Gets or sets an object that indicates to render the Kanban with specified columns key. It sets a value that indicates the rendering of cards for specified column based on given key.
Declaration
public KanbanColumnBuilder Key(List<string> key)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.List<System.String> | key | It accepts the key as List |
Returns
Type | Description |
---|---|
KanbanColumnBuilder | KanbanColumnBuilder |
Key(String)
Gets or sets an object that indicates to render the Kanban with specified columns key. It sets a value that indicates the rendering of cards for specified column based on given key.
Declaration
public KanbanColumnBuilder Key(string key)
Parameters
Type | Name | Description |
---|---|---|
System.String | key | It accepts the key as string |
Returns
Type | Description |
---|---|
KanbanColumnBuilder | KanbanColumnBuilder |
ShowAddButton(Boolean)
It sets the value that indicates to display the add new UI button of that particular column.
Declaration
public KanbanColumnBuilder ShowAddButton(bool showAddButton)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | showAddButton | If set to |
Returns
Type | Description |
---|---|
KanbanColumnBuilder | KanbanColumnBuilder |
TotalCount(Action<TotalCountBuilder>)
It sets a value that indicates to define the customization total count text for a particular column in the Kanban.
Declaration
public KanbanColumnBuilder TotalCount(Action<TotalCountBuilder> totalCount)
Parameters
Type | Name | Description |
---|---|---|
System.Action<TotalCountBuilder> | totalCount | It displays the column customization total count |
Returns
Type | Description |
---|---|
KanbanColumnBuilder | KanbanColumnBuilder |
Visible(Boolean)
It sets a value that indicates whether this column is visible in the Kanban.
Declaration
public KanbanColumnBuilder Visible(bool visible)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | visible | If set to |
Returns
Type | Description |
---|---|
KanbanColumnBuilder | KanbanColumnBuilder |
Width(Object)
It sets a value that indicates to define the width for a particular column in the Kanban.
Declaration
public KanbanColumnBuilder Width(object width)
Parameters
Type | Name | Description |
---|---|---|
System.Object | width | It displays the column based on the object value passed. |
Returns
Type | Description |
---|---|
KanbanColumnBuilder | KanbanColumnBuilder |