Class RadBreadCrumbElement

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
UIItemBase
LightVisualElement
RadBreadCrumbElement
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

public class RadBreadCrumbElement : LightVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IImageElement, ITextPrimitive, ITextProvider

Constructors

RadBreadCrumbElement()

Declaration
public RadBreadCrumbElement()

Fields

DefaultHeightProperty

Declaration
public static RadProperty DefaultHeightProperty
Field Value
RadProperty

IsInEditModeProperty

Declaration
public static RadProperty IsInEditModeProperty
Field Value
RadProperty

SpacingBetweenItemsProperty

Declaration
public static RadProperty SpacingBetweenItemsProperty
Field Value
RadProperty

Properties

AutoCompleteSuggestHelper

Gets the auto complete suggest helper.

Declaration
public BreadCrumbAutoCompleteSuggestHelper AutoCompleteSuggestHelper { get; }
Property Value
BreadCrumbAutoCompleteSuggestHelper

ChildMember

Gets or sets a property name which will be used to define a relation of the data items. Note that this property is ignored when DefaultTreeViewElement is set.

Declaration
public virtual string ChildMember { get; set; }
Property Value
System.String

DataMember

Gets or sets the name of the list or table in the data source. Note that this property is ignored when DefaultTreeViewElement is set.

Declaration
public virtual string DataMember { get; set; }
Property Value
System.String

DataSource

Gets or sets the data source. Note that this property is ignored when DefaultTreeViewElement is set.

Declaration
public virtual object DataSource { get; set; }
Property Value
System.Object

DefaultHeight

Gets or sets the height of the breadcrumb element.

Declaration
public int DefaultHeight { get; set; }
Property Value
System.Int32

DefaultTreeViewElement

Associates a RadTreeViewElement to the bread crumb.

Declaration
public RadTreeViewElement DefaultTreeViewElement { get; set; }
Property Value
RadTreeViewElement

DisplayMember

Gets or sets a property name which will be used to extract the text of the data items. Note that this property is ignored when DefaultTreeViewElement is set.

Declaration
public virtual string DisplayMember { get; set; }
Property Value
System.String

HeaderDropDownButtonElement

Returns the button that contains all collapsed and default items.

Declaration
public BreadCrumbDropDownButtonElement HeaderDropDownButtonElement { get; }
Property Value
BreadCrumbDropDownButtonElement

HistoryDropDownButtonElement

Returns the history button.

Declaration
public BreadCrumbDropDownButtonElement HistoryDropDownButtonElement { get; }
Property Value
BreadCrumbDropDownButtonElement

ImageElement

Returns the LightVisualElement that is used to display the image of selected node.

Declaration
public LightVisualElement ImageElement { get; }
Property Value
LightVisualElement

InternalTreeViewElement

Gets the internal TreeViewElement used in the bread crumb. Note that when DefaultTreeViewElement property is set, this property will be ignored.

Declaration
public RadTreeViewElement InternalTreeViewElement { get; }
Property Value
RadTreeViewElement

IsAutoCompleteEnabled

Gets or sets a value indicating, whether the AutoComplete is enabled in EditMode. By default this property is True.

Declaration
public bool IsAutoCompleteEnabled { get; set; }
Property Value
System.Boolean

IsHistoryEnabled

A property of type bool, which specifies whether history of visited paths should be kept. By default this property is False.

Declaration
public bool IsHistoryEnabled { get; set; }
Property Value
System.Boolean

IsTextModeEnabled

A property of type bool, which controls whether the text mode of the breadcrumb is enabled. By default this property is True.

Declaration
public bool IsTextModeEnabled { get; set; }
Property Value
System.Boolean

Items

Gets the collection of RadSplitButtonElement, which represents the path to the selected RadTreeNode.

Declaration
public RadItemOwnerCollection Items { get; }
Property Value
RadItemOwnerCollection

LeftElementsStack

Returns the panel that contain the elements on the left.

Declaration
public StackLayoutPanel LeftElementsStack { get; }
Property Value
StackLayoutPanel

MainStack

Returns the StackLayoutPanel that holds all Items.

Declaration
public StackLayoutPanel MainStack { get; }
Property Value
StackLayoutPanel

Nodes

Gets the RadTreeNode collection of InternalTreeViewElement.

Declaration
public RadTreeNodeCollection Nodes { get; }
Property Value
RadTreeNodeCollection

The nodes.

ParentMember

Gets or sets a property name which will be used to define a relation of the data items. Note that this property is ignored when DefaultTreeViewElement is set.

Declaration
public virtual string ParentMember { get; set; }
Property Value
System.String

ParseStringComparison

Determines how node names will be compared during when Parse(String) method is called.

Declaration
public StringComparison ParseStringComparison { get; set; }
Property Value
System.StringComparison

Path

Get or sets the path to a RadTreeNode and selects it. Different elements in the node hierarchy must be separated by the PathSeparator.

Declaration
public string Path { get; set; }
Property Value
System.String

PathSeparator

Gets or sets the path separator symbol.

Declaration
public char PathSeparator { get; set; }
Property Value
System.Char

PinnedHeaderItems

Gets the pinned menu items collection in the HeaderDropDownButtonElement. The pinned items are AssociatedMenuItems and allow the user to have shortcuts for faster and easier navigation to predefined paths.

Declaration
public ObservableCollection<AssociatedMenuItem> PinnedHeaderItems { get; }
Property Value
ObservableCollection<AssociatedMenuItem>

PinnedItemsPosition

Gets or sets the position of PinnedHeaderItems in HeaderDropDownButtonElement. The available options are Top and Bottom.

Declaration
public MenuItemsPosition PinnedItemsPosition { get; set; }
Property Value
MenuItemsPosition

RelationBindings

Contains data binding settings for related data. Note that this property is ignored when DefaultTreeViewElement is set.

Declaration
public virtual RelationBindingCollection RelationBindings { get; }
Property Value
RelationBindingCollection

RightElementsStack

Returns the panel that contain the elements on the right.

Declaration
public StackLayoutPanel RightElementsStack { get; }
Property Value
StackLayoutPanel

SelectTreeNodeOnClick

Determines whether a tree node will be selected upon clicking on the action part of the split button element. Default value is [true], if [false] click on the action part will result in opening the pop-up with the menu items.

Declaration
public bool SelectTreeNodeOnClick { get; set; }
Property Value
System.Boolean

ShowHiddenNodes

Gets or sets a value indicating whether to display the hidden RadTreeNodes. A hidden node is a node with set Visible = false.

Declaration
public bool ShowHiddenNodes { get; set; }
Property Value
System.Boolean

SpacingBetweenItems

Gets or sets the spacing between the items in the breadcrumb.

Declaration
public int SpacingBetweenItems { get; set; }
Property Value
System.Int32

TextBoxEditorElement

Returns the RadTextBoxElement

Declaration
public RadTextBoxElement TextBoxEditorElement { get; }
Property Value
RadTextBoxElement

ValueMember

Gets or sets a property name which will be used to extract a value from the data items. Note that this property is ignored when DefaultTreeViewElement is set.

Declaration
public virtual string ValueMember { get; set; }
Property Value
System.String

Methods

ArrangeOverride(SizeF)

Declaration
protected override SizeF ArrangeOverride(SizeF finalSize)
Parameters
System.Drawing.SizeF finalSize

Returns
System.Drawing.SizeF

Overrides

BeginEdit()

Declaration
public virtual void BeginEdit()

ClearCollapsedItems()

Declaration
protected virtual void ClearCollapsedItems()

ClearRootItems()

Declaration
protected virtual void ClearRootItems()

CreateAutoCompleteSuggestHelper()

Declaration
protected virtual BreadCrumbAutoCompleteSuggestHelper CreateAutoCompleteSuggestHelper()
Returns
BreadCrumbAutoCompleteSuggestHelper

CreateChildElements()

Declaration
protected override void CreateChildElements()
Overrides

CreateDefaultTreeViewElement()

Declaration
protected virtual RadTreeViewElement CreateDefaultTreeViewElement()
Returns
RadTreeViewElement

CreateHeaderDropDownButtonElement()

Declaration
protected virtual BreadCrumbDropDownButtonElement CreateHeaderDropDownButtonElement()
Returns
BreadCrumbDropDownButtonElement

CreateHistoryDropDownButtonElement()

Declaration
protected virtual BreadCrumbDropDownButtonElement CreateHistoryDropDownButtonElement()
Returns
BreadCrumbDropDownButtonElement

CreateImageElement()

Declaration
protected virtual LightVisualElement CreateImageElement()
Returns
LightVisualElement

CreateLeftElementsStack()

Declaration
protected virtual StackLayoutPanel CreateLeftElementsStack()
Returns
StackLayoutPanel

CreateMainElementsStack()

Declaration
protected virtual StackLayoutPanel CreateMainElementsStack()
Returns
StackLayoutPanel

CreateRightElementsStack()

Declaration
protected virtual StackLayoutPanel CreateRightElementsStack()
Returns
StackLayoutPanel

CreateSeparatorItem()

Declaration
protected virtual RadMenuSeparatorItem CreateSeparatorItem()
Returns
RadMenuSeparatorItem

CreateSplitButtonElement()

Declaration
protected virtual RadSplitButtonElement CreateSplitButtonElement()
Returns
RadSplitButtonElement

CreateTextBoxElement()

Declaration
protected virtual RadTextBoxElement CreateTextBoxElement()
Returns
RadTextBoxElement

EndEdit(Boolean)

Declaration
public virtual void EndEdit(bool submit)
Parameters
System.Boolean submit

FindNodeFromToken(String, RadTreeNode)

c Finds the node by given text(token) and a the parent node in whose child nodes we need to search for the node. If parentNode is null search starts from the top most level of nodes.

Declaration
protected virtual RadTreeNode FindNodeFromToken(string token, RadTreeNode parentNode)
Parameters
System.String token

RadTreeNode parentNode

Returns
RadTreeNode

GetItemText(RadSplitButtonElement)

Declaration
protected virtual string GetItemText(RadSplitButtonElement splitButton)
Parameters
RadSplitButtonElement splitButton

Returns
System.String

GetNodePath(RadTreeNode)

Declaration
public virtual string GetNodePath(RadTreeNode node)
Parameters
RadTreeNode node

Returns
System.String

GetNodesCount(RadTreeNodeCollection)

Declaration
public int GetNodesCount(RadTreeNodeCollection nodes)
Parameters
RadTreeNodeCollection nodes

Returns
System.Int32

GetNodeText(RadTreeNode)

Declaration
protected virtual string GetNodeText(RadTreeNode node)
Parameters
RadTreeNode node

Returns
System.String

GetPathFromItems()

Declaration
public virtual string GetPathFromItems()
Returns
System.String

GetRootNodes()

Declaration
protected virtual IList<RadTreeNode> GetRootNodes()
Returns
System.Collections.Generic.IList<RadTreeNode>

InitializeFields()

Declaration
protected override void InitializeFields()
Overrides

IsHeaderButtonPermanentlyVisible()

Declaration
protected virtual bool IsHeaderButtonPermanentlyVisible()
Returns
System.Boolean

MeasureOverride(SizeF)

Declaration
protected override SizeF MeasureOverride(SizeF availableSize)
Parameters
System.Drawing.SizeF availableSize

Returns
System.Drawing.SizeF

Overrides

OnAutoCompleteItemsCreated(Object, AutoCompleteItemsCreatedEventArgs)

Fires the AutoCompleteItemsCreated event.

Declaration
protected virtual void OnAutoCompleteItemsCreated(object sender, AutoCompleteItemsCreatedEventArgs e)
Parameters
System.Object sender

The sender.
AutoCompleteItemsCreatedEventArgs e

The AutoCompleteItemsCreatedEventArgs instance containing the event data.

OnAutoCompleteItemsCreating(Object, AutoCompleteItemsCreatingEventArgs)

Fires the AutoCompleteItemsCreating event.

Declaration
protected virtual void OnAutoCompleteItemsCreating(object sender, AutoCompleteItemsCreatingEventArgs e)
Parameters
System.Object sender

The sender.
AutoCompleteItemsCreatingEventArgs e

The AutoCompleteItemsCreatingEventArgs instance containing the event data.

OnCollapsedItemCreated(Object, AssociatedMenuItemEventArgs)

Fires the CollapsedItemCreated event.

Declaration
protected virtual void OnCollapsedItemCreated(object sender, AssociatedMenuItemEventArgs e)
Parameters
System.Object sender

The sender.
AssociatedMenuItemEventArgs e

The AssociatedMenuItemEventArgs instance containing the event data.

OnCollapsedItemsCreated(Object, AssociatedMenuItemCollectionEventArgs)

Fires the CollapsedItemsCreated event.

Declaration
protected virtual void OnCollapsedItemsCreated(object sender, AssociatedMenuItemCollectionEventArgs e)
Parameters
System.Object sender

The sender.
AssociatedMenuItemCollectionEventArgs e

The AssociatedMenuItemCollectionEventArgs instance containing the event data.

OnHistoryItemCreated(Object, AssociatedMenuItemEventArgs)

Fires the HistoryItemCreated event. Setting the Cancel property of AssociatedMenuItemEventArgs to [true] will prevent the item from being added to the history.

Declaration
protected virtual void OnHistoryItemCreated(object sender, AssociatedMenuItemEventArgs e)
Parameters
System.Object sender

The sender.
AssociatedMenuItemEventArgs e

The AssociatedMenuItemEventArgs instance containing the event data.

OnKeyUp(KeyEventArgs)

Declaration
protected override void OnKeyUp(KeyEventArgs e)
Parameters
System.Windows.Forms.KeyEventArgs e

Overrides

OnMouseDown(MouseEventArgs)

Declaration
protected override void OnMouseDown(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

Overrides

OnPathParsed(Object, PathParsedEventArgs)

Fires the PathParsed event.

Declaration
protected virtual void OnPathParsed(object sender, PathParsedEventArgs e)
Parameters
System.Object sender

The sender.
PathParsedEventArgs e

The PathParsedEventArgs instance containing the event data.

OnPathParsing(Object, PathParsingEventArgs)

Fires the PathParsing event.

Declaration
protected virtual void OnPathParsing(object sender, PathParsingEventArgs e)
Parameters
System.Object sender

The sender.
PathParsingEventArgs e

The PathParsingEventArgs instance containing the event data.

OnPropertyChanged(RadPropertyChangedEventArgs)

Declaration
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

Overrides

OnRootNodesRequested(Object, TreeNodeCollectionEventArgs)

Fires the RootNodesRequested event.

Declaration
protected virtual void OnRootNodesRequested(object sender, TreeNodeCollectionEventArgs e)
Parameters
System.Object sender

The sender.
TreeNodeCollectionEventArgs e

The TreeNodeCollectionEventArgs instance containing the event data.

OnSplitButtonCreated(Object, SplitButtonCreatedEventArgs)

Fires the SplitButtonCreated event.

Declaration
protected virtual void OnSplitButtonCreated(object sender, SplitButtonCreatedEventArgs e)
Parameters
System.Object sender

The sender.
SplitButtonCreatedEventArgs e

The SplitButtonCreatedEventArgs instance containing the event data.

OnSplitButtonCreating(Object, SplitButtonCreatingEventArgs)

Fires the SplitButtonCreating event.

Declaration
protected virtual void OnSplitButtonCreating(object sender, SplitButtonCreatingEventArgs e)
Parameters
System.Object sender

The sender.
SplitButtonCreatingEventArgs e

The SplitButtonCreatingEventArgs instance containing the event data.

Parse(String)

Navigates to a RadTreeNode and selects it by given text(path). Different elements in the node hierarchy must be separated by the PathSeparator.

Declaration
public virtual bool Parse(string path)
Parameters
System.String path

The path to navigate to.
Returns
System.Boolean

Returns [true] if the whole path is valid, [False] if only part of the path(sequence of text elements separated by the PathSeparator) is valid or no element is valid.

ParseCore(String, out Boolean)

Retrieves a node by given path.

Declaration
public virtual RadTreeNode ParseCore(string path, out bool isWholePathValid)
Parameters
System.String path

The path to navigate to.
System.Boolean isWholePathValid

Returns [true] if the whole path is valid, [False] if only part of the path(sequence of text elements separated by the PathSeparator) is valid or none element is valid.
Returns
RadTreeNode

The last valid RadTreeNode selected from the given path.

ShouldArrangeChild(RadElement)

Declaration
protected override bool ShouldArrangeChild(RadElement child)
Parameters
RadElement child

Returns
System.Boolean

Overrides

ShouldMeasureChild(RadElement)

Declaration
protected override bool ShouldMeasureChild(RadElement child)
Parameters
RadElement child

Returns
System.Boolean

Overrides

UpdateBreadCrumb(RadTreeNode)

Declaration
public void UpdateBreadCrumb(RadTreeNode node)
Parameters
RadTreeNode node

UpdateHeaderButtonItems()

Declaration
protected virtual void UpdateHeaderButtonItems()

UpdateHistory(RadTreeNode)

Declaration
protected virtual void UpdateHistory(RadTreeNode node)
Parameters
RadTreeNode node

Events

AutoCompleteItemsCreated

Occurs when auto complete items are created. In this event handler the user can modify auto complete item properties and/or modify the collection(add, remove, move or replace items).

Declaration
public event AutoCompleteItemsCreatedEventHandler AutoCompleteItemsCreated
Event Type
AutoCompleteItemsCreatedEventHandler

AutoCompleteItemsCreating

In this event handler the user can change the text used by the internal logic to generate the auto-complete items. Suitable for cases when you have shortcuts.

Declaration
public event AutoCompleteItemsCreatingEventHandler AutoCompleteItemsCreating
Event Type
AutoCompleteItemsCreatingEventHandler

CollapsedItemCreated

Occurs when there is not enough space to fit all items. For each collapsed item an AssociatedMenuItem is created and this event is raised. In this event handler the user can replace the AssociatedMenuItem with a custom one, modify some of the properties of the existing one or set Cancel=true to prevent the item from being added to the collapsed items.

Declaration
public event AssociatedMenuItemEventHandler CollapsedItemCreated
Event Type
AssociatedMenuItemEventHandler

CollapsedItemsCreated

Occurs when there is not enough space to fit all items and all collapsed items have their corresponding menu items created. In this event handler the user can add, remove, reorder the items in that will appear as collapsed.

Declaration
public event AssociatedMenuItemCollectionEventHandler CollapsedItemsCreated
Event Type
AssociatedMenuItemCollectionEventHandler

HistoryItemCreated

Occurs when the user navigates to a new Path. In this event handler the user can modify the AssociatedMenuItem or set Cancel=true to prevent the item from being added to the history.

Declaration
public event AssociatedMenuItemEventHandler HistoryItemCreated
Event Type
AssociatedMenuItemEventHandler

PathParsed

Occurs when a path has been evaluated and a RadTreeNode is about to be selected in the BreadCrumb. In this event handler the user can change selected RadTreeNode. Note that if parsed path is not valid selected node will be null.

Declaration
public event PathParsedEventHandler PathParsed
Event Type
PathParsedEventHandler

PathParsing

Occurs when a path is about to be parsed. In this event handler the user can modify the path(for example if key/shortcut words are used), or cancel the parse operation.

Declaration
public event PathParsingEventHandler PathParsing
Event Type
PathParsingEventHandler

RootNodesRequested

Occurs when the root nodes of the associated or internal tree view are requested during the Parse operation. In this event handler the user can modify the default root nodes(add, remove, replace).

Declaration
public event TreeNodeCollectionEventHandler RootNodesRequested
Event Type
TreeNodeCollectionEventHandler

SplitButtonCreated

Occurs a SplitButtonElement is created, its properties . In this event handler the users can set button properties, modify item properties or modify the collection(add, remove, replace items).

Declaration
public event SplitButtonCreatedEventHandler SplitButtonCreated
Event Type
SplitButtonCreatedEventHandler

SplitButtonCreating

Occurs when a RadSplitButtonElement is being created. In this event handler the users can replace the button with a custom one or cancel creating RadSplitButtonElement for the associated RadTreeNode.

Declaration
public event SplitButtonCreatingEventHandler SplitButtonCreating
Event Type
SplitButtonCreatingEventHandler

Extension Methods