Introduction
Knowledge Base
API Reference / Server-side / Telerik.Web.UI / RadBreadcrumb
New to Telerik UI for ASP.NET AJAX? Start a free 30-day trial

RadBreadcrumb

Class

Server-side Breadcrumb navigation control representing the current page path and providing optional editing and navigation. Configure appearance and behavior through its public properties (e.g. Items, Value, Navigational) and handle client events via ClientEvents.

Definition

Namespace:Telerik.Web.UI

Assembly:Telerik.Web.UI.dll

Syntax:
C#
[ToolboxBitmap(typeof(RadBreadcrumb), "Toolbox.Icons.Breadcrumb.png")]
[RequiredScript(typeof(jQueryPlugins))]
[RequiredScript(typeof(Html5Breadcrumb))]
[ClientScriptResource("Telerik.Web.UI.RadBreadcrumb", "Telerik.Web.UI.Breadcrumb.Scripts.RadBreadcrumb.js")]
[EmbeddedSkin("Breadcrumb", typeof(RadBreadcrumb))]
[EmbeddedSkin("Breadcrumb", "Default", typeof(RadBreadcrumb))]
[RequiredCss("Telerik.Web.UI.Skins.Common.common.css", RenderMode.Classic, typeof(RadBreadcrumb))]
[RequiredCss("Telerik.Web.UI.Skins.Common.common.css", RenderMode.Lightweight, typeof(RadBreadcrumb))]
[RequiredCss("Telerik.Web.UI.Skins.Common.common.css", RenderMode.Mobile, typeof(RadBreadcrumb))]
[RequiredCss("Telerik.Web.UI.Skins.Common.fonticons.css", RenderMode.Classic, typeof(RadBreadcrumb))]
[RequiredCss("Telerik.Web.UI.Skins.Common.fonticons.css", RenderMode.Lightweight, typeof(RadBreadcrumb))]
[RequiredCss("Telerik.Web.UI.Skins.Common.fonticons.css", RenderMode.Mobile, typeof(RadBreadcrumb))]
public class RadBreadcrumb : RadWebControl, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor, IScriptControl, IControlResolver, IPostBackDataHandler, ISkinnableControl, IControl

Inheritance: objectControlWebControlRadWebControlRadBreadcrumb

Implements: IAttributeAccessorIComponentIControlIControlBuilderAccessorIControlDesignerAccessorIControlResolverIDataBindingsAccessorIDisposableIExpressionsAccessorIParserAccessorIPostBackDataHandlerIScriptControlISkinnableControlIUrlResolutionService...

Inherited Members WebControl.AddAttributesToRender(HtmlTextWriter)WebControl.ApplyStyle(Style)WebControl.CopyBaseAttributes(WebControl)WebControl.CreateControlStyle()WebControl.MergeStyle(Style)WebControl.Render(HtmlTextWriter)WebControl.RenderBeginTag(HtmlTextWriter)WebControl.RenderEndTag(HtmlTextWriter)WebControl.RenderContents(HtmlTextWriter)WebControl.AccessKeyWebControl.AttributesWebControl.BackColorWebControl.BorderColorWebControl.BorderWidthWebControl.BorderStyleWebControl.ControlStyleWebControl.ControlStyleCreatedWebControl.CssClassWebControl.DisabledCssClassWebControl.StyleWebControl.EnabledWebControl.EnableThemingWebControl.FontWebControl.ForeColorWebControl.HasAttributesWebControl.HeightWebControl.IsEnabledWebControl.SupportsDisabledAttributeWebControl.SkinIDWebControl.TabIndexWebControl.TagNameWebControl.ToolTipWebControl.WidthControl.ResolveAdapter()Control.HasEvents()Control.GetRouteUrl(object)Control.GetRouteUrl(string, object)Control.GetRouteUrl(RouteValueDictionary)Control.GetRouteUrl(string, RouteValueDictionary)Control.GetUniqueIDRelativeTo(Control)Control.ApplyStyleSheetSkin(Page)Control.OnDataBinding(EventArgs)Control.DataBind()Control.DataBind(bool)Control.DataBindChildren()Control.AddParsedSubObject(object)Control.EnsureID()Control.OnInit(EventArgs)Control.ClearChildState()Control.ClearChildControlState()Control.ClearChildViewState()Control.ClearEffectiveClientIDMode()Control.ClearCachedClientID()Control.Focus()Control.LoadControlState(object)Control.MapPathSecure(string)Control.OpenFile(string)Control.OnLoad(EventArgs)Control.BuildProfileTree(string, bool)Control.SaveControlState()Control.RenderChildren(HtmlTextWriter)Control.RenderControl(HtmlTextWriter)Control.RenderControl(HtmlTextWriter, ControlAdapter)Control.OnUnload(EventArgs)Control.Dispose()Control.RaiseBubbleEvent(object, EventArgs)Control.OnBubbleEvent(object, EventArgs)Control.AddedControl(Control, int)Control.CreateControlCollection()Control.CreateChildControls()Control.ResolveUrl(string)Control.ResolveClientUrl(string)Control.FindControl(string)Control.FindControl(string, int)Control.GetDesignModeState()Control.HasControls()Control.IsLiteralContent()Control.EnsureChildControls()Control.RemovedControl(Control)Control.SetDesignModeState(IDictionary)Control.SetRenderMethodDelegate(RenderMethod)Control.ClientIDModeControl.ClientIDControl.ClientIDSeparatorControl.ContextControl.AdapterControl.DesignModeControl.EventsControl.IDControl.IsChildControlStateClearedControl.EnableViewStateControl.ViewStateModeControl.IsViewStateEnabledControl.NamingContainerControl.IdSeparatorControl.LoadViewStateByIDControl.PageControl.RenderingCompatibilityControl.TemplateControlControl.ParentControl.TemplateSourceDirectoryControl.AppRelativeTemplateSourceDirectoryControl.SiteControl.VisibleControl.UniqueIDControl.HasChildViewStateControl.ControlsControl.ValidateRequestModeControl.ViewStateControl.ViewStateIgnoresCaseControl.ChildControlsCreatedControl.IsTrackingViewStateControl.DisposedControl.DataBindingControl.InitControl.LoadControl.PreRenderControl.Unloadobject.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()object.GetType()object.MemberwiseClone()...

Constructors

RadBreadcrumb()

Initializes a new instance of the RadBreadcrumb control and registers required JavaScript converters.

C#
public RadBreadcrumb()

Properties

BindToLocation

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

C#
public bool BindToLocation { get; set; }

ClientEvents

Defines the client events handlers.

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public BreadcrumbClientEvents ClientEvents { get; }

ClientItemTemplate

The template used to render the items in the breadcrumb.

C#
[Browsable(true)]
[Bindable(true)]
[PersistenceMode(PersistenceMode.InnerProperty)]
public string ClientItemTemplate { get; set; }

CssClassFormatString

The CssClass property will now be used instead of the former Skin and will be modified in AddAttributesToRender()

C#
protected override string CssClassFormatString { get; }

Overrides: RadWebControl.CssClassFormatString

Example:
C#
protected override string CssClassFormatString
{
       get
       {
           return "RadDock RadDock_{0} rdWTitle rdWFooter";
       }
}

DelimiterIcon

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.

C#
public string DelimiterIcon { get; set; }

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.

C#
public bool Editable { get; set; }

Gap

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.

C#
public double Gap { get; set; }

Items

Array of items to be rendered in Breadcrumb.

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public BreadcrumbItemsCollection Items { get; }

MessagesSettings

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

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public Messages MessagesSettings { get; }

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.

C#
public bool Navigational { get; set; }

RootIcon

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.

C#
public string RootIcon { get; set; }

TagKey

C#
protected override HtmlTextWriterTag TagKey { get; }

Overrides: WebControl.TagKey

Value

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

C#
public string Value { get; set; }

Methods

DescribeClientEvents(IScriptDescriptor)

C#
protected override void DescribeClientEvents(IScriptDescriptor descriptor)
Parameters:descriptorIScriptDescriptor

Overrides: RadWebControl.DescribeClientEvents(IScriptDescriptor)

DescribeComponent(IScriptDescriptor)

C#
protected override void DescribeComponent(IScriptDescriptor descriptor)
Parameters:descriptorIScriptDescriptor

Overrides: RadWebControl.DescribeComponent(IScriptDescriptor)

LoadViewState(object)

C#
protected override void LoadViewState(object state)
Parameters:stateobject

Overrides: WebControl.LoadViewState(object)

OnPreRender(EventArgs)

C#
protected override void OnPreRender(EventArgs e)
Parameters:eEventArgs

Overrides: RadWebControl.OnPreRender(EventArgs)

SaveViewState()

C#
protected override object SaveViewState()
Returns:

object

Overrides: WebControl.SaveViewState()

TrackViewState()

C#
protected override void TrackViewState()

Overrides: WebControl.TrackViewState()

In this article
DefinitionConstructorsRadBreadcrumb()PropertiesBindToLocationClientEventsClientItemTemplateCssClassFormatStringDelimiterIconEditableGapItemsMessagesSettingsNavigationalRootIconTagKeyValueMethodsDescribeClientEvents(IScriptDescriptor)DescribeComponent(IScriptDescriptor)LoadViewState(object)OnPreRender(EventArgs)SaveViewState()TrackViewState()
Not finding the help you need?
Contact Support