Class SidebarBuilder

Inheritance

System.Object

ControlBuilder

SidebarBuilder

Inherited Members

ControlBuilder.Context

Namespace: Syncfusion.EJ2.Navigations

Assembly: Syncfusion.EJ2.dll

Syntax

public class SidebarBuilder : ControlBuilder

Constructors

SidebarBuilder()

Declaration

public SidebarBuilder()

SidebarBuilder(Sidebar)

Declaration

public SidebarBuilder(Sidebar model)

Parameters

Type	Name	Description
Sidebar	model

Fields

model

Declaration

public Sidebar model

Field Value

Type	Description
Sidebar

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

Animate(Boolean)

Enable or disable the animation transitions on expanding or collapsing the Sidebar.

Declaration

public SidebarBuilder Animate(bool animate = true)

Parameters

Type	Name	Description
System.Boolean	animate

Returns

Type	Description
SidebarBuilder

Change(String)

Triggers when the state(expand/collapse) of the component is changed.

Declaration

public SidebarBuilder Change(string change)

Parameters

Type	Name	Description
System.String	change

Returns

Type	Description
SidebarBuilder

Close(String)

Triggers when component is closed.

Declaration

public SidebarBuilder Close(string close)

Parameters

Type	Name	Description
System.String	close

Returns

Type	Description
SidebarBuilder

CloseOnDocumentClick(Boolean)

Specifies whether the Sidebar need to be closed or not when document area is clicked.

Declaration

public SidebarBuilder CloseOnDocumentClick(bool closeOnDocumentClick = true)

Parameters

Type	Name	Description
System.Boolean	closeOnDocumentClick

Returns

Type	Description
SidebarBuilder

ContentTemplate(Action<Object>)

Declaration

public SidebarBuilder ContentTemplate(Action<object> template)

Parameters

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

Returns

Type	Description
SidebarBuilder

ContentTemplate(Func<Object, Object>)

Declaration

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

Parameters

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

Returns

Type	Description
SidebarBuilder

Created(String)

Triggers when component is created.

Declaration

public SidebarBuilder Created(string created)

Parameters

Type	Name	Description
System.String	created

Returns

Type	Description
SidebarBuilder

Destroyed(String)

Triggers when component gets destroyed.

Declaration

public SidebarBuilder Destroyed(string destroyed)

Parameters

Type	Name	Description
System.String	destroyed

Returns

Type	Description
SidebarBuilder

DockSize(Double)

Specifies the size of the Sidebar in dock state.

For more details about dockSize refer to Dock documentation.

Declaration

public SidebarBuilder DockSize(double dockSize)

Parameters

Type	Name	Description
System.Double	dockSize

Returns

Type	Description
SidebarBuilder

DockSize(String)

Specifies the size of the Sidebar in dock state.

For more details about dockSize refer to Dock documentation.

Declaration

public SidebarBuilder DockSize(string dockSize)

Parameters

Type	Name	Description
System.String	dockSize

Returns

Type	Description
SidebarBuilder

EnableDock(Boolean)

Specifies the docking state of the component.

For more details about enableDock refer to Dock documentation.

Declaration

public SidebarBuilder EnableDock(bool enableDock = true)

Parameters

Type	Name	Description
System.Boolean	enableDock

Returns

Type	Description
SidebarBuilder

EnableGestures(Boolean)

Enables the expand or collapse while swiping in touch devices.

Declaration

public SidebarBuilder EnableGestures(bool enableGestures = true)

Parameters

Type	Name	Description
System.Boolean	enableGestures

Returns

Type	Description
SidebarBuilder

EnablePersistence(Boolean)

Enable or disable persisting component's state between page reloads. If enabled, following list of states will be persisted.

1. Position
2. Type

Declaration

public SidebarBuilder EnablePersistence(bool enablePersistence = true)

Parameters

Type	Name	Description
System.Boolean	enablePersistence

Returns

Type	Description
SidebarBuilder

EnableRtl(Boolean)

Specifies the Sidebar in RTL mode that displays the content in the right-to-left direction.

Declaration

public SidebarBuilder EnableRtl(bool enableRtl = true)

Parameters

Type	Name	Description
System.Boolean	enableRtl

Returns

Type	Description
SidebarBuilder

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 SidebarBuilder HtmlAttributes(object htmlAttributes)

Parameters

Type	Name	Description
System.Object	htmlAttributes

Returns

Type	Description
SidebarBuilder

IsOpen(Boolean)

Gets or sets the Sidebar component is open or close.

When the Sidebar type is set to Auto, the component will be expanded in the desktop and collapsed in the mobile mode regardless of the isOpen property.

Declaration

public SidebarBuilder IsOpen(bool isOpen = true)

Parameters

Type	Name	Description
System.Boolean	isOpen

Returns

Type	Description
SidebarBuilder

MediaQuery(String)

Specifies the media query string for resolution, which when met opens the Sidebar.

For more details about mediaQuery refer to Auto Close documentation.

Declaration

public SidebarBuilder MediaQuery(string mediaQuery)

Parameters

Type	Name	Description
System.String	mediaQuery

Returns

Type	Description
SidebarBuilder

Open(String)

Triggers when component is opened.

Declaration

public SidebarBuilder Open(string open)

Parameters

Type	Name	Description
System.String	open

Returns

Type	Description
SidebarBuilder

Position(SidebarPosition)

Specifies the position of the Sidebar (Left/Right) corresponding to the main content.

For more details about SidebarPosition refer to position documentation.

Declaration

public SidebarBuilder Position(SidebarPosition position)

Parameters

Type	Name	Description
SidebarPosition	position

Returns

Type	Description
SidebarBuilder

Render()

Declaration

public HtmlString Render()

Returns

Type	Description
Microsoft.AspNetCore.Html.HtmlString

ShowBackdrop(Boolean)

Specifies the whether to apply overlay options to main content when the Sidebar is in an open state.

For more details about showBackdrop refer to Backdrop documentation.

Declaration

public SidebarBuilder ShowBackdrop(bool showBackdrop = true)

Parameters

Type	Name	Description
System.Boolean	showBackdrop

Returns

Type	Description
SidebarBuilder

Target(String)

Allows to place the sidebar inside the target element.

For more details about target refer to Custom Context documentation.

Declaration

public SidebarBuilder Target(string target)

Parameters

Type	Name	Description
System.String	target

Returns

Type	Description
SidebarBuilder

Type(SidebarType)

Specifies the expanding types of the Sidebar. Over - The sidebar floats over the main content area. Push - The sidebar pushes the main content area to appear side-by-side, and shrinks the main content within the screen width. Slide - The sidebar translates the x and y positions of main content area based on the sidebar width. The main content area will not be adjusted within the screen width. Auto - Sidebar with Over type in mobile resolution and Push type in other higher resolutions.

For more details about SidebarType refer to SidebarType documentation.

Declaration

public SidebarBuilder Type(SidebarType type)

Parameters

Type	Name	Description
SidebarType	type

Returns

Type	Description
SidebarBuilder

Width(Double)

Specifies the width of the Sidebar. By default, the width of the Sidebar sets based on the size of its content. Width can also be set in pixel values.

Declaration

public SidebarBuilder Width(double width)

Parameters

Type	Name	Description
System.Double	width

Returns

Type	Description
SidebarBuilder

Width(String)

Specifies the width of the Sidebar. By default, the width of the Sidebar sets based on the size of its content. Width can also be set in pixel values.

Declaration

public SidebarBuilder Width(string width)

Parameters

Type	Name	Description
System.String	width

Returns

Type	Description
SidebarBuilder

ZIndex(Double)

Specifies the z-index of the Sidebar. It is applicable only when sidebar act as overlay type.

Declaration

public SidebarBuilder ZIndex(double zIndex)

Parameters

Type	Name	Description
System.Double	zIndex

Returns

Type	Description
SidebarBuilder