Class

RadBreadCrumbElement

Initializes a new instance of the RadBreadCrumbElement class.

Declaration

public RadBreadCrumbElement()

Registers the DefaultHeight property for the RadBreadCrumbElement.

Declaration

public static RadProperty DefaultHeightProperty

Field Value

Registers the IsInEditMode property for the RadBreadCrumbElement.

Declaration

public static RadProperty IsInEditModeProperty

Field Value

Registers the SpacingBetweenItems property for the RadBreadCrumbElement.

Declaration

public static RadProperty SpacingBetweenItemsProperty

Field Value

Gets the auto-complete suggest helper that provides text completion functionality in edit mode.

Declaration

[Browsable(true)]
public BreadCrumbAutoCompleteSuggestHelper AutoCompleteSuggestHelper { get; }

Property Value

Gets or sets the property name used to define child relationships in data binding. This property is ignored when DefaultTreeViewElement is set.

Declaration

public virtual string ChildMember { get; set; }

Property Value

Gets or sets the name of the list or table in the data source for data binding. This property is ignored when DefaultTreeViewElement is set.

Declaration

public virtual string DataMember { get; set; }

Property Value

Gets or sets the data source for the breadcrumb when using data binding. This property is ignored when DefaultTreeViewElement is set.

Declaration

public virtual object DataSource { get; set; }

Property Value

Gets or sets the default height of the breadcrumb element in pixels.

Declaration

[Browsable(true)]
public int DefaultHeight { get; set; }

Property Value

Gets or sets the external RadTreeViewElement associated with the breadcrumb for navigation.

Declaration

public RadTreeViewElement DefaultTreeViewElement { get; set; }

Property Value

Gets or sets the property name used to extract the display text from data items. This property is ignored when DefaultTreeViewElement is set.

Declaration

public virtual string DisplayMember { get; set; }

Property Value

Gets the dropdown button element that contains all collapsed and pinned items.

Declaration

public BreadCrumbDropDownButtonElement HeaderDropDownButtonElement { get; }

Property Value

Gets the dropdown button element that provides access to navigation history.

Declaration

public BreadCrumbDropDownButtonElement HistoryDropDownButtonElement { get; }

Property Value

Gets the LightVisualElement that displays the image of the selected node.

Declaration

public LightVisualElement ImageElement { get; }

Property Value

Gets the internal RadTreeViewElement used by the breadcrumb when no DefaultTreeViewElement is set.

Declaration

public RadTreeViewElement InternalTreeViewElement { get; }

Property Value

Gets or sets a value indicating whether auto-complete functionality is enabled in edit mode. By default this property is true.

Declaration

[Browsable(true)]
public bool IsAutoCompleteEnabled { get; set; }

Property Value

Gets or sets a value indicating whether history tracking of visited paths is enabled. By default this property is false.

Declaration

[Browsable(true)]
public bool IsHistoryEnabled { get; set; }

Property Value

Gets or sets a value indicating whether text editing mode is enabled for the breadcrumb. By default this property is true.

Declaration

[Browsable(true)]
public bool IsTextModeEnabled { get; set; }

Property Value

Gets the collection of RadSplitButtonElement items that represent the path to the selected RadTreeNode.

Declaration

public RadItemOwnerCollection Items { get; }

Property Value

Gets the StackLayoutPanel that contains the elements on the left side of the breadcrumb.

Declaration

public StackLayoutPanel LeftElementsStack { get; }

Property Value

Gets the StackLayoutPanel that holds all breadcrumb Items.

Declaration

public StackLayoutPanel MainStack { get; }

Property Value

Gets the collection of RadTreeNode objects from the InternalTreeViewElement.

Declaration

public RadTreeNodeCollection Nodes { get; }

Property Value

Gets or sets the property name used to define parent relationships in data binding. This property is ignored when DefaultTreeViewElement is set.

Declaration

public virtual string ParentMember { get; set; }

Property Value

Gets or sets how node names are compared when the Parse(string) method is called.

Declaration

public StringComparison ParseStringComparison { get; set; }

Property Value

Gets 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

Gets or sets the character used as path separator in breadcrumb navigation.

Declaration

[Browsable(true)]
public char PathSeparator { get; set; }

Property Value

Gets the collection of pinned menu items in the HeaderDropDownButtonElement. The pinned items are AssociatedMenuItem objects that provide shortcuts for faster navigation to predefined paths.

Declaration

public ObservableCollection<AssociatedMenuItem> PinnedHeaderItems { get; }

Property Value

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

Gets the collection containing data binding settings for related data. This property is ignored when DefaultTreeViewElement is set.

Declaration

public virtual RelationBindingCollection RelationBindings { get; }

Property Value

Gets the StackLayoutPanel that contains the elements on the right side of the breadcrumb.

Declaration

public StackLayoutPanel RightElementsStack { get; }

Property Value

Gets or sets a value indicating whether a tree node will be selected when clicking on the action part of a split button element. When false, clicking the action part opens the dropdown menu.

Declaration

public bool SelectTreeNodeOnClick { get; set; }

Property Value

Gets or sets a value indicating whether to display hidden RadTreeNode objects. A hidden node has its Visible property set to false.

Declaration

public bool ShowHiddenNodes { get; set; }

Property Value

Gets or sets the spacing in pixels between breadcrumb items.

Declaration

[Browsable(true)]
public int SpacingBetweenItems { get; set; }

Property Value

Gets the RadTextBoxElement used for text editing mode.

Declaration

public RadTextBoxElement TextBoxEditorElement { get; }

Property Value

Gets or sets the property name used to extract values from data items. This property is ignored when DefaultTreeViewElement is set.

Declaration

public virtual string ValueMember { get; set; }

Property Value

Positions and sizes the child elements within the breadcrumb layout.

Declaration

protected override SizeF ArrangeOverride(SizeF finalSize)

Parameters

Returns

Overrides LightVisualElement.ArrangeOverride(SizeF)

Begins text editing mode by showing the text editor and setting focus to it.

Declaration

public virtual void BeginEdit()

Clears the collapsed menu items from the header dropdown button.

Declaration

protected virtual void ClearCollapsedItems()

Clears the root menu items from the header dropdown button.

Declaration

protected virtual void ClearRootItems()

Creates a new instance of the auto-complete suggest helper for the breadcrumb.

Declaration

protected virtual BreadCrumbAutoCompleteSuggestHelper CreateAutoCompleteSuggestHelper()

Returns

Creates and configures the child elements of the breadcrumb including stacks, buttons, and text editor.

Declaration

protected override void CreateChildElements()

Overrides RadElement.CreateChildElements()

Creates the default tree view element for internal use.

Declaration

protected virtual RadTreeViewElement CreateDefaultTreeViewElement()

Returns

Creates the header dropdown button element that contains collapsed and pinned items.

Declaration

protected virtual BreadCrumbDropDownButtonElement CreateHeaderDropDownButtonElement()

Returns

Creates the history dropdown button element that contains navigation history.

Declaration

protected virtual BreadCrumbDropDownButtonElement CreateHistoryDropDownButtonElement()

Returns

Creates the image element that displays the icon of the selected node.

Declaration

protected virtual LightVisualElement CreateImageElement()

Returns

Creates the left elements stack panel for the breadcrumb.

Declaration

protected virtual StackLayoutPanel CreateLeftElementsStack()

Returns

Creates the main elements stack panel that contains the breadcrumb items.

Declaration

protected virtual StackLayoutPanel CreateMainElementsStack()

Returns

Creates the right elements stack panel for the breadcrumb.

Declaration

protected virtual StackLayoutPanel CreateRightElementsStack()

Returns

Creates a menu separator item for dropdown menus.

Declaration

protected virtual RadMenuSeparatorItem CreateSeparatorItem()

Returns

Creates a new split button element for breadcrumb navigation.

Declaration

protected virtual RadSplitButtonElement CreateSplitButtonElement()

Returns

Creates the text box element used for text editing mode.

Declaration

protected virtual RadTextBoxElement CreateTextBoxElement()

Returns

Ends text editing mode and optionally submits the entered text for navigation.

Declaration

public virtual void EndEdit(bool submit)

Parameters

Finds a tree node by the specified text token within the children of the given parent node.

Declaration

protected virtual RadTreeNode FindNodeFromToken(string token, RadTreeNode parentNode)

Parameters

Returns

Gets the display text for the specified split button element.

Declaration

protected virtual string GetItemText(RadSplitButtonElement splitButton)

Parameters

Returns

Gets the full path string for the specified tree node.

Declaration

public virtual string GetNodePath(RadTreeNode node)

Parameters

Returns

Gets the display text for the specified tree node.

Declaration

protected virtual string GetNodeText(RadTreeNode node)

Parameters

Returns

Recursively counts the total number of nodes in the specified node collection including all child nodes.

Declaration

public int GetNodesCount(RadTreeNodeCollection nodes)

Parameters

Returns

Gets the current path string from the breadcrumb items.

Declaration

public virtual string GetPathFromItems()

Returns

Gets the collection of root level tree nodes, filtering out hidden nodes if ShowHiddenNodes is false.

Declaration

protected virtual IList<RadTreeNode> GetRootNodes()

Returns

Initializes the field values and configures default behavior for the breadcrumb element.

Declaration

protected override void InitializeFields()

Overrides LightVisualElement.InitializeFields()

Determines whether the header button should be permanently visible based on pinned items and root nodes.

Declaration

protected virtual bool IsHeaderButtonPermanentlyVisible()

Returns

Measures the desired size of the breadcrumb element and manages item collapsing based on available space.

Declaration

protected override SizeF MeasureOverride(SizeF availableSize)

Parameters

Returns

Overrides LightVisualElement.MeasureOverride(SizeF)

Raises the AutoCompleteItemsCreated event.

Declaration

protected virtual void OnAutoCompleteItemsCreated(object sender, AutoCompleteItemsCreatedEventArgs e)

Parameters

Raises the AutoCompleteItemsCreating event.

Declaration

protected virtual void OnAutoCompleteItemsCreating(object sender, AutoCompleteItemsCreatingEventArgs e)

Parameters

Raises the CollapsedItemCreated event.

Declaration

protected virtual void OnCollapsedItemCreated(object sender, AssociatedMenuItemEventArgs e)

Parameters

Raises the CollapsedItemsCreated event.

Declaration

protected virtual void OnCollapsedItemsCreated(object sender, AssociatedMenuItemCollectionEventArgs e)

Parameters

Raises the HistoryItemCreated event.

Declaration

protected virtual void OnHistoryItemCreated(object sender, AssociatedMenuItemEventArgs e)

Parameters

Handles key up events for escape and enter keys to manage edit mode.

Declaration

protected override void OnKeyUp(KeyEventArgs e)

Parameters

Overrides RadItem.OnKeyUp(KeyEventArgs)

Handles mouse down events and initiates edit mode when the breadcrumb background is clicked.

Declaration

protected override void OnMouseDown(MouseEventArgs e)

Parameters

Overrides RadItem.OnMouseDown(MouseEventArgs)

Raises the PathParsed event.

Declaration

protected virtual void OnPathParsed(object sender, PathParsedEventArgs e)

Parameters

Raises the PathParsing event.

Declaration

protected virtual void OnPathParsing(object sender, PathParsingEventArgs e)

Parameters

Handles property change notifications and updates the breadcrumb display accordingly.

Declaration

protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)

Parameters

Overrides LightVisualElement.OnPropertyChanged(RadPropertyChangedEventArgs)

Raises the RootNodesRequested event.

Declaration

protected virtual void OnRootNodesRequested(object sender, TreeNodeCollectionEventArgs e)

Parameters

Raises the SplitButtonCreated event.

Declaration

protected virtual void OnSplitButtonCreated(object sender, SplitButtonCreatedEventArgs e)

Parameters

Raises the SplitButtonCreating event.

Declaration

protected virtual void OnSplitButtonCreating(object sender, SplitButtonCreatingEventArgs e)

Parameters

Navigates to a RadTreeNode by parsing the specified path string. Different elements in the node hierarchy must be separated by the PathSeparator.

Declaration

public virtual bool Parse(string path)

Parameters

Returns

Parses the specified path string and retrieves the corresponding tree node.

Declaration

public virtual RadTreeNode ParseCore(string path, out bool isWholePathValid)

Parameters

Returns

Determines whether the specified child element should be arranged by the layout system.

Declaration

protected override bool ShouldArrangeChild(RadElement child)

Parameters

Returns

Overrides RadElement.ShouldArrangeChild(RadElement)

Determines whether the specified child element should be measured by the layout system.

Declaration

protected override bool ShouldMeasureChild(RadElement child)

Parameters

Returns

Overrides RadElement.ShouldMeasureChild(RadElement)

Updates the breadcrumb display to reflect the specified tree node and its hierarchy.

Declaration

public void UpdateBreadCrumb(RadTreeNode node)

Parameters

Updates the header button dropdown items including pinned, root, and collapsed items.

Declaration

protected virtual void UpdateHeaderButtonItems()

Updates the navigation history by adding the specified node to the history collection.

Declaration

protected virtual void UpdateHistory(RadTreeNode node)

Parameters

Occurs when auto-complete items have been created, allowing modification of the auto-complete items collection.

Declaration

public event AutoCompleteItemsCreatedEventHandler AutoCompleteItemsCreated

Event Value

Occurs when auto-complete items are being created, allowing modification of the text used for generating auto-complete suggestions.

Declaration

public event AutoCompleteItemsCreatingEventHandler AutoCompleteItemsCreating

Event Value

Occurs when there is insufficient space to display all items and a collapsed item is created.

Declaration

public event AssociatedMenuItemEventHandler CollapsedItemCreated

Event Value

Occurs when all collapsed items have been created, allowing modification of the collapsed items collection.

Declaration

public event AssociatedMenuItemCollectionEventHandler CollapsedItemsCreated

Event Value

Occurs when the user navigates to a new path and a history item is being created.

Declaration

public event AssociatedMenuItemEventHandler HistoryItemCreated

Event Value

Occurs when a path has been evaluated and a RadTreeNode is about to be selected in the breadcrumb.

Declaration

public event PathParsedEventHandler PathParsed

Event Value

Occurs when a path is about to be parsed, allowing modification of the path or cancellation of the parse operation.

Declaration

public event PathParsingEventHandler PathParsing

Event Value

Occurs when root nodes are requested during the parse operation, allowing modification of the root nodes collection.

Declaration

public event TreeNodeCollectionEventHandler RootNodesRequested

Event Value

Occurs when a RadSplitButtonElement has been created, allowing customization of button properties and items.

Declaration

public event SplitButtonCreatedEventHandler SplitButtonCreated

Event Value

Occurs when a RadSplitButtonElement is being created, allowing replacement or cancellation of the button creation.

Declaration

public event SplitButtonCreatingEventHandler SplitButtonCreating

Event Value