DockManagerRootPaneSettingsPaneBuilder

Methods

Panes(System.Action)

An array of pane definitions.

RETURNS

A DockManagerRootPaneSettingsPaneBuilder instance for method chaining.

ContentView(Microsoft.AspNetCore.Html.IHtmlContent)

Defines the content of the pane. The option is available only for panes of type "Content".

Parameters

templateView - `Microsoft.AspNetCore.Html.IHtmlContent`

The Razor View that contains the content of the pane.

RETURNS

A DockManagerRootPaneSettingsPaneBuilder instance for method chaining.

Example

Razor

 
            @(Html.Kendo().DockManager()
               .Name("dockManager")
               .RootPane(root =>
               {
                   root.Id("root").Type(RootPaneType.Split).Orientation(DockSplitterOrientation.Vertical).Panes(panes =>
                   {
                       panes.Add().Type(PaneType.Content).Title("Console")
                            .ContentView(Html.Partial("ConsolePaneView"))
                            .Id("console");
                   });
               })
            )

ContentTemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)

Defines the content of the pane. The option is available only for panes of type "Content".

Parameters

template - TemplateBuilder<TModel>

A Template component that configures the pane's content.

RETURNS

A DockManagerRootPaneSettingsPaneBuilder instance for method chaining.

Example

Razor

 
            @(Html.Kendo().DockManager()
               .Name("dockManager")
               .RootPane(root =>
               {
                   root.Id("root").Type(RootPaneType.Split).Orientation(DockSplitterOrientation.Vertical).Panes(panes =>
                   {
                       panes.Add().Type(PaneType.Content).Title("Console")
                            .ContentTemplate(Html.Kendo().Template().AddHtml("<span>Console content</span>"))
                            .Id("console");
                   });
               })
            )

HeaderView(Microsoft.AspNetCore.Html.IHtmlContent)

Defines the template that will render the content of the header. By default, the same content is displayed in the tab when the pane is unpinned or within a pane of type tab. If the header is not specified, the Title will be displayed. The HeaderTemplate is available only for panes of type "Content".

Parameters

templateView - `Microsoft.AspNetCore.Html.IHtmlContent`

The Razor View that contains the content of the header.

RETURNS

A DockManagerRootPaneSettingsPaneBuilder instance for method chaining.

Example

Razor

 
            @(Html.Kendo().DockManager()
               .Name("dockManager")
               .RootPane(root =>
               {
                   root.Id("root").Type(RootPaneType.Split).Orientation(DockSplitterOrientation.Vertical).Panes(panes =>
                   {
                       panes.Add().Type(PaneType.Content).Title("Console")
                            .HeaderView(Html.Partial("HeaderView"))
                            .Content("Console content")
                            .Id("console");
                   });
               })
            )

HeaderTemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)

Parameters

template - TemplateBuilder<TModel>

A Template component that configures the header content.

RETURNS

A DockManagerRootPaneSettingsPaneBuilder instance for method chaining.

Example

Razor

 
            @(Html.Kendo().DockManager()
               .Name("dockManager")
               .RootPane(root =>
               {
                   root.Id("root").Type(RootPaneType.Split).Orientation(DockSplitterOrientation.Vertical).Panes(panes =>
                   {
                       panes.Add().Type(PaneType.Content).Title("Console")
                            .HeaderTemplate(Html.Kendo().Template().AddHtml("<span>PaneHeader</span>"))
                            .Content("Console content")
                            .Id("console");
                   });
               })
            )

TabHeaderView(Microsoft.AspNetCore.Html.IHtmlContent)

Defines the template that will render the content of the tab header when the pane is unpinned or within a tab pane. If the tab header is not specified, the header's content will be displayed. The TabHeaderTemplate is available only for panes of type "Content".

Parameters

templateView - `Microsoft.AspNetCore.Html.IHtmlContent`

The Razor View that contains the content of the tab header.

RETURNS

A DockManagerRootPaneSettingsPaneBuilder instance for method chaining.

Example

Razor

 
            @(Html.Kendo().DockManager()
               .Name("dockManager")
               .RootPane(root =>
               {
                   root.Id("root").Type(RootPaneType.Split).Orientation(DockSplitterOrientation.Vertical).Panes(panes =>
                   {
                       panes.Add().Type(PaneType.Content).Title("Console")
                            .TabHeaderView(Html.Partial("TabHeaderView"))
                            .Content("Console content")
                            .Id("console");
                   });
               })
            )

TabHeaderTemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)

Parameters

template - TemplateBuilder<TModel>

A Template component that configures the content of the tab header.

RETURNS

A DockManagerRootPaneSettingsPaneBuilder instance for method chaining.

Example

Razor

 
            @(Html.Kendo().DockManager()
               .Name("dockManager")
               .RootPane(root =>
               {
                   root.Id("root").Type(RootPaneType.Split).Orientation(DockSplitterOrientation.Vertical).Panes(panes =>
                   {
                       panes.Add().Type(PaneType.Content).Title("Console")
                            .TabHeaderTemplate(Html.Kendo().Template().AddHtml("<span>PaneHeader</span>"))
                            .Content("Console content")
                            .Id("console");
                   });
               })
            )

Closeable(System.Boolean)

Specifies if the pane can be closed. Available only for panes of type content.

Parameters

value - `System.Boolean`

The value for Closeable

RETURNS

Returns the current DockManagerRootPaneSettingsPaneBuilder instance.

Content(System.String)

The content of the pane. Available only for panes of type content.

Parameters

value - `System.String`

The value for Content

RETURNS

Returns the current DockManagerRootPaneSettingsPaneBuilder instance.

ContentHandler(System.String)

The content of the pane. Available only for panes of type content.

Parameters

handler - `System.String`

The name of the JavaScript function that will be evaluated.

RETURNS

Returns the current DockManagerRootPaneSettingsPaneBuilder instance.

ContentHandler(System.Func)

The content of the pane. Available only for panes of type content.

Parameters

handler - `System.Func<Object,Object>`

The handler code wrapped in a text tag.

RETURNS

Returns the current DockManagerRootPaneSettingsPaneBuilder instance.

Dockable(System.Action)

Specifies if the pane can be docked and allow inner docking of other panes. Accepts boolean or object. Available only for panes of type content.

Parameters

configurator - System.Action<DockManagerRootPanePaneDockableSettingsBuilder>

The configurator for the dockable setting.

RETURNS

Returns the current instance of DockManagerRootPaneSettingsPaneBuilder .

Dockable(System.Boolean)

Specifies if the pane can be docked and allow inner docking of other panes. Accepts boolean or object. Available only for panes of type content.

Parameters

enabled - `System.Boolean`

Enables or disables the dockable option.

RETURNS

Returns the current instance of DockManagerRootPanePaneDockableSettingsBuilder .

Header(System.String)

Sets the content of the header. Accepts a string or a kendo template. By default, the same content is displayed in the tab when the pane is unpinned or within a pane of type tab. If not specified the title is displayed. Available only for panes of type content.

Parameters

value - `System.String`

The value for Header

RETURNS

Returns the current DockManagerRootPaneSettingsPaneBuilder instance.

HeaderHandler(System.String)

Parameters

handler - `System.String`

The name of the JavaScript function that will be evaluated.

RETURNS

Returns the current DockManagerRootPaneSettingsPaneBuilder instance.

HeaderHandler(System.Func)

Parameters

handler - `System.Func<Object,Object>`

The handler code wrapped in a text tag.

RETURNS

Returns the current DockManagerRootPaneSettingsPaneBuilder instance.

Id(System.String)

Defines the id of the pane

Parameters

value - `System.String`

The value for Id

RETURNS

Returns the current DockManagerRootPaneSettingsPaneBuilder instance.

Selected(System.Double)

Specifies the index of the initially selected tab. Available only for panes of type tab.

Parameters

value - `System.Double`

The value for Selected

RETURNS

Returns the current DockManagerRootPaneSettingsPaneBuilder instance.

Size(System.String)

Specifies the size of a pane defined as pixels (i.e. "200px") or as a percentage (i.e. "50%").

Parameters

value - `System.String`

The value for Size

RETURNS

Returns the current DockManagerRootPaneSettingsPaneBuilder instance.

TabHeader(System.String)

Sets the content of the tab when the pane is unpinned or within a tab pane. If not specified, header content is used. Available only for panes of type content.

Parameters

value - `System.String`

The value for TabHeader

RETURNS

Returns the current DockManagerRootPaneSettingsPaneBuilder instance.

TabHeaderHandler(System.String)

Sets the content of the tab when the pane is unpinned or within a tab pane. If not specified, header content is used. Available only for panes of type content.

Parameters

handler - `System.String`

The name of the JavaScript function that will be evaluated.

RETURNS

Returns the current DockManagerRootPaneSettingsPaneBuilder instance.

TabHeaderHandler(System.Func)

Sets the content of the tab when the pane is unpinned or within a tab pane. If not specified, header content is used. Available only for panes of type content.