Class AppBarBuilder

Inheritance
System.Object
ControlBuilder
AppBarBuilder
Inherited Members
Namespace: Syncfusion.EJ2.Navigations
Assembly: Syncfusion.EJ2.dll
Syntax
public class AppBarBuilder : ControlBuilder

Constructors

AppBarBuilder()

Declaration
public AppBarBuilder()

AppBarBuilder(AppBar)

Declaration
public AppBarBuilder(AppBar model)
Parameters
Type Name Description
AppBar model

Fields

model

Declaration
public AppBar model
Field Value
Type Description
AppBar

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

Methods

ColorMode(AppBarColor)

Specifies the color mode that defines the color of the AppBar component. The possible values for this property are as follows: Light: Specifies the AppBar in light color. Dark: Specifies the AppBar in dark color. Primary: Specifies the AppBar in a primary color. Inherit: Inherit color from parent for AppBar. AppBar background and colors are inherited from its parent element.

Declaration
public AppBarBuilder ColorMode(AppBarColor colorMode)
Parameters
Type Name Description
AppBarColor colorMode
Returns
Type Description
AppBarBuilder

ContentTemplate(Action<Object>)

Declaration
public AppBarBuilder ContentTemplate(Action<object> template)
Parameters
Type Name Description
System.Action<System.Object> template
Returns
Type Description
AppBarBuilder

ContentTemplate(Func<Object, Object>)

Declaration
public AppBarBuilder ContentTemplate(Func<object, object> template)
Parameters
Type Name Description
System.Func<System.Object, System.Object> template
Returns
Type Description
AppBarBuilder

Created(String)

Triggers after the AppBar component is created.

Declaration
public AppBarBuilder Created(string created)
Parameters
Type Name Description
System.String created
Returns
Type Description
AppBarBuilder

CssClass(String)

Accepts single/multiple CSS classes (separated by a space) to be used for AppBar customization.

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

Destroyed(String)

Triggers when the AppBar component is destroyed.

Declaration
public AppBarBuilder Destroyed(string destroyed)
Parameters
Type Name Description
System.String destroyed
Returns
Type Description
AppBarBuilder

EnablePersistence(Boolean)

Enable or disable persisting component's state between page reloads.

Declaration
public AppBarBuilder EnablePersistence(bool enablePersistence = true)
Parameters
Type Name Description
System.Boolean enablePersistence
Returns
Type Description
AppBarBuilder

EnableRtl(Boolean)

Enable or disable rendering component in right to left direction.

Declaration
public AppBarBuilder EnableRtl(bool enableRtl = true)
Parameters
Type Name Description
System.Boolean enableRtl
Returns
Type Description
AppBarBuilder

HtmlAttributes(Object)

Accepts HTML attributes/custom attributes that will be applied to the AppBar element.

Declaration
public AppBarBuilder HtmlAttributes(object htmlAttributes)
Parameters
Type Name Description
System.Object htmlAttributes
Returns
Type Description
AppBarBuilder

IsSticky(Boolean)

Defines whether the AppBar position is fixed or not while scrolling the page. When set to true, the AppBar will be sticky while scrolling.

Declaration
public AppBarBuilder IsSticky(bool isSticky = true)
Parameters
Type Name Description
System.Boolean isSticky
Returns
Type Description
AppBarBuilder

Locale(String)

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

Declaration
public AppBarBuilder Locale(string locale)
Parameters
Type Name Description
System.String locale
Returns
Type Description
AppBarBuilder

Mode(AppBarMode)

Specifies the mode of the AppBar that defines the AppBar height. The possible values for this property are as follows: Regular: Specifies default height for the AppBar. Prominent: Specifies longer height for the AppBar to show the longer titles and images, or to provide a stronger presence. Dense: Specifies compressed (short) height for the AppBar to accommodate all the app bar content in a denser layout.

Declaration
public AppBarBuilder Mode(AppBarMode mode)
Parameters
Type Name Description
AppBarMode mode
Returns
Type Description
AppBarBuilder

Position(AppBarPosition)

Specifies the position of the AppBar. The possible values for this property are as follows: Top: Position the AppBar at the top. Bottom: Position the AppBar at the bottom.

Declaration
public AppBarBuilder Position(AppBarPosition position)
Parameters
Type Name Description
AppBarPosition position
Returns
Type Description
AppBarBuilder

Render()

Declaration
public HtmlString Render()
Returns
Type Description
Microsoft.AspNetCore.Html.HtmlString