Class BreadcrumbBuilder
Inheritance
System.Object
BreadcrumbBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class BreadcrumbBuilder : ControlBuilder
Constructors
BreadcrumbBuilder()
Declaration
public BreadcrumbBuilder()
BreadcrumbBuilder(Breadcrumb)
Declaration
public BreadcrumbBuilder(Breadcrumb model)
Parameters
Fields
model
Declaration
Field Value
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
ActiveItem(String)
Specifies the Url of the active Breadcrumb item.
Declaration
public BreadcrumbBuilder ActiveItem(string activeItem)
Parameters
| Type |
Name |
Description |
| System.String |
activeItem |
|
Returns
BeforeItemRender(String)
Triggers while rendering each breadcrumb item.
Declaration
public BreadcrumbBuilder BeforeItemRender(string beforeItemRender)
Parameters
| Type |
Name |
Description |
| System.String |
beforeItemRender |
|
Returns
Created(String)
Triggers once the component rendering is completed.
Declaration
public BreadcrumbBuilder Created(string created)
Parameters
| Type |
Name |
Description |
| System.String |
created |
|
Returns
CssClass(String)
Defines class/multiple classes separated by a space in the Breadcrumb element.
Declaration
public BreadcrumbBuilder CssClass(string cssClass)
Parameters
| Type |
Name |
Description |
| System.String |
cssClass |
|
Returns
Disabled(Boolean)
Enable or disable the breadcrumb, when set to true, the breadcrumb will be disabled.
Declaration
public BreadcrumbBuilder Disabled(bool disabled = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
disabled |
|
Returns
EnableActiveItemNavigation(Boolean)
Enable or disable the active item navigation, when set to true, active item will be navigable.
Declaration
public BreadcrumbBuilder EnableActiveItemNavigation(bool enableActiveItemNavigation = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableActiveItemNavigation |
|
Returns
EnableNavigation(Boolean)
Enable or disable the item's navigation, when set to false, each item navigation will be prevented.
Declaration
public BreadcrumbBuilder EnableNavigation(bool enableNavigation = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableNavigation |
|
Returns
EnablePersistence(Boolean)
Enable or disable persisting component's state between page reloads.
Declaration
public BreadcrumbBuilder EnablePersistence(bool enablePersistence = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enablePersistence |
|
Returns
EnableRtl(Boolean)
Enable or disable rendering component in right to left direction.
Declaration
public BreadcrumbBuilder EnableRtl(bool enableRtl = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableRtl |
|
Returns
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 BreadcrumbBuilder HtmlAttributes(object htmlAttributes)
Parameters
| Type |
Name |
Description |
| System.Object |
htmlAttributes |
|
Returns
ItemClick(String)
Triggers while clicking the breadcrumb item.
Declaration
public BreadcrumbBuilder ItemClick(string itemClick)
Parameters
| Type |
Name |
Description |
| System.String |
itemClick |
|
Returns
Items(Action<BreadcrumbItemBuilder>)
Declaration
public BreadcrumbBuilder Items(Action<BreadcrumbItemBuilder> items)
Parameters
Returns
Items(List<BreadcrumbItem>)
Defines the list of Breadcrumb items.
Declaration
public BreadcrumbBuilder Items(List<BreadcrumbItem> items)
Parameters
| Type |
Name |
Description |
| System.Collections.Generic.List<BreadcrumbItem> |
items |
|
Returns
ItemTemplate(String)
Specifies the template for Breadcrumb item.
Declaration
public BreadcrumbBuilder ItemTemplate(string itemTemplate)
Parameters
| Type |
Name |
Description |
| System.String |
itemTemplate |
|
Returns
MaxItems(Int32)
Specifies an integer to enable overflow behavior when the Breadcrumb items count exceeds and it is based on the overflowMode property.
Declaration
public BreadcrumbBuilder MaxItems(int maxItems)
Parameters
| Type |
Name |
Description |
| System.Int32 |
maxItems |
|
Returns
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.
Declaration
public BreadcrumbBuilder OverflowMode(BreadcrumbOverflowMode overflowMode)
Parameters
Returns
Render()
Declaration
public HtmlString Render()
Returns
| Type |
Description |
| Microsoft.AspNetCore.Html.HtmlString |
|
SeparatorTemplate(String)
Specifies the separator template for Breadcrumb.
Declaration
public BreadcrumbBuilder SeparatorTemplate(string separatorTemplate)
Parameters
| Type |
Name |
Description |
| System.String |
separatorTemplate |
|
Returns
Url(String)
Defines the Url based on which the Breadcrumb items are generated.
Declaration
public BreadcrumbBuilder Url(string url)
Parameters
| Type |
Name |
Description |
| System.String |
url |
|
Returns
