Class SplitterBuilder

Inheritance

System.Object

ControlBuilder

SplitterBuilder

Inherited Members

ControlBuilder.Context

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Syncfusion.EJ2.Layouts

Assembly: Syncfusion.EJ2.dll

Syntax

public class SplitterBuilder : ControlBuilder

Constructors

SplitterBuilder()

Declaration

public SplitterBuilder()

SplitterBuilder(Splitter)

Declaration

public SplitterBuilder(Splitter model)

Parameters

Type	Name	Description
Splitter	model

Fields

model

Declaration

public Splitter model

Field Value

Type	Description
Splitter

Properties

HtmlAttr

Declaration

public IDictionary<string, object> HtmlAttr { get; set; }

Property Value

Type	Description
System.Collections.Generic.IDictionary<System.String, System.Object>

ID

Declaration

public string ID { get; set; }

Property Value

Type	Description
System.String

Output

Declaration

public override TextWriter Output { get; set; }

Property Value

Type	Description
System.IO.TextWriter

Overrides

ControlBuilder.Output

Methods

BeforeCollapse(String)

Triggers when before panes get collapsed.

Declaration

public SplitterBuilder BeforeCollapse(string beforeCollapse)

Parameters

Type	Name	Description
System.String	beforeCollapse

Returns

Type	Description
SplitterBuilder

BeforeExpand(String)

Triggers when before panes get expanded.

Declaration

public SplitterBuilder BeforeExpand(string beforeExpand)

Parameters

Type	Name	Description
System.String	beforeExpand

Returns

Type	Description
SplitterBuilder

BeforeSanitizeHtml(String)

Event triggers before sanitize the value.

Declaration

public SplitterBuilder BeforeSanitizeHtml(string beforeSanitizeHtml)

Parameters

Type	Name	Description
System.String	beforeSanitizeHtml

Returns

Type	Description
SplitterBuilder

Collapsed(String)

Triggers when after panes get collapsed.

Declaration

public SplitterBuilder Collapsed(string collapsed)

Parameters

Type	Name	Description
System.String	collapsed

Returns

Type	Description
SplitterBuilder

ContentTemplate(Action<Object>)

Declaration

public SplitterBuilder ContentTemplate(Action<object> template)

Parameters

Type	Name	Description
System.Action<System.Object>	template

Returns

Type	Description
SplitterBuilder

ContentTemplate(Func<Object, Object>)

Declaration

public SplitterBuilder ContentTemplate(Func<object, object> template)

Parameters

Type	Name	Description
System.Func<System.Object, System.Object>	template

Returns

Type	Description
SplitterBuilder

Created(String)

Triggers after creating the splitter component with its panes.

Declaration

public SplitterBuilder Created(string created)

Parameters

Type	Name	Description
System.String	created

Returns

Type	Description
SplitterBuilder

CssClass(String)

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 control. One or more custom CSS classes can be specified to the Splitter.

Declaration

public SplitterBuilder CssClass(string cssClass)

Parameters

Type	Name	Description
System.String	cssClass

Returns

Type	Description
SplitterBuilder

Enabled(Boolean)

Specifies boolean value that indicates whether the component is enabled or disabled. The Splitter component does not allow to interact when this property is disabled.

Declaration

public SplitterBuilder Enabled(bool enabled = true)

Parameters

Type	Name	Description
System.Boolean	enabled

Returns

Type	Description
SplitterBuilder

EnableHtmlSanitizer(Boolean)

Defines whether to allow the cross-scripting site or not.

Declaration

public SplitterBuilder EnableHtmlSanitizer(bool enableHtmlSanitizer = true)

Parameters

Type	Name	Description
System.Boolean	enableHtmlSanitizer

Returns

Type	Description
SplitterBuilder

EnablePersistence(Boolean)

Enables or disables the persisting component's state between page reloads.

Declaration

public SplitterBuilder EnablePersistence(bool enablePersistence = true)

Parameters

Type	Name	Description
System.Boolean	enablePersistence

Returns

Type	Description
SplitterBuilder

EnableReversePanes(Boolean)

Specifies the value whether splitter panes are reordered or not .

Declaration

public SplitterBuilder EnableReversePanes(bool enableReversePanes = true)

Parameters

Type	Name	Description
System.Boolean	enableReversePanes

Returns

Type	Description
SplitterBuilder

EnableRtl(Boolean)

Enable or disable rendering component in right to left direction.

Declaration

public SplitterBuilder EnableRtl(bool enableRtl = true)

Parameters

Type	Name	Description
System.Boolean	enableRtl

Returns

Type	Description
SplitterBuilder

Expanded(String)

Triggers when after panes get expanded.

Declaration

public SplitterBuilder Expanded(string expanded)

Parameters

Type	Name	Description
System.String	expanded

Returns

Type	Description
SplitterBuilder

Height(String)

Specifies the height of the Splitter component that accepts both string and number values.

Declaration

public SplitterBuilder Height(string height)

Parameters

Type	Name	Description
System.String	height

Returns

Type	Description
SplitterBuilder

HtmlAttributes(Object)

Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.

Declaration

public SplitterBuilder HtmlAttributes(object htmlAttributes)

Parameters

Type	Name	Description
System.Object	htmlAttributes

Returns

Type	Description
SplitterBuilder

Locale(String)

Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

Declaration

public SplitterBuilder Locale(string locale)

Parameters

Type	Name	Description
System.String	locale

Returns

Type	Description
SplitterBuilder

Orientation(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 SplitterBuilder Orientation(Orientation orientation)

Parameters

Type	Name	Description
Orientation	orientation

Returns

Type	Description
SplitterBuilder

PaneSettings(Action<SplitterPaneBuilder>)

Declaration

public SplitterBuilder PaneSettings(Action<SplitterPaneBuilder> paneSettings)

Parameters

Type	Name	Description
System.Action<SplitterPaneBuilder>	paneSettings

Returns

Type	Description
SplitterBuilder

PaneSettings(List<SplitterPane>)

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

Declaration

public SplitterBuilder PaneSettings(List<SplitterPane> paneSettings)

Parameters

Type	Name	Description
System.Collections.Generic.List<SplitterPane>	paneSettings

Returns

Type	Description
SplitterBuilder

Render()

Declaration

public HtmlString Render()

Returns

Type	Description
System.Web.HtmlString

ResizeStart(String)

Triggers when the split pane is started to resize.

Declaration

public SplitterBuilder ResizeStart(string resizeStart)

Parameters

Type	Name	Description
System.String	resizeStart

Returns

Type	Description
SplitterBuilder

ResizeStop(String)

Triggers when the resizing of split pane is stopped.

Declaration

public SplitterBuilder ResizeStop(string resizeStop)

Parameters

Type	Name	Description
System.String	resizeStop

Returns

Type	Description
SplitterBuilder

Resizing(String)

Triggers when a split pane is being resized.

Declaration

public SplitterBuilder Resizing(string resizing)

Parameters

Type	Name	Description
System.String	resizing

Returns

Type	Description
SplitterBuilder

SeparatorSize(Double)

Specifies the size of the separator line for both horizontal or vertical orientation. The separator is used to separate the panes by lines.

Declaration

public SplitterBuilder SeparatorSize(double separatorSize)

Parameters

Type	Name	Description
System.Double	separatorSize

Returns

Type	Description
SplitterBuilder

Width(String)

Specifies the width of the Splitter control, which accepts both string and number values as width. The string value can be either in pixel or percentage format.

Declaration

public SplitterBuilder Width(string width)

Parameters

Type	Name	Description
System.String	width

Returns

Type	Description
SplitterBuilder