Class Breadcrumb

Namespace

Syncfusion.EJ2.Navigations

Assembly

Syncfusion.EJ2.dll

[HtmlTargetElement("ejs-breadcrumb")]
[RestrictChildren("e-breadcrumb-items", new string[] { })]
public class Breadcrumb : EJTagHelper, ITagHelper, ITagHelperComponent

Inheritance

object

TagHelper

EJTagHelper

Breadcrumb

Implements

ITagHelper

ITagHelperComponent

Inherited Members

EJTagHelper.GetList()

EJTagHelper.Process(TagHelperContext, TagHelperOutput)

EJTagHelper.RegisterScript()

EJTagHelper.GetSerializedProperties()

EJTagHelper.GetScriptString()

EJTagHelper.GetHtmlAttrString(IDictionary<string, object>)

EJTagHelper.ViewContext

EJTagHelper.For

EJTagHelper.Id

EJTagHelper.IsChild

EJTagHelper.IsComplex

EJTagHelper.IsCollection

EJTagHelper.ParentPropertyName

TagHelper.Init(TagHelperContext)

TagHelper.ProcessAsync(TagHelperContext, TagHelperOutput)

TagHelper.Order

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

Breadcrumb()

public Breadcrumb()

Properties

ActiveItem

Specifies the Url of the active Breadcrumb item.

[HtmlAttributeName("activeItem")]
public string ActiveItem { get; set; }

Property Value

string

The default value is ""

BeforeItemRender

Triggers while rendering each breadcrumb item.

[HtmlAttributeName("beforeItemRender")]
public string BeforeItemRender { get; set; }

Property Value

string

The default value is null

ClassName

protected override string ClassName { get; }

Property Value

string

Created

Triggers once the component rendering is completed.

[HtmlAttributeName("created")]
public string Created { get; set; }

Property Value

string

The default value is null

CssClass

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

[HtmlAttributeName("cssClass")]
public string CssClass { get; set; }

Property Value

string

The default value is ""

Disabled

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

[HtmlAttributeName("disabled")]
public bool Disabled { get; set; }

Property Value

bool

The default value is false

EnableActiveItemNavigation

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

[HtmlAttributeName("enableActiveItemNavigation")]
public bool EnableActiveItemNavigation { get; set; }

Property Value

bool

The default value is false

EnableNavigation

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

[HtmlAttributeName("enableNavigation")]
public bool EnableNavigation { get; set; }

Property Value

bool

The default value is true

EnablePersistence

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

[HtmlAttributeName("enablePersistence")]
public bool EnablePersistence { get; set; }

Property Value

bool

The default value is false

EnableRtl

Enable or disable rendering component in right to left direction.

[HtmlAttributeName("enableRtl")]
public bool EnableRtl { get; set; }

Property Value

bool

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.

[HtmlAttributeName("htmlAttributes")]
public object HtmlAttributes { get; set; }

Property Value

object

IsFor

protected override bool IsFor { get; }

Property Value

bool

ItemClick

Triggers while clicking the breadcrumb item.

[HtmlAttributeName("itemClick")]
public string ItemClick { get; set; }

Property Value

string

The default value is null

ItemTemplate

Specifies the template for Breadcrumb item.

[HtmlAttributeName("itemTemplate")]
public string ItemTemplate { get; set; }

Property Value

string

The default value is null

Items

Defines the list of Breadcrumb items.

[HtmlAttributeName("items")]
public List<BreadcrumbItem> Items { get; set; }

Property Value

List<BreadcrumbItem>

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.

[HtmlAttributeName("maxItems")]
public int MaxItems { get; set; }

Property Value

int

The default value is -1

NameSpace

protected override string NameSpace { get; }

Property Value

string

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.

[HtmlAttributeName("overflowMode")]
public BreadcrumbOverflowMode OverflowMode { get; set; }

Property Value

BreadcrumbOverflowMode

The default value is BreadcrumbOverflowMode.Menu

SeparatorTemplate

Specifies the separator template for Breadcrumb.

[HtmlAttributeName("separatorTemplate")]
public string SeparatorTemplate { get; set; }

Property Value

string

The default value is "/"

TagName

protected override string TagName { get; }

Property Value

string

Url

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

[HtmlAttributeName("url")]
public string Url { get; set; }

Property Value

string

The default value is ""