Class RadBreadCrumb

Inheritance
System.Object
RadControl
RadEditorControl
RadBreadCrumb
FileDialogsBreadcrumb
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

public class RadBreadCrumb : RadEditorControl, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider

Constructors

RadBreadCrumb()

Declaration
public RadBreadCrumb()

Properties

AutoCompleteSuggestHelper

Gets the auto complete suggest helper.

Declaration
public BreadCrumbAutoCompleteSuggestHelper AutoCompleteSuggestHelper { get; }
Property Value
BreadCrumbAutoCompleteSuggestHelper

AutoSize

Gets or sets whether the edit control is auto-sized.

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

Overrides

BreadCrumbElement

Gets the breadCrumb element.

Declaration
public virtual RadBreadCrumbElement BreadCrumbElement { get; }
Property Value
RadBreadCrumbElement

ChildMember

Gets or sets the child member. Note that this property is ignored when DefaultTreeView is set.

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

The child member.

DataMember

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

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

DataSource

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

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

DefaultSize

Declaration
protected override Size DefaultSize { get; }
Property Value
System.Drawing.Size

DefaultTreeView

Gets or sets a RadTreeView associated to the bread crumb.

Declaration
public RadTreeView DefaultTreeView { get; set; }
Property Value
RadTreeView

DisplayMember

Gets or sets the display member. Note that this property is ignored when DefaultTreeView is set.

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

The display member.

ForeColor

RadbreadCrumb consists of multiple visual elements and separate settings are provided to customize their appearance. Current ForeColor property might be ignored.

Declaration
public override Color ForeColor { get; set; }
Property Value
System.Drawing.Color

Overrides

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

Nodes

Gets the collection of tree nodes that are assigned to the bread crumb control.

Declaration
public virtual RadTreeNodeCollection Nodes { get; }
Property Value
RadTreeNodeCollection

A System.Windows.Forms.TreeNodeCollection that represents the tree nodes assigned to the tree view control.

ParentMember

Gets or sets the parent member. Note that this property is ignored when DefaultTreeView is set.

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

The parent member.

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 the 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 DefaultTreeView is set.

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

The relation bindings.

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

Text

The property is not relevant for this control.

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

Overrides

UseMnemonic

Gets or sets a value indicating whether the control interprets an ampersand character (&) in the control's Text property to be an access key prefix character.

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

true if the label doesn't display the ampersand character and underlines the character after the ampersand in its displayed text and treats the underlined character as an access key; otherwise, false if the ampersand character is displayed in the text of the control. The default is true.

ValueMember

Gets or sets the value member. Note that this property is ignored when DefaultTreeView is set.

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

The value member.

Methods

CraeteBreadCrumbElement()

Declaration
protected virtual RadBreadCrumbElement CraeteBreadCrumbElement()
Returns
RadBreadCrumbElement

CreateChildItems(RadElement)

Declaration
protected override void CreateChildItems(RadElement parent)
Parameters
RadElement parent

Overrides

CreateSplitButtonElement()

Declaration
[Obsolete("Obsolete. Use BreadCrumbElement.CreateSplitButtonElement method instead.")]
protected virtual RadSplitButtonElement CreateSplitButtonElement()
Returns
RadSplitButtonElement

GetNodesCount(RadTreeNodeCollection)

Declaration
public int GetNodesCount(RadTreeNodeCollection nodes)
Parameters
RadTreeNodeCollection nodes

Returns
System.Int32

ProcessAutoSizeChanged(Boolean)

Declaration
protected override void ProcessAutoSizeChanged(bool value)
Parameters
System.Boolean value

Overrides

UpdateBreadCrumb(RadTreeNode)

Declaration
public void UpdateBreadCrumb(RadTreeNode node)
Parameters
RadTreeNode node

Events

AutoCompleteItemsCreated

Occurs when auto complete items are created. In this event handler the user can modify the auto complete items 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 when the Path is changed. For each node in the path hierarchy a SplitButtonElement is created. In this event handler the users can set button properties, modify one or more items of the SplitButton.Items collection 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