Table of Contents

Class BreadcrumbBuilder

Namespace
Syncfusion.EJ2.Navigations
Assembly
Syncfusion.EJ2.dll
public class BreadcrumbBuilder : ControlBuilder
Inheritance
BreadcrumbBuilder
Inherited Members

Constructors

BreadcrumbBuilder() 

public BreadcrumbBuilder()

BreadcrumbBuilder(Breadcrumb) 

public BreadcrumbBuilder(Breadcrumb model)

Parameters

model Breadcrumb

Fields

model 

public Breadcrumb model

Field Value

Breadcrumb

Properties

HtmlAttr 

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

Property Value

IDictionary<string, object>

ID 

public string ID { get; set; }

Property Value

string

Output 

public override TextWriter Output { get; set; }

Property Value

TextWriter

Methods

ActiveItem(string)

Specifies the Url of the active Breadcrumb item.

public BreadcrumbBuilder ActiveItem(string activeItem)

Parameters

activeItem string

Returns

BreadcrumbBuilder

BeforeItemRender(string)

Triggers while rendering each breadcrumb item.

public BreadcrumbBuilder BeforeItemRender(string beforeItemRender)

Parameters

beforeItemRender string

Returns

BreadcrumbBuilder

Created(string)

Triggers once the component rendering is completed.

public BreadcrumbBuilder Created(string created)

Parameters

created string

Returns

BreadcrumbBuilder

CssClass(string)

Defines class/multiple classes separated by a space in the Breadcrumb element.

public BreadcrumbBuilder CssClass(string cssClass)

Parameters

cssClass string

Returns

BreadcrumbBuilder

Disabled(bool)

Enable or disable the breadcrumb, when set to true, the breadcrumb will be disabled.

public BreadcrumbBuilder Disabled(bool disabled = true)

Parameters

disabled bool

Returns

BreadcrumbBuilder

EnableActiveItemNavigation(bool)

Enable or disable the active item navigation, when set to true, active item will be navigable.

public BreadcrumbBuilder EnableActiveItemNavigation(bool enableActiveItemNavigation = true)

Parameters

enableActiveItemNavigation bool

Returns

BreadcrumbBuilder

EnableNavigation(bool)

Enable or disable the item's navigation, when set to false, each item navigation will be prevented.

public BreadcrumbBuilder EnableNavigation(bool enableNavigation = true)

Parameters

enableNavigation bool

Returns

BreadcrumbBuilder

EnablePersistence(bool)

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

public BreadcrumbBuilder EnablePersistence(bool enablePersistence = true)

Parameters

enablePersistence bool

Returns

BreadcrumbBuilder

EnableRtl(bool)

Enable or disable rendering component in right to left direction.

public BreadcrumbBuilder EnableRtl(bool enableRtl = true)

Parameters

enableRtl bool

Returns

BreadcrumbBuilder

HtmlAttributes(object)

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

public BreadcrumbBuilder HtmlAttributes(object htmlAttributes)

Parameters

htmlAttributes object

Returns

BreadcrumbBuilder

ItemClick(string)

Triggers while clicking the breadcrumb item.

public BreadcrumbBuilder ItemClick(string itemClick)

Parameters

itemClick string

Returns

BreadcrumbBuilder

ItemTemplate(string)

Specifies the template for Breadcrumb item.

public BreadcrumbBuilder ItemTemplate(string itemTemplate)

Parameters

itemTemplate string

Returns

BreadcrumbBuilder

Items(Action<BreadcrumbItemBuilder>) 

public BreadcrumbBuilder Items(Action<BreadcrumbItemBuilder> items)

Parameters

items Action<BreadcrumbItemBuilder>

Returns

BreadcrumbBuilder

Items(List<BreadcrumbItem>)

Defines the list of Breadcrumb items.

public BreadcrumbBuilder Items(List<BreadcrumbItem> items)

Parameters

items List<BreadcrumbItem>

Returns

BreadcrumbBuilder

MaxItems(int)

Specifies an integer to enable overflow behavior when the Breadcrumb items count exceeds and it is based on the overflowMode property.

public BreadcrumbBuilder MaxItems(int maxItems)

Parameters

maxItems int

Returns

BreadcrumbBuilder

OverflowMode(BreadcrumbOverflowMode)

Specifies the overflow mode of the Breadcrumb item when it exceeds maxItems count. The possible values are,

  • Default: Specified maxItems count will be visible and the remaining items will be hidden. While clicking on the previous item, the hidden item will become visible.
  • Collapsed: Only the first and last items will be visible, and the remaining items will be hidden in the collapsed icon. When the collapsed icon is clicked, all items become visible.
  • Menu: Shows the number of breadcrumb items that can be accommodated within the container space, and creates a sub menu with the remaining items.
  • Wrap: Wraps the items on multiple lines when the Breadcrumb’s width exceeds the container space.
  • Scroll: Shows an HTML scroll bar when the Breadcrumb’s width exceeds the container space.
  • None: Shows all the items on a single line.
public BreadcrumbBuilder OverflowMode(BreadcrumbOverflowMode overflowMode)

Parameters

overflowMode BreadcrumbOverflowMode

Returns

BreadcrumbBuilder

Render() 

public HtmlString Render()

Returns

HtmlString

SeparatorTemplate(string)

Specifies the separator template for Breadcrumb.

public BreadcrumbBuilder SeparatorTemplate(string separatorTemplate)

Parameters

separatorTemplate string

Returns

BreadcrumbBuilder

Url(string)

Defines the Url based on which the Breadcrumb items are generated.

public BreadcrumbBuilder Url(string url)

Parameters

url string

Returns

BreadcrumbBuilder