Class SfSplitter

The splitter is a layout user interface (UI) component that splits the layout into multiple panes with resizable and collapsible support.

Inheritance
System.Object
SfBaseComponent
SfSplitter
Inherited Members
Namespace: Syncfusion.Blazor.Layouts
Assembly: Syncfusion.Blazor.dll
Syntax
public class SfSplitter : SfBaseComponent

Constructors

SfSplitter()

Declaration
public SfSplitter()

Properties

ChildContent

Sets the content for panes of the Splitter.

Declaration
public RenderFragment ChildContent { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.RenderFragment

CssClass

Specifies the CSS class names that defines specific user-defined styles and themes to be appended on the root element of the Splitter. It is used to customize the Splitter component. One or more custom CSS classes can be specified to the Splitter.

Declaration
public string CssClass { get; set; }
Property Value
Type Description
System.String

Enabled

Specifies a Boolean value that indicates whether the component is enabled or disabled.

Declaration
public bool Enabled { get; set; }
Property Value
Type Description
System.Boolean

EnablePersistence

Enables or disables the persisting component's state between page reloads. If enabled, the pane settings of Splitter is persisted.

Declaration
public bool EnablePersistence { get; set; }
Property Value
Type Description
System.Boolean

EnableReversePanes

Specifies the value whether splitter panes are reordered or not.

Declaration
public bool EnableReversePanes { get; set; }
Property Value
Type Description
System.Boolean

EnableRtl

Enable or disable rendering component in the right to left (RTL) direction.

Declaration
public bool EnableRtl { get; set; }
Property Value
Type Description
System.Boolean

Height

Specifies the height of the Splitter component.

Declaration
public string Height { get; set; }
Property Value
Type Description
System.String

HtmlAttributes

You can add the additional Html attributes such as id, title, etc., to the splitter element.

Declaration
public Dictionary<string, object> HtmlAttributes { get; set; }
Property Value
Type Description
System.Collections.Generic.Dictionary<System.String, System.Object>

ID

Specifies the unique identifier.

Declaration
public string ID { get; set; }
Property Value
Type Description
System.String

Orientation

Specifies a value that indicates whether to align the split panes horizontally or vertically. Set the orientation property as "Horizontal" to create a horizontal splitter that aligns the panes left-to-right. Set the orientation property as "Vertical" to create a vertical splitter that aligns the panes top-to-bottom.

Declaration
public Orientation Orientation { get; set; }
Property Value
Type Description
Orientation

PaneSettings

Configures the individual pane behaviors such as content, size, resizable, minimum, maximum validation, collapsible, and collapsed.

Declaration
public List<SplitterPane> PaneSettings { get; set; }
Property Value
Type Description
System.Collections.Generic.List<SplitterPane>

SeparatorSize

Declaration
public double SeparatorSize { get; set; }
Property Value
Type Description
System.Double

Width

Specifies the width of the Splitter component. The value can be either in pixel or percentage format.

Declaration
public string Width { get; set; }
Property Value
Type Description
System.String

Methods

AddPane(SplitterPane, Int32)

Allows you to add a pane dynamically to the specified index position by passing the pane properties.

Declaration
public void AddPane(SplitterPane paneProperties, int index)
Parameters
Type Name Description
SplitterPane paneProperties

Specifies the pane's properties that apply to new pane.
System.Int32 index

Specifies the index where the pane will be inserted.

AddPaneAsync(SplitterPane, Int32)

Allows you to add a pane dynamically to the specified index position by passing the pane properties.

Declaration
public Task AddPaneAsync(SplitterPane paneProperties, int index)
Parameters
Type Name Description
SplitterPane paneProperties

Specifies the pane's properties that apply to new pane.
System.Int32 index

Specifies the index where the pane will be inserted.
Returns
Type Description
System.Threading.Tasks.Task

A System.Threading.Tasks.Task representing any asynchronous operation.

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type Name Description
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder __builder

CollapseAsync(Double)

Collapses corresponding pane based on the index is passed.

Declaration
public Task CollapseAsync(double index)
Parameters
Type Name Description
System.Double index

Specifies the index value of the corresponding pane to be collapsed.
Returns
Type Description
System.Threading.Tasks.Task

A System.Threading.Tasks.Task representing any asynchronous operation.

ExpandAsync(Double)

Expands the corresponding pane based on the index is passed.

Declaration
public Task ExpandAsync(double index)
Parameters
Type Name Description
System.Double index

Specifies the index value of the corresponding pane to be Expanded.
Returns
Type Description
System.Threading.Tasks.Task

A System.Threading.Tasks.Task representing any asynchronous operation.

OnAfterRenderAsync(Boolean)

Method invoked after each time the component has been rendered.

Declaration
protected override Task OnAfterRenderAsync(bool firstRender)
Parameters
Type Name Description
System.Boolean firstRender

Set to true if this is the first time OnAfterRender(Boolean) has been invoked.
Returns
Type Description
System.Threading.Tasks.Task

A System.Threading.Tasks.Task representing any asynchronous operation.
Overrides

OnInitializedAsync()

Method invoked when the component is ready to start.

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
System.Threading.Tasks.Task

A System.Threading.Tasks.Task representing any asynchronous operation.
Overrides

OnParametersSetAsync()

Method invoked when the component has received parameters from its parent.

Declaration
protected override Task OnParametersSetAsync()
Returns
Type Description
System.Threading.Tasks.Task

A System.Threading.Tasks.Task representing any asynchronous operation.

RemovePane(Int32)

Allows you to remove the specified pane dynamically by passing its index value.

Declaration
public void RemovePane(int index)
Parameters
Type Name Description
System.Int32 index

Specifies the index value to remove the corresponding pane.

RemovePaneAsync(Int32)

Allows you to remove the specified pane dynamically by passing its index value.

Declaration
public Task RemovePaneAsync(int index)
Parameters
Type Name Description
System.Int32 index

Specifies the index value to remove the corresponding pane.
Returns
Type Description
System.Threading.Tasks.Task

A System.Threading.Tasks.Task representing any asynchronous operation.

ToggleAsync(List<Double>, List<Double>)

Expand and Collapse the Splitter panes based on the given indexes.

Declaration
public Task ToggleAsync(List<double> expandIndices, List<double> collapseIndices)
Parameters
Type Name Description
System.Collections.Generic.List<System.Double> expandIndices

Specifies the indexes of the corresponding panes to be Expanded.
System.Collections.Generic.List<System.Double> collapseIndices

Specifies the indexes of the corresponding panes to be Collapsed.
Returns
Type Description
System.Threading.Tasks.Task

A System.Threading.Tasks.Task representing any asynchronous operation.
Remarks

This method allows us to collapse and expand the multiple panes from the application end with a single method call.

See Also
Syncfusion.Blazor.Layouts.SplitterPane.collapsible
Syncfusion.Blazor.Layouts.SplitterPane.collapsed

UpdateSettings(List<SplitterPane>)

Declaration
public Task UpdateSettings(List<SplitterPane> paneDetails)
Parameters
Type Name Description
System.Collections.Generic.List<SplitterPane> paneDetails
Returns
Type Description
System.Threading.Tasks.Task