Back to all docs
API Reference / Telerik.Windows.Controls / RadBreadcrumb

Class
RadBreadcrumb

Provides a navigation control that allows users to easily keep track of their locations within applications or documents. The RadBreadcrumb class supports hierarchical navigation by enabling users to navigate through a breadcrumb-like interface. This control is designed for flexibility, allowing customization of item templates, styles, and various user interaction modes, including text input for quick navigation. It supports features such as history tracking and dynamic item modification, ensuring a seamless user experience while navigating complex data structures or documentation.

Definition

Namespace:Telerik.Windows.Controls

Assembly:Telerik.Windows.Controls.Navigation.dll

Syntax:
cs-api-definition
[SuppressMessage("Microsoft.Design", "CA1001:TypesThatOwnDisposableFieldsShouldBeDisposable")]
[TelerikToolboxCategory("Navigation")]
[Themable]
public class RadBreadcrumb : HeaderedItemsControl

Inheritance: objectRadBreadcrumb

Derived Classes: FileDialogsBreadcrumb

Constructors

RadBreadcrumb()

Initializes a new instance of the RadBreadcrumb class.

Declaration

cs-api-definition
public RadBreadcrumb()

Fields

AutocompleteItemsProperty

Identifies the AutocompleteItems dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty AutocompleteItemsProperty

Field Value

DependencyProperty

CurrentContainerProperty

Identifies the CurrentContainer dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty CurrentContainerProperty

Field Value

DependencyProperty

CurrentItemChangedEvent

Occurs after RadBreadcrumb.

Declaration

cs-api-definition
public static readonly RoutedEvent CurrentItemChangedEvent

Field Value

RoutedEvent

CurrentItemProperty

Identifies the CurrentItem dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty CurrentItemProperty

Field Value

DependencyProperty

HeaderMemberPathProperty

Identifies the HeaderMemberPath dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty HeaderMemberPathProperty

Field Value

DependencyProperty

HierarchicalItemsSourceProperty

Identifies the HierarchicalItemsSource dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty HierarchicalItemsSourceProperty

Field Value

DependencyProperty

HierarchicalMemberPathProperty

Identifies the HierarchicalMemberPath dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty HierarchicalMemberPathProperty

Field Value

DependencyProperty

HistoryItemsProperty

Identifies the HistoryItems dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty HistoryItemsProperty

Field Value

DependencyProperty

HistorySizeProperty

Identifies the HistorySize dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty HistorySizeProperty

Field Value

DependencyProperty

IconPathProperty

Identifies the IconPath dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty IconPathProperty

Field Value

DependencyProperty

IsHistoryEnabledProperty

Identifies the IsHistoryEnabled dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsHistoryEnabledProperty

Field Value

DependencyProperty

IsHistoryOpenProperty

Identifies the IsHistoryOpen dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsHistoryOpenProperty

Field Value

DependencyProperty

IsIconVisibleProperty

Identifies the IsIconVisible dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsIconVisibleProperty

Field Value

DependencyProperty

IsLinearModeProperty

Identifies the IsLinearMode dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsLinearModeProperty

Field Value

DependencyProperty

IsTextModeEnabledProperty

Identifies the IsTextModeEnabled dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsTextModeEnabledProperty

Field Value

DependencyProperty

IsTextModeProperty

Identifies the IsTextMode dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsTextModeProperty

Field Value

DependencyProperty

OverflowButtonStyleProperty

Identifies the OverflowButtonStyle dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty OverflowButtonStyleProperty

Field Value

DependencyProperty

PathProperty

Identifies the Path dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty PathProperty

Field Value

DependencyProperty

PathSeparatorProperty

Identifies the PathSeparator dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty PathSeparatorProperty

Field Value

DependencyProperty

SelectedHistoryItemProperty

Identifies the SelectedHistoryItem dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty SelectedHistoryItemProperty

Field Value

DependencyProperty

SplitButtonStyleProperty

Identifies the SplitButtonStyle dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty SplitButtonStyleProperty

Field Value

DependencyProperty

StringComparisonProperty

Identifies the StringComparison dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty StringComparisonProperty

Field Value

DependencyProperty

TextModePathProperty

Identifies the Path dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty TextModePathProperty

Field Value

DependencyProperty

Properties

CurrentContainer

Gets or sets the CurrentContainer.

Declaration

cs-api-definition
public RadBreadcrumbBarItem CurrentContainer { get; }

Property Value

RadBreadcrumbBarItem

CurrentItem

Gets or sets the CurrentItem property.

Declaration

cs-api-definition
public object CurrentItem { get; set; }

Property Value

object

HeaderMemberPath

Gets or sets the HeaderMemberPath property.

Declaration

cs-api-definition
public string HeaderMemberPath { get; set; }

Property Value

string

HierarchicalItemsSource

Gets or sets the HierarchicalItemsSource property.

Declaration

cs-api-definition
public string HierarchicalItemsSource { get; set; }

Property Value

string

HierarchicalMemberPath

Gets or sets the HierarchicalMemberPath property.

Declaration

cs-api-definition
public string HierarchicalMemberPath { get; set; }

Property Value

string

HistoryItems

Gets or sets the HistoryItems property.

Declaration

cs-api-definition
public ObservableCollection<object> HistoryItems { get; }

Property Value

ObservableCollection<object>

HistorySize

Gets or sets the HistorySize property.

Declaration

cs-api-definition
public int HistorySize { get; set; }

Property Value

int

ImagePath

Gets or sets the ImagePath property.

Declaration

cs-api-definition
public string ImagePath { get; set; }

Property Value

string

IsHistoryEnabled

Gets or sets the IsHistoryEnabled property.

Declaration

cs-api-definition
public bool IsHistoryEnabled { get; set; }

Property Value

bool

IsHistoryOpen

Gets or sets the IsHistoryOpen property.

Declaration

cs-api-definition
public bool IsHistoryOpen { get; set; }

Property Value

bool

IsIconVisible

Gets or sets the IsIconVisible property.

Declaration

cs-api-definition
public bool IsIconVisible { get; set; }

Property Value

bool

IsLinearMode

Gets or sets the IsLinearMode property.

Declaration

cs-api-definition
public bool IsLinearMode { get; set; }

Property Value

bool

IsTextMode

Gets or sets the IsTextMode property.

Declaration

cs-api-definition
public bool IsTextMode { get; set; }

Property Value

bool

IsTextModeEnabled

Gets or sets the IsTextModeEnabled property.

Declaration

cs-api-definition
public bool IsTextModeEnabled { get; set; }

Property Value

bool

ItemContainerGenerator

Get the ItemContainerGenerator.

Declaration

cs-api-definition
public ItemContainerGenerator ItemContainerGenerator { get; }

Property Value

ItemContainerGenerator

OverflowButtonStyle

Gets or sets the style of Overflow split button.

Declaration

cs-api-definition
public Style OverflowButtonStyle { get; set; }

Property Value

Style

Path

Gets or sets the Path property.

Declaration

cs-api-definition
public string Path { get; set; }

Property Value

string

PathSeparator

Gets or sets the delimiter string that the tree item path uses.

Declaration

cs-api-definition
public string PathSeparator { get; set; }

Property Value

string

RootContainer

Get the RootContainer.

Declaration

cs-api-definition
public RadBreadcrumbBarItem RootContainer { get; }

Property Value

RadBreadcrumbBarItem

SplitButtonStyle

Gets or sets the style of RadBreadcrumb split button.

Declaration

cs-api-definition
public Style SplitButtonStyle { get; set; }

Property Value

Style

StringComparison

Gets or sets the type of the string comparison.

Declaration

cs-api-definition
public StringComparison StringComparison { get; set; }

Property Value

StringComparison

The type of the string comparison.

TextModePath

Gets or sets the Path property.

Declaration

cs-api-definition
public string TextModePath { get; set; }

Property Value

string

Methods

OnApplyTemplate()

Applies the template for the RadBreadcrumb.

Declaration

cs-api-definition
public override void OnApplyTemplate()

OnCreateAutomationPeer()

Returns class-specific AutomationPeer implementations for the Windows Presentation Foundation (WPF) infrastructure.

Declaration

cs-api-definition
protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer

The type-specific AutomationPeer implementation.

OnCurrentItemChanged(RadRoutedEventArgs)

Raises the event.

Declaration

cs-api-definition
protected virtual void OnCurrentItemChanged(RadRoutedEventArgs e)

Parameters

e

RadRoutedEventArgs

The RadRoutedEventArgs instance containing the event data.

OnCurrentItemChanged(object, object)

Invoked when the CurrentItem property changes.

Declaration

cs-api-definition
protected virtual void OnCurrentItemChanged(object oldValue, object newValue)

Parameters

oldValue

object

newValue

object

OnGotFocus(RoutedEventArgs)

Called before the event occurs.

Declaration

cs-api-definition
protected override void OnGotFocus(RoutedEventArgs e)

Parameters

e

RoutedEventArgs

The data for the event.

OnHeaderChanged(object, object)

Invoked when the Header property changes.

Declaration

cs-api-definition
protected override void OnHeaderChanged(object oldHeader, object newHeader)

Parameters

oldHeader

object

newHeader

object

OnInitialized(EventArgs)

Raises the event. This method is invoked whenever is set to true internally.

Declaration

cs-api-definition
protected override void OnInitialized(EventArgs e)

Parameters

e

EventArgs

The RoutedEventArgs that contains the event data.

OnIsAutomaticHistoryEnabledChanged(bool, bool)

Invoked when the IsHistoryEnabled property changes.

Declaration

cs-api-definition
protected virtual void OnIsAutomaticHistoryEnabledChanged(bool oldValue, bool newValue)

Parameters

oldValue

bool

newValue

bool

OnIsIconVisibleChanged(bool, bool)

Invoked when the IsIconVisible property changes.

Declaration

cs-api-definition
protected virtual void OnIsIconVisibleChanged(bool oldValue, bool newValue)

Parameters

oldValue

bool

newValue

bool

OnIsLinearModeChanged(bool, bool)

Invoked when the IsLinearMode property changes.

Declaration

cs-api-definition
protected virtual void OnIsLinearModeChanged(bool oldValue, bool newValue)

Parameters

oldValue

bool

newValue

bool

OnIsTextModeEnabledChanged(bool, bool)

Invoked when the IsTextModeEnabled property changes.

Declaration

cs-api-definition
protected virtual void OnIsTextModeEnabledChanged(bool oldValue, bool newValue)

Parameters

oldValue

bool

newValue

bool

OnItemsChanged(NotifyCollectionChangedEventArgs)

Invoked when the Items property changes.

Declaration

cs-api-definition
protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)

Parameters

e

NotifyCollectionChangedEventArgs

OnKeyDown(KeyEventArgs)

Called before the event occurs.

Declaration

cs-api-definition
protected override void OnKeyDown(KeyEventArgs e)

Parameters

e

KeyEventArgs

The data for the event.

OnLostFocus(RoutedEventArgs)

Called before the event occurs.

Declaration

cs-api-definition
protected override void OnLostFocus(RoutedEventArgs e)

Parameters

e

RoutedEventArgs

The data for the event.

OnMouseLeftButtonDown(MouseButtonEventArgs)

Invoked on MouseLeftButtonDown.

Declaration

cs-api-definition
protected override void OnMouseLeftButtonDown(MouseButtonEventArgs e)

Parameters

e

MouseButtonEventArgs

OnMouseWheel(MouseWheelEventArgs)

Declaration

cs-api-definition
protected override void OnMouseWheel(MouseWheelEventArgs e)

Parameters

e

MouseWheelEventArgs

OnOverflowButtonStyleChanged(Style, Style)

Invoked when the OverflowButtonStyle property changes.

Declaration

cs-api-definition
protected virtual void OnOverflowButtonStyleChanged(Style oldValue, Style newValue)

Parameters

oldValue

Style

newValue

Style

OnPathChanged(string, string)

Invoked when the Path property changes.

Declaration

cs-api-definition
protected virtual void OnPathChanged(string oldValue, string newValue)

Parameters

oldValue

string

newValue

string

OnPathSeparatorChanged(string, string)

Invoked when the PathSeparator property changes.

Declaration

cs-api-definition
protected virtual void OnPathSeparatorChanged(string oldValue, string newValue)

Parameters

oldValue

string

newValue

string

OnSplitButtonStyleChanged(Style, Style)

Invoked when the SplitButtonStyle property changes.

Declaration

cs-api-definition
protected virtual void OnSplitButtonStyleChanged(Style oldValue, Style newValue)

Parameters

oldValue

Style

newValue

Style

ResetTheme()

Resets the theme.

Declaration

cs-api-definition
public void ResetTheme()

Events

CurrentItemChanged

Occurs after RadBreadcrumb.

Declaration

cs-api-definition
public event EventHandler<RadRoutedEventArgs> CurrentItemChanged

Event Value

EventHandler<RadRoutedEventArgs>

In this article
DefinitionConstructorsRadBreadcrumb()FieldsAutocompleteItemsPropertyCurrentContainerPropertyCurrentItemChangedEventCurrentItemPropertyHeaderMemberPathPropertyHierarchicalItemsSourcePropertyHierarchicalMemberPathPropertyHistoryItemsPropertyHistorySizePropertyIconPathPropertyIsHistoryEnabledPropertyIsHistoryOpenPropertyIsIconVisiblePropertyIsLinearModePropertyIsTextModeEnabledPropertyIsTextModePropertyOverflowButtonStylePropertyPathPropertyPathSeparatorPropertySelectedHistoryItemPropertySplitButtonStylePropertyStringComparisonPropertyTextModePathPropertyPropertiesCurrentContainerCurrentItemHeaderMemberPathHierarchicalItemsSourceHierarchicalMemberPathHistoryItemsHistorySizeImagePathIsHistoryEnabledIsHistoryOpenIsIconVisibleIsLinearModeIsTextModeIsTextModeEnabledItemContainerGeneratorOverflowButtonStylePathPathSeparatorRootContainerSplitButtonStyleStringComparisonTextModePathMethodsOnApplyTemplate()OnCreateAutomationPeer()OnCurrentItemChanged(RadRoutedEventArgs)OnCurrentItemChanged(object, object)OnGotFocus(RoutedEventArgs)OnHeaderChanged(object, object)OnInitialized(EventArgs)OnIsAutomaticHistoryEnabledChanged(bool, bool)OnIsIconVisibleChanged(bool, bool)OnIsLinearModeChanged(bool, bool)OnIsTextModeEnabledChanged(bool, bool)OnItemsChanged(NotifyCollectionChangedEventArgs)OnKeyDown(KeyEventArgs)OnLostFocus(RoutedEventArgs)OnMouseLeftButtonDown(MouseButtonEventArgs)OnMouseWheel(MouseWheelEventArgs)OnOverflowButtonStyleChanged(Style, Style)OnPathChanged(string, string)OnPathSeparatorChanged(string, string)OnSplitButtonStyleChanged(Style, Style)ResetTheme()EventsCurrentItemChanged
Not finding the help you need?
Contact Support