Class Breadcrumb

Inheritance
System.Object
Syncfusion.EJ2.EJTagHelper
Breadcrumb
Namespace: Syncfusion.EJ2.Navigations
Assembly: Syncfusion.EJ2.dll
Syntax
public class Breadcrumb : EJTagHelper

Constructors

Breadcrumb()

Declaration
public Breadcrumb()

Properties

ActiveItem

Specifies the Url of the active Breadcrumb item.

Declaration
public string ActiveItem { get; set; }
Property Value
Type Description
System.String

The default value is ""

BeforeItemRender

Triggers while rendering each breadcrumb item.

Declaration
public string BeforeItemRender { get; set; }
Property Value
Type Description
System.String

The default value is null

Created

Triggers once the component rendering is completed.

Declaration
public string Created { get; set; }
Property Value
Type Description
System.String

The default value is null

CssClass

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

Declaration
public string CssClass { get; set; }
Property Value
Type Description
System.String

The default value is ""

Disabled

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

Declaration
public bool Disabled { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableActiveItemNavigation

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

Declaration
public bool EnableActiveItemNavigation { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableNavigation

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

Declaration
public bool EnableNavigation { get; set; }
Property Value
Type Description
System.Boolean

The default value is true

EnablePersistence

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

Declaration
public bool EnablePersistence { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EnableRtl

Enable or disable rendering component in right to left direction.

Declaration
public bool EnableRtl { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

HtmlAttributes

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

Declaration
public object HtmlAttributes { get; set; }
Property Value
Type
System.Object

ItemClick

Triggers while clicking the breadcrumb item.

Declaration
public string ItemClick { get; set; }
Property Value
Type Description
System.String

The default value is null

Items

Defines the list of Breadcrumb items.

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

The default value is null

ItemTemplate

Specifies the template for Breadcrumb item.

Declaration
public string ItemTemplate { get; set; }
Property Value
Type Description
System.String

The default value is null

MaxItems

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

Declaration
public int MaxItems { get; set; }
Property Value
Type Description
System.Int32

The default value is -1

OverflowMode

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 BreadcrumbOverflowMode OverflowMode { get; set; }
Property Value
Type Description
BreadcrumbOverflowMode

The default value is BreadcrumbOverflowMode.Menu

SeparatorTemplate

Specifies the separator template for Breadcrumb.

Declaration
public string SeparatorTemplate { get; set; }
Property Value
Type Description
System.String

The default value is "/"

Url

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

Declaration
public string Url { get; set; }
Property Value
Type Description
System.String

The default value is ""