BreadcrumbBuilder
Properties
WriteAction - Func
Methods
Tag(System.String)
Sets the Breadcrumb tag. A nav tag is used by default.
Parameters
tag - System.String
RETURNS
Returns the current BreadcrumbBuilder instance.
Example
@( Html.Kendo().Breadcrumb()
.Name("Breadcrumb")
.Tag("input")
)
BindToLocation(System.Boolean)
Indicates whether the Breadcrumb will enable/disable the binding to the location object of the browser on initialization.
Parameters
value - System.Boolean
The value for BindToLocation
RETURNS
Returns the current BreadcrumbBuilder instance.
BindToLocation()
Indicates whether the Breadcrumb will enable/disable the binding to the location object of the browser on initialization.
RETURNS
Returns the current BreadcrumbBuilder instance.
DelimiterIcon(System.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.
Parameters
value - System.String
The value for DelimiterIcon
RETURNS
Returns the current BreadcrumbBuilder instance.
Editable(System.Boolean)
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.
Parameters
value - System.Boolean
The value for Editable
RETURNS
Returns the current BreadcrumbBuilder instance.
Editable()
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.
RETURNS
Returns the current BreadcrumbBuilder instance.
Items(System.Action)
Array of items to be rendered in Breadcrumb.
Parameters
configurator - System.Action<BreadcrumbItemFactory>
The configurator for the items setting.
RETURNS
Returns the current instance of BreadcrumbBuilder .
Gap(System.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.
Parameters
value - System.Double
The value for Gap
RETURNS
Returns the current BreadcrumbBuilder instance.
Messages(System.Action)
Defines the text of the root icon title that is displayed within the Breadcrumb.
Parameters
configurator - System.Action<BreadcrumbMessagesSettingsBuilder>
The configurator for the messages setting.
RETURNS
Returns the current instance of BreadcrumbBuilder .
Navigational(System.Boolean)
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.
Parameters
value - System.Boolean
The value for Navigational
RETURNS
Returns the current BreadcrumbBuilder instance.
Navigational()
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.
RETURNS
Returns the current BreadcrumbBuilder instance.
RootIcon(System.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.
Parameters
value - System.String
The value for RootIcon
RETURNS
Returns the current BreadcrumbBuilder instance.
Value(System.String)
Defines the value/path of the component. Each segments is separated by a slash.
Parameters
value - System.String
The value for Value
RETURNS
Returns the current BreadcrumbBuilder instance.
Size(Kendo.Mvc.UI.ComponentSize)
Sets the size of the component.
Parameters
value - ComponentSize
The value for Size
RETURNS
Returns the current BreadcrumbBuilder instance.
Events(System.Action)
Configures the client-side events.
Parameters
configurator - System.Action<BreadcrumbEventBuilder>
The client events action.
RETURNS
Returns the current BreadcrumbBuilder instance.
Example
@(Html.Kendo().Breadcrumb()
.Name("Breadcrumb")
.Events(events => events
.Click("onClick")
)
)
ToComponent()
Returns the internal view component.
RETURNS
The instance that represents the component.
Expression(System.String)
Sets the name of the component.
Parameters
modelExpression - System.String
RETURNS
Returns the current instance.
Explorer(Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer)
Sets the name of the component.
Parameters
modelExplorer - Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer
RETURNS
Returns the current instance.
Name(System.String)
Sets the name of the component.
Parameters
componentName - System.String
The name.
RETURNS
Returns the current instance.
Deferred(System.Boolean)
Suppress initialization script rendering. Note that this options should be used in conjunction with
Parameters
deferred - System.Boolean
RETURNS
Returns a DeferredWidgetBuilder instance.
HtmlAttributes(System.Object)
Sets the HTML attributes.
Parameters
attributes - System.Object
The HTML attributes.
RETURNS
Returns the current instance.
HtmlAttributes(System.Collections.Generic.IDictionary)
Sets the HTML attributes.
Parameters
attributes - System.Collections.Generic.IDictionary<String,Object>
The HTML attributes.
RETURNS
Returns the current instance.
ScriptAttributes(System.Object,System.Boolean)
Sets the JavaScript attributes to the initialization script.
Parameters
attributes - System.Object
The JavaScript attributes.
overrideAttributes - System.Boolean
Argument which determines whether attributes should be overriden.
RETURNS
Returns the current instance.
ScriptAttributes(System.Collections.Generic.IDictionary,System.Boolean)
Sets the JavaScript attributes to the initialization script.
Parameters
attributes - System.Collections.Generic.IDictionary<String,Object>
The JavaScript attributes.
overrideAttributes - System.Boolean
Argument which determines whether attributes should be overriden.
RETURNS
Returns the current instance.
Render()
Renders the component in place.
ToHtmlString()
Returns the HTML representation of the component.
WriteTo(System.IO.TextWriter,System.Text.Encodings.Web.HtmlEncoder)
Parameters
writer - System.IO.TextWriter
encoder - System.Text.Encodings.Web.HtmlEncoder
ToClientTemplate()
Returns the client template for the component.
AsModule(System.Boolean)
Specifies whether the initialization script of the component will be rendered as a JavaScript module.
Parameters
value - System.Boolean
RETURNS
Returns the current instance.