Class SplitterPropertiesBuilder

Represents a class for SplitterPropertiesBuilder which includes enable auto resize, enable animation, height, width, and empty data text properties.

Inheritance
System.Object
SplitterPropertiesBuilder
Implements
System.Web.IHtmlString
Inherited Members
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.JavaScript
Assembly: Syncfusion.EJ.dll
Syntax
public class SplitterPropertiesBuilder : IPropertiesBuilder, IHtmlString

Constructors

SplitterPropertiesBuilder()

Initializes a new instance of the SplitterPropertiesBuilder class.

Declaration
public SplitterPropertiesBuilder()

SplitterPropertiesBuilder(Splitter)

Initializes a new instance of the SplitterPropertiesBuilder class.

Declaration
public SplitterPropertiesBuilder(Splitter splitter)
Parameters
Type Name Description
Splitter splitter

Fields

splitter

Initializes a new instance of the SplitterPropertiesBuilder class.

Declaration
public Splitter splitter
Field Value
Type Description
Splitter

Properties

ItemsCollection

Adding the split panes in Splitter

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

Methods

AllowKeyboardNavigation()

Turns on keyboard interaction with the Splitter panes. You must set this property to true to access the keyboard shortcuts of ejSplitter.

Declaration
public SplitterPropertiesBuilder AllowKeyboardNavigation()
Returns
Type Description
SplitterPropertiesBuilder

AllowKeyboardNavigation(Boolean)

Turns on keyboard interaction with the Splitter panes. You must set this property to true to access the keyboard shortcuts of ejSplitter.A boolean variable allowKeyboardNavigation is passed.

Declaration
public SplitterPropertiesBuilder AllowKeyboardNavigation(bool allowKeyboardNavigation)
Parameters
Type Name Description
System.Boolean allowKeyboardNavigation
Returns
Type Description
SplitterPropertiesBuilder

AnimationSpeed(Int32)

Specify animation speed for the Splitter pane movement, while collapsing and expanding.

Declaration
public SplitterPropertiesBuilder AnimationSpeed(int animationSpeed)
Parameters
Type Name Description
System.Int32 animationSpeed
Returns
Type Description
SplitterPropertiesBuilder

ClientSideEvents(Action<SplitterClientSideEventsBuilder>)

To perform client side events

Declaration
public SplitterPropertiesBuilder ClientSideEvents(Action<SplitterClientSideEventsBuilder> clientSideEvents)
Parameters
Type Name Description
System.Action<SplitterClientSideEventsBuilder> clientSideEvents
Returns
Type Description
SplitterPropertiesBuilder

CssClass(String)

Specify the CSS class in splitter control to achieve custom theme.

Declaration
public SplitterPropertiesBuilder CssClass(string cssClass)
Parameters
Type Name Description
System.String cssClass
Returns
Type Description
SplitterPropertiesBuilder

EnableAnimation()

Specifies the animation behavior of the splitter.

Declaration
public SplitterPropertiesBuilder EnableAnimation()
Returns
Type Description
SplitterPropertiesBuilder

EnableAnimation(Boolean)

Specifies the animation behavior of the splitter.A boolean variable enableAnimation is passed as an argument.

Declaration
public SplitterPropertiesBuilder EnableAnimation(bool enableAnimation)
Parameters
Type Name Description
System.Boolean enableAnimation
Returns
Type Description
SplitterPropertiesBuilder

EnableAutoResize()

Enables autoResize, when it is set to true.

Declaration
[Obsolete("The EnableAutoResize is a deprecated.Use 'IsResponsive' instead of EnableResize")]
public SplitterPropertiesBuilder EnableAutoResize()
Returns
Type Description
SplitterPropertiesBuilder

EnableAutoResize(Boolean)

Enables the auto resize.

Declaration
public SplitterPropertiesBuilder EnableAutoResize(bool allowWindowResizing)
Parameters
Type Name Description
System.Boolean allowWindowResizing
Returns
Type Description
SplitterPropertiesBuilder

EnableRTL()

Specifies the splitter control to be displayed in right to left direction.

Declaration
public SplitterPropertiesBuilder EnableRTL()
Returns
Type Description
SplitterPropertiesBuilder

EnableRTL(Boolean)

Specifies the splitter control to be displayed in right to left direction.A boolean variable enableRTL is passed as an argument.

Declaration
public SplitterPropertiesBuilder EnableRTL(bool enableRTL)
Parameters
Type Name Description
System.Boolean enableRTL
Returns
Type Description
SplitterPropertiesBuilder

ExpanderTemplate(String)

Specify HTML element string to replace the existing expand/collapse icons.

Declaration
public SplitterPropertiesBuilder ExpanderTemplate(string expanderTemplate)
Parameters
Type Name Description
System.String expanderTemplate
Returns
Type Description
SplitterPropertiesBuilder

Height(String)

Specifies the height of splitter control.

Declaration
public SplitterPropertiesBuilder Height(string height)
Parameters
Type Name Description
System.String height
Returns
Type Description
SplitterPropertiesBuilder

HtmlAttributes(IDictionary<String, Object>)

Specifies the HTML Attributes of the Splitter.

Declaration
public SplitterPropertiesBuilder HtmlAttributes(IDictionary<string, object> itemHtmlAttributes)
Parameters
Type Name Description
System.Collections.Generic.IDictionary<System.String, System.Object> itemHtmlAttributes
Returns
Type Description
SplitterPropertiesBuilder

IsResponsive()

Specify window responsive behavior for splitter control,when it is set to true.

Declaration
public SplitterPropertiesBuilder IsResponsive()
Returns
Type Description
SplitterPropertiesBuilder

IsResponsive(Boolean)

Specify window resizing behavior for splitter control.A boolean variable allowWindowResizing is passed.

Declaration
public SplitterPropertiesBuilder IsResponsive(bool allowWindowResizing)
Parameters
Type Name Description
System.Boolean allowWindowResizing
Returns
Type Description
SplitterPropertiesBuilder

Items(Action<PanePropertiesAdder>)

Add the pane properties

Declaration
public SplitterPropertiesBuilder Items(Action<PanePropertiesAdder> items)
Parameters
Type Name Description
System.Action<PanePropertiesAdder> items
Returns
Type Description
SplitterPropertiesBuilder

Orientation(Orientation)

Specifies the orientation for spliter control.

Declaration
public SplitterPropertiesBuilder Orientation(Orientation orientation)
Parameters
Type Name Description
Orientation orientation
Returns
Type Description
SplitterPropertiesBuilder

PaneProperties(Action<PanePropertiesAdder>)

Specify properties for each pane like paneSize, minSize, maxSize, collapsible, expandable, resizable.

Declaration
public SplitterPropertiesBuilder PaneProperties(Action<PanePropertiesAdder> properties)
Parameters
Type Name Description
System.Action<PanePropertiesAdder> properties
Returns
Type Description
SplitterPropertiesBuilder

Render()

Renders this instance.

Declaration
public void Render()

ToHtmlString()

Returns an HTML-encoded string.

Declaration
public string ToHtmlString()
Returns
Type Description
System.String

ToString()

Gets or sets a value.

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides
System.Object.ToString()

Width(String)

Specifies the width of splitter control.

Declaration
public SplitterPropertiesBuilder Width(string width)
Parameters
Type Name Description
System.String width
Returns
Type Description
SplitterPropertiesBuilder

Implements

System.Web.IHtmlString