New to Telerik UI for ASP.NET MVC? Start a free 30-day trial

BreadcrumbBuilder

Class

Defines the fluent API for configuring the Kendo Breadcrumb for ASP.NET MVC.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:

public class BreadcrumbBuilder : WidgetBuilderBase<Breadcrumb, BreadcrumbBuilder>, IHtmlString

Inheritance: objectWidgetBuilderBase<Breadcrumb, BreadcrumbBuilder>BreadcrumbBuilder

Implements: IHtmlString

Constructors

BreadcrumbBuilder(Breadcrumb)

Initializes a new instance of the Breadcrumb class.

public BreadcrumbBuilder(Breadcrumb component)

Parameters:componentBreadcrumb

The component.

Methods

BindToLocation(bool)

Indicates whether the Breadcrumb will enable/disable the binding to the location object of the browser on initialization.

public BreadcrumbBuilder BindToLocation(bool value)

Parameters:valuebool

The value that configures the bindtolocation.

Returns:

BreadcrumbBuilder

Example:

@(Html.Kendo().Breadcrumb()
.Name("breadcrumb")
.BindToLocation(false)
)

DelimiterIcon(string)

Defines a name of an existing icon in the Kendo UI Web Font Icons. The icon will be applied as separator between the segments of the Breadcrumb path.

public BreadcrumbBuilder DelimiterIcon(string value)

Parameters:valuestring

The value that configures the delimitericon.

Returns:

BreadcrumbBuilder

Example:

@(Html.Kendo().Breadcrumb()
.Name("breadcrumb")
.DelimiterIcon("shape-line")
)

Indicates whether the editing functionality of the Breadcrumb will be enabled/disabled.If the option is enabled the path will be editable. Clicking in an empty area of the component will trigger editing mode. Editing mode shows an input showing the value of the component enabling the end user to type a new path.

public BreadcrumbBuilder Editable(bool value)

Parameters:valuebool

The value that configures the editable.

Returns:

BreadcrumbBuilder

Example:

@(Html.Kendo().Breadcrumb()
.Name("breadcrumb")
.Editable(false)
)

Events(Action<BreadcrumbEventBuilder>)

Configures the client-side events.

public BreadcrumbBuilder Events(Action<BreadcrumbEventBuilder> configurator)

Parameters:configuratorAction<BreadcrumbEventBuilder>

The client events action.

Returns:

BreadcrumbBuilder

Example:

@( Html.Kendo().Breadcrumb()
.Name("Breadcrumb")
.Events(events =&gt; events
.Click("onClick")
)
)

Gap(double)

Defines the space in pixels after the last item to stay empty.The gap value is taken into account when items overflow and continues to remain empty.

public BreadcrumbBuilder Gap(double value)

Parameters:valuedouble

The value that configures the gap.

Returns:

BreadcrumbBuilder

Example:

@(Html.Kendo().Breadcrumb()
.Name("breadcrumb")
.Gap(150)
)

Items(Action<BreadcrumbItemFactory>)

Array of items to be rendered in Breadcrumb.

public BreadcrumbBuilder Items(Action<BreadcrumbItemFactory> configurator)

Parameters:configuratorAction<BreadcrumbItemFactory>

The action that configures the items.

Returns:

BreadcrumbBuilder

Messages(Action<BreadcrumbMessagesSettingsBuilder>)

Defines the text of the root icon title that is displayed within the Breadcrumb.

public BreadcrumbBuilder Messages(Action<BreadcrumbMessagesSettingsBuilder> configurator)

Parameters:configuratorAction<BreadcrumbMessagesSettingsBuilder>

The action that configures the messages.

Returns:

BreadcrumbBuilder

Example:

@(Html.Kendo().Breadcrumb()
.Name("breadcrumb")
.Messages(m =&gt; m.RootTitle("test"))
)

Navigational(bool)

Indicates whether the navigation functionality of the Breadcrumb will be enabled/disabled.When navigational is set to false, automatic navigation (changing url location) is disabled by default. In this state, the click event will be prevented and navigation will occur only if programmatic navigation is implemented.When navigational is set to true, the url (path) will be automatically added to the href attribute of the rendered links. In this state, the click event will trigger navigation.

public BreadcrumbBuilder Navigational(bool value)

Parameters:valuebool

The value that configures the navigational.

Returns:

BreadcrumbBuilder

Example:

@(Html.Kendo().Breadcrumb()
.Name("breadcrumb")
.Navigational(true)
)

RootIcon(string)

Defines a name of an existing icon in the Kendo UI Web Font Icons. The icon will be applied as the first item(root) of Breadcrumb path.The root icon is clickable and resets the value of the component.

public BreadcrumbBuilder RootIcon(string value)

Parameters:valuestring

The value that configures the rooticon.

Returns:

BreadcrumbBuilder

Example:

@(Html.Kendo().Breadcrumb()
.Name("breadcrumb")
.RootIcon("cloud")
)

Size(ComponentSize)

Sets the size of the component.

public BreadcrumbBuilder Size(ComponentSize value)

Parameters:valueComponentSize

The value that configures the size.

Returns:

BreadcrumbBuilder

Example:

@(Html.Kendo().Breadcrumb()
.Name("breadcrumb")
.Size(ComponentSize.Medium)
)

Tag(string)

Sets the Breadcrumb tag. A nav tag is used by default.

public BreadcrumbBuilder Tag(string tag)

Parameters:tagstringReturns:

BreadcrumbBuilder

Example:

@( Html.Kendo().Breadcrumb()
.Name("Breadcrumb")
.Tag("input")
)

Value(string)

Defines the value/path of the component. Each segments is separated by a slash.

public BreadcrumbBuilder Value(string value)

Parameters:valuestring

The value that configures the value.

Returns:

BreadcrumbBuilder

Example:

@(Html.Kendo().Breadcrumb()
.Name("breadcrumb")
.Value("Telerik UI/Navigation/Breadcrumb")
)