Class

RadOfficeNavigationBarElement

Initializes a new instance of the RadOfficeNavigationBarElement class with default settings for Office Navigation Bar functionality, disabling strip buttons and preparing the element for navigation bar operations.

Declaration

public RadOfficeNavigationBarElement()

Declaration

public static RadProperty UseLargeFontProperty

Field Value

Gets the context menu that displays navigation options and hidden navigation items when the overflow item is clicked. This menu is automatically populated based on current visibility settings and available items.

Declaration

public RadContextMenuDropDown ContextMenu { get; }

Property Value

Gets or sets a value indicating whether peek popups are enabled for navigation items when hovered with the mouse. When enabled, popups can display additional content configured through the PeekPopupOpening event, providing quick previews of navigation item content.

Declaration

public override bool EnablePeekPopup { get; set; }

Property Value

Overrides RadPageViewElement.EnablePeekPopup

Gets or sets the display style for navigation items, determining whether items show text only, image only, or both text and image. This property affects the visual presentation of all navigation items.

Declaration

public DisplayStyle ItemsDisplayStyle { get; set; }

Property Value

Gets or sets the separator item used in the context menu to visually separate the navigation options menu item from the list of hidden navigation items. This separator is displayed only when both elements are present.

Declaration

public RadMenuSeparatorItem MenuSeparator { get; set; }

Property Value

Gets or sets the menu item that opens the navigation options dialog when clicked. This menu item appears in the context menu and allows users to configure navigation bar settings such as item visibility and order.

Declaration

public RadMenuItem NavigationOptionsMenuItem { get; set; }

Property Value

Gets the RadOfficeNavigationBarOverflowItem that provides access to hidden navigation items through a context menu when clicked. This item is automatically managed based on available space and item visibility.

Declaration

[Browsable(false)]
public RadOfficeNavigationBarOverflowItem OverflowItem { get; }

Property Value

Gets or sets the position of the OverflowItem relative to the visible navigation items. The overflow item can be positioned at the front (before visible items) or at the end (after visible items) of the navigation bar.

Declaration

public OfficeNavigationBarOverflowItemPosition OverflowItemPosition { get; set; }

Property Value

Gets or sets a value indicating whether to display the navigation options menu item in the context menu. When true, users can access the navigation options dialog to customize the navigation bar settings.

Declaration

public bool ShowNavigationOptionsMenuItem { get; set; }

Property Value

Gets or sets a value indicating whether to use compact font styling for navigation items. When true, items use a smaller, more condensed font; when false, items use a larger, more prominent font for improved readability.

Declaration

public bool UseCompactFont { get; set; }

Property Value

Gets or sets the maximum number of navigation items visible on the navigation bar. When the total number of items exceeds this value, additional items are accessible through the overflow item. If not explicitly set, returns the total item count.

Declaration

public int VisibleItemsCount { get; set; }

Property Value

Adds a new item to the navigation bar and ensures the overflow item is positioned correctly based on the current OverflowItemPosition setting. Manages the layout of both regular items and the overflow item.

Declaration

protected override void AddItemCore(RadPageViewItem item)

Parameters

Overrides RadPageViewStripElement.AddItemCore(RadPageViewItem)

Determines whether a drag operation can drop an item over the specified hit item. Prevents dropping items over the overflow item while allowing normal drag-and-drop operations between regular navigation items.

Declaration

protected override bool CanDropOverItem(RadPageViewItem dragItem, RadPageViewItem hitItem)

Parameters

Returns

Overrides RadPageViewStripElement.CanDropOverItem(RadPageViewItem, RadPageViewItem)

Clears all items from the context menu and unsubscribes from their click events to prevent memory leaks. This method is called before rebuilding the context menu with current items.

Declaration

protected virtual void ClearContextMenu()

Closes the specified item if it's not the overflow item. The overflow item is a system item that cannot be closed and provides access to hidden navigation items.

Declaration

protected override void CloseItem(RadPageViewItem item)

Parameters

Overrides RadPageViewStripElement.CloseItem(RadPageViewItem)

Creates and initializes the child elements specific to the Office Navigation Bar, including the specialized item container, overflow item, and removes unnecessary elements like buttons panel, header, and footer.

Declaration

protected override void CreateChildElements()

Overrides RadPageViewStripElement.CreateChildElements()

Creates a new RadOfficeNavigationBarItem that provides specialized functionality for Office Navigation Bar items with appropriate styling and behavior.

Declaration

protected override RadPageViewItem CreateItem()

Returns

Overrides RadPageViewStripElement.CreateItem()

Creates a specialized OfficeNavigationBarItemContainer to manage the layout and overflow behavior of items in the Office Navigation Bar.

Declaration

protected override StripViewItemContainer CreateItemContainer()

Returns

Overrides RadPageViewStripElement.CreateItemContainer()

Creates a menu item representation of a page view item for display in the overflow context menu. This allows hidden navigation items to be accessible through the context menu.

Declaration

protected virtual RadPageViewMenuItem CreateMenuItem(RadPageViewItem pageItem)

Parameters

Returns

Creates the menu item that opens the navigation options dialog when clicked. This virtual method allows customization of the menu item's appearance and text.

Declaration

protected virtual RadMenuItem CreateNavigationOptionsMenuItem()

Returns

Creates the separator item used in the context menu to visually separate the navigation options menu item from the list of hidden navigation items.

Declaration

protected virtual RadMenuSeparatorItem CreateNavigationOptionsSeparatorItem()

Returns

Creates the context menu used to display navigation options and hidden items. This virtual method allows customization of the context menu appearance and behavior.

Declaration

protected virtual RadContextMenuDropDown CreateOptionsContextMenu()

Returns

Creates the options dialog that allows users to customize the navigation bar settings, including item visibility and ordering. Raises the CreateNavigationOptionsDialog event to allow dialog customization.

Declaration

protected virtual OfficeNavigationBarOptionsDialog CreateOptionsDialog()

Returns

Creates the overflow item that provides access to hidden navigation items when the available space is insufficient to display all items. This virtual method allows customization of the overflow item behavior.

Declaration

protected virtual RadOfficeNavigationBarOverflowItem CreateOverflowItem()

Returns

Releases the managed resources used by this Office Navigation Bar element, including the overflow item and other associated resources.

Declaration

protected override void DisposeManagedResources()

Overrides RadPageViewStripElement.DisposeManagedResources()

Initializes the default field values for the Office Navigation Bar, setting up display style, alignment, button visibility options, and enabling context menu and peek popup functionality.

Declaration

protected override void InitializeFields()

Overrides RadPageViewElement.InitializeFields()

Handles click events on navigation items. For regular items, delegates to the base implementation for standard click handling. For the overflow item, triggers the overflow menu display functionality.

Declaration

protected override void OnItemClick(RadPageViewItem sender, EventArgs e)

Parameters

Overrides RadPageViewStripElement.OnItemClick(RadPageViewItem, EventArgs)

Handles mouse down events on navigation items. For the overflow item, stops any active peek timer to prevent popup display. For regular items, delegates to the base implementation for standard mouse handling.

Declaration

protected override void OnItemMouseDown(RadPageViewItem sender, MouseEventArgs e)

Parameters

Overrides RadPageViewStripElement.OnItemMouseDown(RadPageViewItem, MouseEventArgs)

Handles click events on the overflow item by displaying the context menu with navigation options and hidden items. The context menu is shown only for left mouse button clicks when not in design mode.

Declaration

protected virtual void OnOverflowItemClick(MouseEventArgs e)

Parameters

Shows the navigation options dialog which allows users to configure navigation bar display settings. Creates, initializes, and displays the modal dialog for Office Navigation Bar options.

Declaration

protected virtual void OnShowOptionsDialogItemClick()

Rebuilds the context menu by adding the navigation options menu item (if enabled) and menu items for all currently hidden navigation items. This method is called before displaying the context menu to ensure current state.

Declaration

protected virtual void RebuildContextMenu()

Replaces default property descriptors to enable proper serialization of Office Navigation Bar specific properties when used within RadPageView. Configures custom serialization for navigation-specific properties.

Declaration

protected override PropertyDescriptorCollection ReplaceDefaultDescriptors(PropertyDescriptorCollection props)

Parameters

Returns

Overrides RadItem.ReplaceDefaultDescriptors(PropertyDescriptorCollection)

Applies the specified display style to all navigation items, controlling whether they display text, images, or both. Updates the visual appearance of items and triggers measurement invalidation.

Declaration

protected virtual void SetItemsDisplayStyle(DisplayStyle value)

Parameters

Updates the orientation of the specified items and includes the overflow item in the orientation update process. This ensures consistent orientation handling for both regular items and the overflow item.

Declaration

protected override void UpdateItemOrientation(IEnumerable items)

Parameters

Overrides RadPageViewStripElement.UpdateItemOrientation(IEnumerable)

Occurs when the NavigationOptionsMenuItem is clicked and the options dialog is about to be opened. Suitable place to customize or replace the navigation options dialog.

Declaration

public event CreateOfficeNavigationBarOptionsDialogEventHandler CreateNavigationOptionsDialog

Event Value