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

SplitterPaneBuilder

Class

Defines the fluent interface for configuring the splitter panes (SplitterPane).

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:

public class SplitterPaneBuilder

Inheritance: objectSplitterPaneBuilder

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

Constructors

SplitterPaneBuilder(SplitterPane, ViewContext)

public SplitterPaneBuilder(SplitterPane pane, ViewContext viewContext)

Parameters:paneSplitterPaneviewContextViewContext

Methods

Collapsed(bool)

Sets whether the pane is initially collapsed.

public SplitterPaneBuilder Collapsed(bool isCollapsed)

Parameters:isCollapsedbool

Whether the pane will be initially collapsed.

Returns:

SplitterPaneBuilder

Example:

@( Html.Kendo().Splitter()
.Name("Splitter")
.Panes(panes =&gt;
{
panes.Add().Collapsed(true);
})
)

CollapsedSize(string)

Sets the pane size while collapsed.

public SplitterPaneBuilder CollapsedSize(string collapsedSize)

Parameters:collapsedSizestring

The desired size. Only sizes in pixels and percentages are allowed.

Returns:

SplitterPaneBuilder

Example:

@( Html.Kendo().Splitter()
.Name("Splitter")
.Panes(panes =&gt;
{
panes.Add().CollapsedSize("220px");
})
)

Collapsible(bool)

Sets whether the pane can be collapsed by the user.

public SplitterPaneBuilder Collapsible(bool isCollapsible)

Parameters:isCollapsiblebool

Whether the pane can be collapsed by the user.

Returns:

SplitterPaneBuilder

Example:

@( Html.Kendo().Splitter()
.Name("Splitter")
.Panes(panes =&gt;
{
panes.Add().Collapsible(true);
})
)

Content(Action)

Sets the HTML content of the pane.

public SplitterPaneBuilder Content(Action content)

Parameters:contentAction

The action which renders the HTML content.

Returns:

SplitterPaneBuilder

Example:

@(  Html.Kendo().Splitter()
.Name("Splitter")
.Panes(panes =&gt;
{
panes.Add()
.Content(() =&gt; { &gt;%
&lt;p&gt;Content&lt;/p&gt;
%&lt;});
})
.Render();
)

Content(Func<object, object>)

Sets the HTML content of the pane.

public SplitterPaneBuilder Content(Func<object, object> content)

Parameters:contentFunc<object, object>

The Razor template for the HTML content.

Returns:

SplitterPaneBuilder

Example:

@(Html.Kendo().Splitter()
.Name("Splitter")
.Panes(panes =&gt;
{
panes.Add()
.Content(@&lt;p&gt;Content&lt;/p&gt;);
})
.Render();)

Content(string)

Sets the HTML content of the pane.

public SplitterPaneBuilder Content(string content)

Parameters:contentstring

The HTML content.

Returns:

SplitterPaneBuilder

Example:

@( Html.Kendo().Splitter()
.Name("Splitter")
.Panes(panes =&gt;
{
panes.Add()
.Content("&lt;p&gt;Content&lt;/p&gt;");
})
)

HtmlAttributes(IDictionary<string, object>)

Sets the HTML attributes applied to the outer HTML element rendered for the item

public SplitterPaneBuilder HtmlAttributes(IDictionary<string, object> attributes)

Parameters:attributesIDictionary<string, object>

The attributes.

Returns:

SplitterPaneBuilder

HtmlAttributes(object)

Sets the HTML attributes applied to the outer HTML element rendered for the item

public SplitterPaneBuilder HtmlAttributes(object attributes)

Parameters:attributesobject

The attributes.

Returns:

SplitterPaneBuilder

Example:

@( Html.Kendo().Splitter()
.Name("Splitter")
.Panes(panes =&gt;
{
panes.Add().HtmlAttributes(new { style = "background: red" });
})
)

Label(string)

The label of the current pane. Will be used as a aria-label for the Splitter separator that has the pane as its primary one (the separator that is immediately after the pane).

public SplitterPaneBuilder Label(string label)

Parameters:labelstring

The label text.

Returns:

SplitterPaneBuilder

Example:

@( Html.Kendo().Splitter()
.Name("Splitter")
.Panes(panes =&gt; {
panes.Add()
.Label("pane name")
})
)

The ID of the element that should be used as a label of the current pane. Will be used as a value of the aria-labelledby attribute for the Splitter separator that has the pane as its primary one (the separator that is immediately after the pane).

public SplitterPaneBuilder LabelId(string labelId)

Parameters:labelIdstring

The "id" attribute of the label element.

Returns:

SplitterPaneBuilder

Example:

@( Html.Kendo().Splitter()
.Name("Splitter")
.Panes(panes =&gt; {
panes.Add()
.LabelId("label_Id")
})
)

LoadContentFrom(RouteValueDictionary)

Sets the Url which will be requested to return the pane content.

public SplitterPaneBuilder LoadContentFrom(RouteValueDictionary routeValues)

Parameters:routeValuesRouteValueDictionary

The route values of the Action method.

Returns:

SplitterPaneBuilder

Example:

@( Html.Kendo().Splitter()
.Name("Splitter")
.Panes(panes =&gt; {
panes.Add()
.LoadContentFrom(MVC.Home.Index().GetRouteValueDictionary());
})
)

LoadContentFrom(string, string, object)

Sets the Url, which will be requested to return the content.

public SplitterPaneBuilder LoadContentFrom(string actionName, string controllerName, object routeValues)

Parameters:actionNamestring

The action name.

controllerNamestring

The controller name.

routeValuesobject

Route values.

Returns:

SplitterPaneBuilder

Example:

@( Html.Kendo().Splitter()
.Name("Splitter")
.Panes(panes =&gt; {
panes.Add()
.LoadContentFrom("AjaxView_OpenSource", "Splitter", new { id = 10 });
})
)

LoadContentFrom(string, string, RouteValueDictionary)

Sets the Url, which will be requested to return the pane content.

public SplitterPaneBuilder LoadContentFrom(string actionName, string controllerName, RouteValueDictionary routeValues)

Parameters:actionNamestringcontrollerNamestringrouteValuesRouteValueDictionaryReturns:

SplitterPaneBuilder

LoadContentFrom(string, string)

Sets the Url, which will be requested to return the pane content.

public SplitterPaneBuilder LoadContentFrom(string actionName, string controllerName)

Parameters:actionNamestring

The action name.

controllerNamestring

The controller name.

Returns:

SplitterPaneBuilder

Example:

@( Html.Kendo().Splitter()
.Name("Splitter")
.Panes(panes =&gt; {
panes.Add()
.LoadContentFrom("AjaxView_OpenSource", "Splitter");
})
)

LoadContentFrom(string)

Sets the Url, which will be requested to return the pane content.

public SplitterPaneBuilder LoadContentFrom(string value)

Parameters:valuestring

The url.

Returns:

SplitterPaneBuilder

Example:

@( Html.Kendo().Splitter()
.Name("Splitter")
.Panes(panes =&gt; {
panes.Add()
.LoadContentFrom(Url.Action("AjaxView_OpenSource", "Splitter"));
})
)

MaxSize(string)

Sets the maximum pane size.

public SplitterPaneBuilder MaxSize(string size)

Parameters:sizestring

The desired maximum size. Only sizes in pixels and percentages are allowed.

Returns:

SplitterPaneBuilder

Example:

@( Html.Kendo().Splitter()
.Name("Splitter")
.Panes(panes =&gt;
{
panes.Add().MaxSize("220px");
})
)

MinSize(string)

Sets the minimum pane size.

public SplitterPaneBuilder MinSize(string size)

Parameters:sizestring

The desired minimum size. Only sizes in pixels and percentages are allowed.

Returns:

SplitterPaneBuilder

Example:

@( Html.Kendo().Splitter()
.Name("Splitter")
.Panes(panes =&gt;
{
panes.Add().MinSize("220px");
})
)

Resizable(bool)

Sets whether the pane can be resized by the user.

public SplitterPaneBuilder Resizable(bool isResizable)

Parameters:isResizablebool

Whether the pane will be resizable.

Returns:

SplitterPaneBuilder

Example:

@( Html.Kendo().Splitter()
.Name("Splitter")
.Panes(panes =&gt;
{
panes.Add().Resizable(true);
})
)

Scrollable(bool)

Sets whether the pane shows a scrollbar when its content overflows.

public SplitterPaneBuilder Scrollable(bool isScrollable)

Parameters:isScrollablebool

Whether the pane will be scrollable.

Returns:

SplitterPaneBuilder

Example:

@( Html.Kendo().Splitter()
.Name("Splitter")
.Panes(panes =&gt;
{
panes.Add().Scrollable(false);
})
)

Size(string)

Sets the pane size.

public SplitterPaneBuilder Size(string size)

Parameters:sizestring

The desired size. Only sizes in pixels and percentages are allowed.

Returns:

SplitterPaneBuilder

Example:

@( Html.Kendo().Splitter()
.Name("Splitter")
.Panes(panes =&gt;
{
panes.Add().Size("220px");
})
)