TaskBoardBuilder
Properties
WriteAction - Func
Methods
BindTo(System.Collections.Generic.IEnumerable)
Binds the TaskBoard Cards to a list of objects
Parameters
dataSource - System.Collections.Generic.IEnumerable<TCard>
The data source.
RETURNS
The current instance of the TaskBoardBuilder.
Example
@model IEnumerable<Card>
@(Html.Kendo().TaskBoard<Card>()
.Name("taskBoard")
.BindTo(Model)
)
BindTo(System.Collections.IEnumerable)
Binds the TaskBoard Cards to a list of objects
Parameters
dataSource - System.Collections.IEnumerable
The data source.
RETURNS
The current instance of the TaskBoardBuilder.
Example
@model IEnumerable<Card>
@(Html.Kendo().TaskBoard()
.Name("taskBoard")
.BindTo(Model)
)
DataSource(System.Action)
Sets the data source configuration of the TaskBoard.
Parameters
configurator - System.Action<DataSourceBuilder>
The lambda which configures the data source
RETURNS
The current instance of the TaskBoardBuilder.
Example
@(Html.Kendo().TaskBoard<Product>()
.Name("TaskBoard")
.DataSource(dataSource =>
// configure the data source
dataSource
.Ajax()
.Read(read => read.Action("Products_Read", "Home"))
)
)
DataSource(System.String)
Sets the ID of the DataSource widget used by the TaskBoard.
Parameters
dataSourceId - System.String
The name of the DataSource
RETURNS
The current instance of the TaskBoardBuilder.
Example
@(Html.Kendo().TaskBoard<Product>()
.Name("TaskBoard")
.DataSource("dataSource1")
)
@(Html.Kendo().DataSource<Product>()
.Name("dataSource1")
.Ajax(ds=>ds
.Read(read => read.Action("Products_Read", "Home"))
.PageSize(20)
)
)
Columns(System.Collections.Generic.IEnumerable)
Binds the TaskBoard Columns to a list of objects
Parameters
dataSource - System.Collections.Generic.IEnumerable<TColumn>
The data source.
RETURNS
The current instance of the TaskBoardBuilder.
Example
@(Html.Kendo().TaskBoard<Card, Column>()
.Name("taskBoard")
.Columns(new List<Column>
{
new Column { Status = "Status", Text = "Text"}
})
)
Columns(System.Collections.IEnumerable)
Binds the TaskBoard Columns to a list of objects
Parameters
dataSource - System.Collections.IEnumerable
The data source.
RETURNS
The current instance of the TaskBoardBuilder.
Example
@(Html.Kendo().TaskBoard()
.Name("taskBoard")
.Columns(new List<object>
{
new { Status = "Status", Text = "Text"}
})
)
Columns(System.Action)
Sets the data source configuration of the TaskBoard's Columns.
Parameters
configurator - System.Action<DataSourceBuilder>
The lambda which configures the data source
RETURNS
The current instance of the TaskBoardBuilder.
Example
@(Html.Kendo().TaskBoard<Product>()
.Name("TaskBoard")
.Columns(dataSource =>
// configure the data source
dataSource
.Ajax()
.Read(read => read.Action("Products_Read", "Home"))
)
)
ColumnsId(System.String)
Sets the ID of the DataSource widget used by the TaskBoard Columns.
Parameters
dataSourceId - System.String
The name of the DataSource
RETURNS
The current instance of the TaskBoardBuilder.
Example
@(Html.Kendo().TaskBoard<Product>()
.Name("TaskBoard")
.Columns("dataSource1")
)
@(Html.Kendo().DataSource<Product>()
.Name("dataSource1")
.Ajax(ds=>ds
.Read(read => read.Action("Products_Read", "Home"))
.PageSize(20)
)
)
Columns(System.Action)
Sets the data source configuration of the TaskBoard's Columns.
Parameters
configurator - System.Action<TaskBoardColumnsBuilder>
The lambda which configures the data source
RETURNS
The current instance of the TaskBoardBuilder.
Example
@(Html.Kendo().TaskBoard<Product>()
.Name("TaskBoard")
.Columns(dataSource =>
// configure the data source
dataSource
.Ajax()
.Read(read => read.Action("Products_Read", "Home"))
)
)
Toolbar(System.Action)
Configures the Tools of the TaskBoard
Parameters
configurator - System.Action<TaskBoardToolbarSettingsBuilder>
The configurator for the toolbar setting.
RETURNS
The current instance of the TaskBoardBuilder.
Toolbar(System.Boolean)
Configures the Tools of the TaskBoard
Parameters
enabled - System.Boolean
Enables or disables the toolbar option.
RETURNS
The current instance of the TaskBoardBuilder.
AutoBind(System.Boolean)
Controls whether to bind the TaskBoard to the data source on initialization.
Parameters
value - System.Boolean
The value for AutoBind
RETURNS
Returns the current TaskBoardBuilder instance.
CardMenu(System.Action)
Defines the list of buttons rendered in the card.
Parameters
configurator - System.Action<TaskBoardCardMenuFactory>
The configurator for the cardmenu setting.
RETURNS
Returns the current instance of TaskBoardBuilder .
ColumnSettings(System.Action)
Defines the settings for the columns.
Parameters
configurator - System.Action<TaskBoardColumnSettingsSettingsBuilder>
The configurator for the columnsettings setting.
RETURNS
Returns the current instance of TaskBoardBuilder .
DataOrderField(System.String)
The field used to order cards (number based). If not set, cards will be rendered in the order they are fetched. And ordering will not be applied to the DataSource and respectively, not synced with the remote data source.
Parameters
value - System.String
The value for DataOrderField
RETURNS
Returns the current TaskBoardBuilder instance.
DataCategoryField(System.String)
The category field of the card.
Parameters
value - System.String
The value for DataCategoryField
RETURNS
Returns the current TaskBoardBuilder instance.
DataDescriptionField(System.String)
The description field of the card.
Parameters
value - System.String
The value for DataDescriptionField
RETURNS
Returns the current TaskBoardBuilder instance.
DataStatusField(System.String)
The field of the data item that provides the status of the card. Mapped with the status of the columns.
Parameters
value - System.String
The value for DataStatusField
RETURNS
Returns the current TaskBoardBuilder instance.
DataTitleField(System.String)
The title field of the card.
Parameters
value - System.String
The value for DataTitleField
RETURNS
Returns the current TaskBoardBuilder instance.
Editable(System.Action)
Toggles the editing in the TaskBoard. Both for columns and cards.
Parameters
configurator - System.Action<TaskBoardEditableSettingsBuilder>
The configurator for the editable setting.
RETURNS
Returns the current instance of TaskBoardBuilder .
Editable(System.Boolean)
Toggles the editing in the TaskBoard. Both for columns and cards.
Parameters
enabled - System.Boolean
Enables or disables the editable option.
RETURNS
Returns the current instance of TaskBoardEditableSettingsBuilder .
Height(System.String)
Configures the height of the TaskBoard wrapper.
Parameters
value - System.String
The value for Height
RETURNS
Returns the current TaskBoardBuilder instance.
PreviewPane(System.Action)
Toggles the previewPane in the TaskBoard.
Parameters
configurator - System.Action<TaskBoardPreviewPaneSettingsBuilder>
The configurator for the previewpane setting.
RETURNS
Returns the current instance of TaskBoardBuilder .
PreviewPane(System.Boolean)
Toggles the previewPane in the TaskBoard.
Parameters
enabled - System.Boolean
Enables or disables the previewpane option.
RETURNS
Returns the current instance of TaskBoardPreviewPaneSettingsBuilder .
Reorderable(System.Boolean)
Toggles the reordering of cards in the TaskBoard.
Parameters
value - System.Boolean
The value for Reorderable
RETURNS
Returns the current TaskBoardBuilder instance.
Resources(System.Action)
The configuration of the TaskBoard resource(s). A TaskBoard resource is optional metadata that can be associated with a TaskBoard event.
Parameters
configurator - System.Action<TaskBoardResourceFactory>
The configurator for the resources setting.
RETURNS
Returns the current instance of TaskBoardBuilder .
Selectable(System.Boolean)
Toggles the selection of the TaskBoard.
Parameters
value - System.Boolean
The value for Selectable
RETURNS
Returns the current TaskBoardBuilder instance.
Template(System.String)
Controls the rendering of the card.
Parameters
value - System.String
The value for Template
RETURNS
Returns the current TaskBoardBuilder instance.
TemplateId(System.String)
Controls the rendering of the card.
Parameters
templateId - System.String
The ID of the template element for Template
RETURNS
Returns the current TaskBoardBuilder instance.
TemplateView(Microsoft.AspNetCore.Html.IHtmlContent)
Controls the rendering of the card.
Parameters
templateView - Microsoft.AspNetCore.Html.IHtmlContent
The view that contains the template for Template
RETURNS
Returns the current TaskBoardBuilder instance.
TemplateHandler(System.String)
Controls the rendering of the card.
Parameters
templateHandler - System.String
The handler that returs the template for Template
RETURNS
Returns the current TaskBoardBuilder instance.
Template(Kendo.Mvc.UI.Fluent.TemplateBuilder)
Controls the rendering of the card.
Parameters
template - TemplateBuilder<TModel>
A Template component that configures the template.
RETURNS
Returns the current TaskBoardBuilder instance.
Width(System.String)
Configures the width of the TaskBoard wrapper.
Parameters
value - System.String
The value for Width
RETURNS
Returns the current TaskBoardBuilder instance.
Messages(System.Action)
Provides configuration options for the messages present in the TaskBoard widget.
Parameters
configurator - System.Action<TaskBoardMessagesSettingsBuilder>
The configurator for the messages setting.
RETURNS
Returns the current instance of TaskBoardBuilder .
Events(System.Action)
Configures the client-side events.
Parameters
configurator - System.Action<TaskBoardEventBuilder>
The client events action.
RETURNS
Returns the current TaskBoardBuilder instance.
Example
@(Html.Kendo().TaskBoard()
.Name("TaskBoard")
.Events(events => events
.ColumnsDataBinding("onColumnsDataBinding")
)
)
ToComponent()
Returns the internal view component.
RETURNS
The instance that represents the component.
Expression(System.String)
Sets the name of the component.
Parameters
modelExpression - System.String
RETURNS
Returns the current instance.
Explorer(Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer)
Sets the name of the component.
Parameters
modelExplorer - Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer
RETURNS
Returns the current instance.
Name(System.String)
Sets the name of the component.
Parameters
componentName - System.String
The name.
RETURNS
Returns the current instance.
Deferred(System.Boolean)
Suppress initialization script rendering. Note that this options should be used in conjunction with
Parameters
deferred - System.Boolean
RETURNS
Returns a DeferredWidgetBuilder instance.
HtmlAttributes(System.Object)
Sets the HTML attributes.
Parameters
attributes - System.Object
The HTML attributes.
RETURNS
Returns the current instance.
HtmlAttributes(System.Collections.Generic.IDictionary)
Sets the HTML attributes.
Parameters
attributes - System.Collections.Generic.IDictionary<String,Object>
The HTML attributes.
RETURNS
Returns the current instance.
ScriptAttributes(System.Object,System.Boolean)
Sets the JavaScript attributes to the initialization script.
Parameters
attributes - System.Object
The JavaScript attributes.
overrideAttributes - System.Boolean
Argument which determines whether attributes should be overriden.
RETURNS
Returns the current instance.
ScriptAttributes(System.Collections.Generic.IDictionary,System.Boolean)
Sets the JavaScript attributes to the initialization script.
Parameters
attributes - System.Collections.Generic.IDictionary<String,Object>
The JavaScript attributes.
overrideAttributes - System.Boolean
Argument which determines whether attributes should be overriden.
RETURNS
Returns the current instance.
Render()
Renders the component in place.
ToHtmlString()
Returns the HTML representation of the component.
WriteTo(System.IO.TextWriter,System.Text.Encodings.Web.HtmlEncoder)
Parameters
writer - System.IO.TextWriter
encoder - System.Text.Encodings.Web.HtmlEncoder
ToClientTemplate()
Returns the client template for the component.
AsModule(System.Boolean)
Specifies whether the initialization script of the component will be rendered as a JavaScript module.
Parameters
value - System.Boolean
RETURNS
Returns the current instance.