New to Telerik UI for ASP.NET MVC? Start a free 30-day trial

DockManagerRootPaneSettingsPaneBuilder

Class

Defines the fluent API for configuring the DockManagerRootPaneSettingsPane settings.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:

public class DockManagerRootPaneSettingsPaneBuilder

Inheritance: objectDockManagerRootPaneSettingsPaneBuilder

Inherited Members object.GetType()object.MemberwiseClone()object.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()...

Constructors

DockManagerRootPaneSettingsPaneBuilder(DockManagerRootPaneSettingsPane)

Initialize the DockManagerRootPaneSettingsPaneBuilder

public DockManagerRootPaneSettingsPaneBuilder(DockManagerRootPaneSettingsPane settings)

Parameters:settingsDockManagerRootPaneSettingsPane

The DockManagerRootPaneSettingsPane

Methods

Closeable(bool)

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

public DockManagerRootPaneSettingsPaneBuilder Closeable(bool value)

Parameters:valuebool

The value that configures the closeable.

Returns:

DockManagerRootPaneSettingsPaneBuilder

Content(string)

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

public DockManagerRootPaneSettingsPaneBuilder Content(string value)

Parameters:valuestring

The value that configures the content.

Returns:

DockManagerRootPaneSettingsPaneBuilder

ContentHandler(string)

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

public DockManagerRootPaneSettingsPaneBuilder ContentHandler(string value)

Parameters:valuestring

The JavaScript function that returns the content of the pane.

Returns:

DockManagerRootPaneSettingsPaneBuilder

Example:

@(Html.Kendo().DockManager()
.Name("dockManager")
.RootPane(root =&gt;
{
root.Id("root").Type(RootPaneType.Split).Orientation(DockSplitterOrientation.Vertical).Panes(panes =&gt;
{
panes.Add().Type(PaneType.Content).Title("Console")
.ContentHandler("getPaneContent")
.Id("console");
});
})
)

ContentTemplate<TModel>(TemplateBuilder<TModel>)

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

public DockManagerRootPaneSettingsPaneBuilder ContentTemplate<TModel>(TemplateBuilder<TModel> template)

Parameters:templateTemplateBuilder<TModel>

A Template component that configures the pane's content.

Returns:

DockManagerRootPaneSettingsPaneBuilder

Example:

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

ContentView(MvcHtmlString)

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

public DockManagerRootPaneSettingsPaneBuilder ContentView(MvcHtmlString templateView)

Parameters:templateViewMvcHtmlString

The Razor View that contains the content of the pane.

Returns:

DockManagerRootPaneSettingsPaneBuilder

Example:

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

Dockable(Action<DockManagerRootPanePaneDockableSettingsBuilder>)

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.

public DockManagerRootPaneSettingsPaneBuilder Dockable(Action<DockManagerRootPanePaneDockableSettingsBuilder> configurator)

Parameters:configuratorAction<DockManagerRootPanePaneDockableSettingsBuilder>

The action that configures the dockable.

Returns:

DockManagerRootPaneSettingsPaneBuilder

Dockable(bool)

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.

public DockManagerRootPaneSettingsPaneBuilder Dockable(bool enabled)

Parameters:enabledbool

Enables or disables the dockable option.

Returns:

DockManagerRootPaneSettingsPaneBuilder

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.

public DockManagerRootPaneSettingsPaneBuilder Header(string value)

Parameters:valuestring

The value that configures the header.

Returns:

DockManagerRootPaneSettingsPaneBuilder

HeaderHandler(string)

The content of the pane's header. Available only for panes of type "Content".

public DockManagerRootPaneSettingsPaneBuilder HeaderHandler(string value)

Parameters:valuestring

The JavaScript function that returns the content of the header.

Returns:

DockManagerRootPaneSettingsPaneBuilder

Example:

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

HeaderTemplate<TModel>(TemplateBuilder<TModel>)

Defines the template that will render the content of the pane's header. The option is available only for panes of type "Content".

public DockManagerRootPaneSettingsPaneBuilder HeaderTemplate<TModel>(TemplateBuilder<TModel> template)

Parameters:templateTemplateBuilder<TModel>

A Template component that configures the header's content template.

Returns:

DockManagerRootPaneSettingsPaneBuilder

Example:

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

HeaderView(MvcHtmlString)

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

public DockManagerRootPaneSettingsPaneBuilder HeaderView(MvcHtmlString templateView)

Parameters:templateViewMvcHtmlString

The Razor View that contains the content of the header.

Returns:

DockManagerRootPaneSettingsPaneBuilder

Example:

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

Id(string)

Defines the id of the pane

public DockManagerRootPaneSettingsPaneBuilder Id(string value)

Parameters:valuestring

The value that configures the id.

Returns:

DockManagerRootPaneSettingsPaneBuilder

Orientation(DockSplitterOrientation)

Sets the orientation of the pane splitter.

public DockManagerRootPaneSettingsPaneBuilder Orientation(DockSplitterOrientation value)

Parameters:valueDockSplitterOrientation

The value that configures the orientation.

Returns:

DockManagerRootPaneSettingsPaneBuilder

Panes(Action<DockManagerRootPaneSettingsPaneFactory>)

An array of pane definitions.

public DockManagerRootPaneSettingsPaneBuilder Panes(Action<DockManagerRootPaneSettingsPaneFactory> configurator)

Parameters:configuratorAction<DockManagerRootPaneSettingsPaneFactory>

The action that configures the panes.

Returns:

DockManagerRootPaneSettingsPaneBuilder

Selected(double)

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

public DockManagerRootPaneSettingsPaneBuilder Selected(double value)

Parameters:valuedouble

The value that configures the selected.

Returns:

DockManagerRootPaneSettingsPaneBuilder

Size(string)

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

public DockManagerRootPaneSettingsPaneBuilder Size(string value)

Parameters:valuestring

The value that configures the size.

Returns:

DockManagerRootPaneSettingsPaneBuilder

TabHeader(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.

public DockManagerRootPaneSettingsPaneBuilder TabHeader(string value)

Parameters:valuestring

The value that configures the tab's header.

Returns:

DockManagerRootPaneSettingsPaneBuilder

TabHeaderHandler(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".

public DockManagerRootPaneSettingsPaneBuilder TabHeaderHandler(string value)

Parameters:valuestring

The JavaScript function that returns the content of the tab.

Returns:

DockManagerRootPaneSettingsPaneBuilder

Example:

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

TabHeaderTemplate<TModel>(TemplateBuilder<TModel>)

Defines the template that will render 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".

public DockManagerRootPaneSettingsPaneBuilder TabHeaderTemplate<TModel>(TemplateBuilder<TModel> template)

Parameters:templateTemplateBuilder<TModel>

A Template component that configures the tab's content.

Returns:

DockManagerRootPaneSettingsPaneBuilder

Example:

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

TabHeaderView(MvcHtmlString)

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

public DockManagerRootPaneSettingsPaneBuilder TabHeaderView(MvcHtmlString templateView)

Parameters:templateViewMvcHtmlString

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

Returns:

DockManagerRootPaneSettingsPaneBuilder

Example:

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

Title(string)

Sets the title of the pane. Available only for panes of type content.

public DockManagerRootPaneSettingsPaneBuilder Title(string value)

Parameters:valuestring

The value that configures the title.

Returns:

DockManagerRootPaneSettingsPaneBuilder

Type(PaneType)

Sets the type of the pane.

public DockManagerRootPaneSettingsPaneBuilder Type(PaneType value)

Parameters:valuePaneType

The value that configures the type.

Returns:

DockManagerRootPaneSettingsPaneBuilder

Unpinnable(Action<DockManagerRootPanePaneUnpinnableSettingsBuilder>)

Specifies if the pane can be pinned/unpinnned. Available only for panes of type content.

public DockManagerRootPaneSettingsPaneBuilder Unpinnable(Action<DockManagerRootPanePaneUnpinnableSettingsBuilder> configurator)

Parameters:configuratorAction<DockManagerRootPanePaneUnpinnableSettingsBuilder>

The action that configures the unpinnable.

Returns:

DockManagerRootPaneSettingsPaneBuilder

Unpinnable(bool)

Specifies if the pane can be pinned/unpinnned. Available only for panes of type content.

public DockManagerRootPaneSettingsPaneBuilder Unpinnable(bool enabled)

Parameters:enabledbool

Enables or disables the unpinnable option.

Returns:

DockManagerRootPaneSettingsPaneBuilder

Visible(bool)

Specifies if the pane is initially visible.

public DockManagerRootPaneSettingsPaneBuilder Visible(bool value)

Parameters:valuebool

The value that configures the visible.

Returns:

DockManagerRootPaneSettingsPaneBuilder