ClassRadOfficeNavigationBar
The RadOfficeNavigationBar class represents a navigation bar that facilitates seamless navigation between various views within an application. It allows users to access a streamlined subset of a view in a popup window, dynamically manages the visibility of items through an , and provides extensive customization options via the OfficeNavigationBarDialog. The class supports features such as drag-and-drop reordering of items, compact mode for displaying minimal content, and peek popups for contextual information. The navigation bar enhances the user experience by providing intuitive keyboard navigation, responsive item selection, and automated handling of item visibility based on the available space. Overall, it serves as an effective tool for organizing and presenting content in a user-friendly manner.
Definition
Namespace:Telerik.Windows.Controls
Assembly:Telerik.Windows.Controls.Navigation.dll
Syntax:
[TelerikToolboxCategory("Navigation")]
[SuppressMessage("Microsoft.Design", "CA1001:TypesThatOwnDisposableFieldsShouldBeDisposable")]
public class RadOfficeNavigationBar : SelectorInheritance: objectRadOfficeNavigationBar
Constructors
RadOfficeNavigationBar()
Initializes a new instance of the RadOfficeNavigationBar class.
Declaration
public RadOfficeNavigationBar()Fields
IsDragReorderEnabledProperty
Identifies the IsDragReorderEnabled dependency property.
Declaration
public static readonly DependencyProperty IsDragReorderEnabledPropertyField Value
DependencyProperty
IsInCompactModeProperty
Identifies the IsInCompactMode dependency property.
Declaration
public static readonly DependencyProperty IsInCompactModePropertyField Value
DependencyProperty
IsPeekPopupEnabledProperty
Identifies the IsPeekPopupEnabled dependency property.
Declaration
public static readonly DependencyProperty IsPeekPopupEnabledPropertyField Value
DependencyProperty
ItemOrientationProperty
Identifies the ItemOrientation dependency property.
Declaration
public static readonly DependencyProperty ItemOrientationPropertyField Value
DependencyProperty
ItemRotationAngleProperty
Identifies the ItemRotationAngle dependency property.
Declaration
public static readonly DependencyProperty ItemRotationAnglePropertyField Value
DependencyProperty
ItemsMaxCountProperty
Identifies the ItemsMaxCount dependency property.
Declaration
public static readonly DependencyProperty ItemsMaxCountPropertyField Value
DependencyProperty
OrientationProperty
Identifies the Orientation dependency property.
Declaration
public static readonly DependencyProperty OrientationPropertyField Value
DependencyProperty
PeekPopupCloseDelayProperty
Identifies the PeekPopupCloseDelay dependency property.
Declaration
public static readonly DependencyProperty PeekPopupCloseDelayPropertyField Value
DependencyProperty
PeekPopupOpeningEvent
Registers the PeekPopupOpening routed event.
Declaration
public static readonly RoutedEvent PeekPopupOpeningEventField Value
RoutedEvent
PeekPopupShowDelayProperty
Identifies the PeekPopupShowDelay dependency property.
Declaration
public static readonly DependencyProperty PeekPopupShowDelayPropertyField Value
DependencyProperty
Properties
IsDragReorderEnabled
Gets or sets a boolean value indicating whether drag and drop reordering of items is enabled.
IsInCompactMode
Gets or sets a boolean value indicating whether the control is in Compact mode. In that mode only the compact content of the items will be visible.
IsPeekPopupEnabled
Gets or sets a boolean value indicating whether a peek popup will be shown upon hovering an item.
ItemOrientation
Gets or sets the orientation in which each individual RadOfficeNavigationBarItem will be displayed.
Declaration
public Orientation ItemOrientation { get; set; }Property Value
Orientation
ItemRotationAngle
Gets the angle the items are rotated by.
ItemsMaxCount
Gets or sets an integer value identifying the maximum number of items that will be displayed at a time.
OfficeNavigationBarDialogViewModel
Gets the view model for the OfficeNavigationBarDialog control.
Declaration
public OfficeNavigationBarDialogViewModel OfficeNavigationBarDialogViewModel { get; }Property Value
Orientation
Gets or sets the orientation in which all the RadOfficeNavigationBarItems will be displayed.
Declaration
public Orientation Orientation { get; set; }Property Value
Orientation
PeekPopupCloseDelay
Gets or sets an double value indicating the delay time in milliseconds between when the mouse leaves the item and when the peek popup is closed.
PeekPopupShowDelay
Gets or sets an double value indicating the delay time in milliseconds between when an item is hovered and when the peek popup is shown.
Methods
ClearContainerForItemOverride(DependencyObject, object)
Clears the specified element displaying the specified item container.
Declaration
protected override void ClearContainerForItemOverride(DependencyObject element, object item)Parameters
element
DependencyObject
Element used to display the specified item.
item
Specified item.
GetContainerForItemOverride()
Creates or identifies the element that is used to display the given item.
Declaration
protected override DependencyObject GetContainerForItemOverride()Returns
DependencyObject
IsItemItsOwnContainerOverride(object)
Determines if the specified item is (or is eligible to be) its own container.
OnApplyTemplate()
Called when the template for the RadOfficeNavigationBar is applied. This method is used to perform any necessary setup after the control's template is applied.
Declaration
public override void OnApplyTemplate()OnCreateAutomationPeer()
Returns class-specific AutomationPeer.
Declaration
protected override AutomationPeer OnCreateAutomationPeer()Returns
AutomationPeer
The type-specific AutomationPeer implementation.
OnInitialized(EventArgs)
Raises the event. This method is invoked whenever is set to true internally.
Declaration
protected override void OnInitialized(EventArgs e)Parameters
e
The RoutedEventArgs that contains the event data.
OnItemsChanged(NotifyCollectionChangedEventArgs)
Declaration
protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)Parameters
e
OnKeyDown(KeyEventArgs)
Declaration
protected override void OnKeyDown(KeyEventArgs e)Parameters
e
KeyEventArgs
OnSelectionChanged(SelectionChangedEventArgs)
Declaration
protected override void OnSelectionChanged(SelectionChangedEventArgs e)Parameters
e
SelectionChangedEventArgs
PrepareContainerForItemOverride(DependencyObject, object)
Prepares the specified element to display the specified item container.
Declaration
protected override void PrepareContainerForItemOverride(DependencyObject element, object item)Parameters
element
DependencyObject
Element used to display the specified item.
item
Specified item.
Events
PeekPopupOpening
Occurs when a peek popup is about to be shown.
Declaration
public event EventHandler<PeekPopupOpeningEventArgs> PeekPopupOpeningEvent Value