Class RadPageViewNavigationViewElement

Represents the visual element for the NavigationView style of a RadPageView control, providing a modern navigation pattern with hamburger menu functionality and hierarchical page organization.

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
UIItemBase
LightVisualElement
RadPageViewElementBase
RadPageViewElement
RadPageViewStripElement
RadPageViewNavigationViewElement
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 RadPageViewNavigationViewElement : RadPageViewStripElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider

Constructors

RadPageViewNavigationViewElement()

Initializes a new instance of the RadPageViewNavigationViewElement class.

Declaration
public RadPageViewNavigationViewElement()

Fields

CollapsedGlyphProperty

Identifies the CollapsedGlyph dependency property.

Declaration
public static RadProperty CollapsedGlyphProperty
Field Value
RadProperty

CollapsedPaneWidthProperty

Identifies the CollapsedPaneWidth dependency property.

Declaration
public static RadProperty CollapsedPaneWidthProperty
Field Value
RadProperty

CompactModeThresholdWidthProperty

Identifies the CompactModeThresholdWidth dependency property.

Declaration
public static RadProperty CompactModeThresholdWidthProperty
Field Value
RadProperty

DisplayModeProperty

Identifies the DisplayMode dependency property.

Declaration
public static RadProperty DisplayModeProperty
Field Value
RadProperty

ExpandedGlyphProperty

Identifies the ExpandedGlyph dependency property.

Declaration
public static RadProperty ExpandedGlyphProperty
Field Value
RadProperty

ExpandedModeThresholdWidthProperty

Identifies the ExpandedModeThresholdWidth dependency property.

Declaration
public static RadProperty ExpandedModeThresholdWidthProperty
Field Value
RadProperty

ExpandedPaneWidthProperty

Identifies the ExpandedPaneWidth dependency property.

Declaration
public static RadProperty ExpandedPaneWidthProperty
Field Value
RadProperty

HeaderHeightProperty

Identifies the HeaderHeight dependency property.

Declaration
public static RadProperty HeaderHeightProperty
Field Value
RadProperty

HierarchyIndentProperty

Identifies the HierarchyIndent dependency property.

Declaration
public static RadProperty HierarchyIndentProperty
Field Value
RadProperty

HierarchyPopupExpandModeProperty

Identifies the HierarchyPopupExpandMode dependency property.

Declaration
public static RadProperty HierarchyPopupExpandModeProperty
Field Value
RadProperty

ItemExpandCollapseModeProperty

Identifies the ItemExpandCollapseMode dependency property.

Declaration
public static RadProperty ItemExpandCollapseModeProperty
Field Value
RadProperty

Properties

AllowAnimation

Gets or sets a value indicating whether animations are enabled for expand and collapse operations.

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

AnimatedStripScrolling

This property is not relevant for this class.

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

Overrides

AnimationFrames

Gets or sets the total number of animation frames used during expand and collapse operations.

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

AnimationInterval

Gets or sets the interval between animation frames during expand and collapse operations.

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

CollapsedGlyph

Gets or sets the glyph displayed in the expander element when a navigation item is in its collapsed state.

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

CollapsedPaneWidth

Gets or sets the width of the navigation pane when the view is in collapsed state.

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

CompactModeThresholdWidth

Gets or sets the width threshold that determines when the navigation view switches between collapsed and compact modes in auto display mode.

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

DisplayMode

Gets or sets the display mode that determines how the navigation view renders and behaves.

Declaration
public NavigationViewDisplayModes DisplayMode { get; set; }
Property Value
NavigationViewDisplayModes

ExpandedGlyph

Gets or sets the glyph displayed in the expander element when a navigation item is in its expanded state.

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

ExpandedModeThresholdWidth

Gets or sets the width threshold that determines when the navigation view switches between compact and expanded modes in auto display mode.

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

ExpandedPaneWidth

Gets or sets the width of the navigation pane when the view is in expanded state.

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

HamburgerButton

Gets the hamburger button element that toggles the navigation view's collapsed state.

Declaration
public RadButtonElement HamburgerButton { get; }
Property Value
RadButtonElement

Header

This property is not relevant for this class.

Declaration
public override RadPageViewLabelElement Header { get; }
Property Value
RadPageViewLabelElement

Overrides

HeaderElement

Gets the header element that displays the current page title and provides additional navigation options.

Declaration
public NavigationViewHeaderElement HeaderElement { get; }
Property Value
NavigationViewHeaderElement

HeaderHeight

Gets or sets the height of the header area that contains the page title and navigation controls.

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

HierarchyIndent

Gets or sets the indentation amount applied to child navigation items in hierarchical structures.

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

HierarchyPopupExpandMode

Gets or sets the expand mode for hierarchical popups that determines when child items are displayed in popup menus.

Declaration
public NavigationViewHierarchyPopupExpandMode HierarchyPopupExpandMode { get; set; }
Property Value
NavigationViewHierarchyPopupExpandMode

IsCollapsed

Gets a value indicating whether the navigation view is currently in its collapsed state.

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

ItemExpandCollapseMode

Gets or sets the interaction mode that determines how hierarchical navigation items can be expanded and collapsed.

Declaration
public NavigationViewItemExpandCollapseMode ItemExpandCollapseMode { get; set; }
Property Value
NavigationViewItemExpandCollapseMode

MinumumHierarchicalPopupSize

Gets or sets the minimum size for hierarchical popup menus, with automatic size calculation based on item content as the default behavior.

Declaration
public Size MinumumHierarchicalPopupSize { get; set; }
Property Value
System.Drawing.Size

NewItemVisibility

Gets or sets the visibility mode for the new item functionality.

Declaration
public override StripViewNewItemVisibility NewItemVisibility { get; set; }
Property Value
StripViewNewItemVisibility

Overrides

Popup

Gets the popup control used in minimal and compact display modes to show navigation items.

Declaration
public virtual RadPopupControlBase Popup { get; }
Property Value
RadPopupControlBase

PopupStack

Gets the stack layout element that organizes navigation items within the popup.

Declaration
public virtual StackLayoutElement PopupStack { get; }
Property Value
StackLayoutElement

StripAlignment

This property is not relevant for this class.

Declaration
public override StripViewAlignment StripAlignment { get; set; }
Property Value
StripViewAlignment

Overrides

StripButtons

This property is not relevant for this class.

Declaration
public override StripViewButtons StripButtons { get; set; }
Property Value
StripViewButtons

Overrides

StripScrollingAnimation

This property is not relevant for this class.

Declaration
public override RadEasingType StripScrollingAnimation { get; set; }
Property Value
RadEasingType

Overrides

Methods

AddFooterItem(RadPageViewItem)

Adds a navigation item to the footer area of the navigation view for secondary actions or settings.

Declaration
public void AddFooterItem(RadPageViewItem item)
Parameters
RadPageViewItem item

The navigation item to be displayed in the footer area.

AddFooterPage(RadPageViewPage)

Adds a page to the footer area of the navigation view for secondary actions or settings.

Declaration
public void AddFooterPage(RadPageViewPage page)
Parameters
RadPageViewPage page

The page to be displayed in the footer area.

AddHeaderItem(RadPageViewItem)

Adds a navigation item to the header area of the navigation view for quick access.

Declaration
public void AddHeaderItem(RadPageViewItem item)
Parameters
RadPageViewItem item

The navigation item to be displayed in the header area.

AddHeaderPage(RadPageViewPage)

Adds a page to the header area of the navigation view for quick access.

Declaration
public void AddHeaderPage(RadPageViewPage page)
Parameters
RadPageViewPage page

The page to be displayed in the header area.

AddItemCore(RadPageViewItem)

Handles the addition of a new navigation item to the view, ensuring proper configuration and hierarchy.

Declaration
protected override void AddItemCore(RadPageViewItem item)
Parameters
RadPageViewItem item

The navigation item being added to the view.
Overrides

ApplyThemeToPopup(RadElementTree, RadPopupControlBase)

Applies the appropriate theme to a popup control based on the element tree's theme configuration.

Declaration
public static void ApplyThemeToPopup(RadElementTree elementTree, RadPopupControlBase popup)
Parameters
RadElementTree elementTree

The element tree containing theme information.
RadPopupControlBase popup

The popup control to apply the theme to.

ArrangeItems(RectangleF)

Arranges the navigation items and content areas within the specified rectangle, considering the current display mode.

Declaration
protected override RectangleF ArrangeItems(RectangleF itemsRect)
Parameters
System.Drawing.RectangleF itemsRect

The rectangle containing the area available for arranging navigation items.
Returns
System.Drawing.RectangleF

The rectangle representing the content area after navigation items have been arranged.
Overrides

ArrangeOverride(SizeF)

Arranges the navigation view element and its children within the specified size, positioning elements according to the current display mode.

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

The final area within which the navigation view element should arrange itself and its children.
Returns
System.Drawing.SizeF

The actual size used by the navigation view element after arranging its children.
Overrides

CloseItem(RadPageViewItem)

This method is not relevant for this class.

Declaration
protected override void CloseItem(RadPageViewItem item)
Parameters
RadPageViewItem item

Overrides

Collapse()

Collapses the navigation view to its minimal state, hiding navigation items while keeping the hamburger button visible.

Declaration
public virtual void Collapse()

CreateChildElements()

Creates the child elements of the navigation view including the header and hamburger button.

Declaration
protected override void CreateChildElements()
Overrides

CreateHamburgerButton()

Creates the hamburger button element for the navigation view.

Declaration
protected virtual HamburgerButtonElement CreateHamburgerButton()
Returns
HamburgerButtonElement

A new HamburgerButtonElement instance.

CreateHeaderElement()

Creates the header element for the navigation view.

Declaration
protected virtual NavigationViewHeaderElement CreateHeaderElement()
Returns
NavigationViewHeaderElement

A new NavigationViewHeaderElement instance.

CreateItem()

Creates a new navigation view item.

Declaration
protected override RadPageViewItem CreateItem()
Returns
RadPageViewItem

A new RadPageViewNavigationViewItem instance.
Overrides

CreateItemContainer()

Creates a new item container for the navigation view.

Declaration
protected override StripViewItemContainer CreateItemContainer()
Returns
StripViewItemContainer

A new NavigationViewItemContainer instance.
Overrides

CreatePopup()

Creates the popup control used in minimal and compact display modes.

Declaration
protected virtual RadPopupControlBase CreatePopup()
Returns
RadPopupControlBase

A new RadPopupControlBase instance.

CreatePopupStack()

Creates the stack layout element for organizing items in the popup.

Declaration
protected virtual StackLayoutElement CreatePopupStack()
Returns
StackLayoutElement

A new StackLayoutElement instance.

EnsureDisplayMode(NavigationViewDisplayModes)

Ensures that the navigation view's layout and behavior matches the specified display mode.

Declaration
protected virtual void EnsureDisplayMode(NavigationViewDisplayModes mode)
Parameters
NavigationViewDisplayModes mode

The display mode to ensure is properly configured.

Expand()

Expands the navigation view from its collapsed state, showing navigation items and enabling full interaction.

Declaration
public virtual void Expand()

GetEffectiveDisplayMode()

Determines the effective display mode based on the current configuration and available space.

Declaration
protected virtual NavigationViewDisplayModes GetEffectiveDisplayMode()
Returns
NavigationViewDisplayModes

The display mode that should be used for the current conditions.

GetEffectiveDisplayMode(Single)

Determines the effective display mode based on the specified width and current configuration.

Declaration
protected virtual NavigationViewDisplayModes GetEffectiveDisplayMode(float width)
Parameters
System.Single width

The available width for determining the appropriate display mode.
Returns
NavigationViewDisplayModes

The display mode that should be used for the specified width.

GetPeekPopupArrowDirection()

Determines the arrow direction for peek popup functionality in the navigation view.

Declaration
protected override ArrowDirection GetPeekPopupArrowDirection()
Returns
ArrowDirection

The arrow direction for peek popups.
Overrides

MeasureItems(SizeF)

Measures the navigation items within the available space, applying constraints based on pane width settings.

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

The available size for measuring the navigation items.
Returns
System.Drawing.SizeF

The desired size for the navigation items based on their content and layout requirements.
Overrides

MeasureOverride(SizeF)

Measures the navigation view element and its children to determine the desired size based on available space and current display mode.

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

The available size for the navigation view element.
Returns
System.Drawing.SizeF

The desired size of the navigation view element based on its content and layout requirements.
Overrides

OnCollapsed(EventArgs)

Fires the Collapsed event.

Declaration
protected virtual void OnCollapsed(EventArgs e)
Parameters
System.EventArgs e

The event arguments.

OnCollapsing(CancelEventArgs)

Fires the Collapsing event.

Declaration
protected virtual void OnCollapsing(CancelEventArgs e)
Parameters
System.ComponentModel.CancelEventArgs e

The event arguments.

OnEnabledChanged(RadPropertyChangedEventArgs)

Handles changes to the enabled state and raises appropriate UI automation events for accessibility support.

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

The property change event arguments containing the enabled state change details.
Overrides

OnExpanded(EventArgs)

Fires the Expanded event.

Declaration
protected virtual void OnExpanded(EventArgs e)
Parameters
System.EventArgs e

The event arguments.

OnExpanding(CancelEventArgs)

Fires the Expanding event.

Declaration
protected virtual void OnExpanding(CancelEventArgs e)
Parameters
System.ComponentModel.CancelEventArgs e

The event arguments.

OnItemCollapsed(Object, EventArgs)

Fires the ItemCollapsed event.

Declaration
protected virtual void OnItemCollapsed(object item, EventArgs e)
Parameters
System.Object item

The item.
System.EventArgs e

The event arguments.

OnItemCollapsing(Object, CancelEventArgs)

Fires the ItemCollapsing event.

Declaration
protected virtual void OnItemCollapsing(object item, CancelEventArgs e)
Parameters
System.Object item

The item.
System.ComponentModel.CancelEventArgs e

The event arguments.

OnItemExpanded(Object, EventArgs)

Fires the ItemExpanded event.

Declaration
protected virtual void OnItemExpanded(object item, EventArgs e)
Parameters
System.Object item

The item.
System.EventArgs e

The event arguments.

OnItemExpanding(Object, CancelEventArgs)

Fires the ItemExpanding event.

Declaration
protected virtual void OnItemExpanding(object item, CancelEventArgs e)
Parameters
System.Object item

The item.
System.ComponentModel.CancelEventArgs e

The event arguments.

OnItemPopupClosed(Object, EventArgs)

Fires the ItemPopupClosed event.

Declaration
protected virtual void OnItemPopupClosed(object item, EventArgs e)
Parameters
System.Object item

The item.
System.EventArgs e

The event arguments.

OnItemPopupClosing(Object, CancelEventArgs)

Fires the ItemPopupClosing event.

Declaration
protected virtual void OnItemPopupClosing(object item, CancelEventArgs e)
Parameters
System.Object item

The item.
System.ComponentModel.CancelEventArgs e

The event arguments.

OnItemPopupOpened(Object, EventArgs)

Fires the ItemPopupOpened event.

Declaration
protected virtual void OnItemPopupOpened(object item, EventArgs e)
Parameters
System.Object item

The item.
System.EventArgs e

The event arguments.

OnItemPopupOpening(Object, CancelEventArgs)

Fires the ItemPopupOpening event.

Declaration
protected virtual void OnItemPopupOpening(object item, CancelEventArgs e)
Parameters
System.Object item

The item.
System.ComponentModel.CancelEventArgs e

The event arguments.

OnLoaded()

Called when the element is loaded and ready for interaction, initializing header text and other UI elements.

Declaration
protected override void OnLoaded()
Overrides

OnNotifyPropertyChanged(PropertyChangedEventArgs)

Handles property change notifications for the navigation view and updates appropriate visual states and layouts.

Declaration
protected override void OnNotifyPropertyChanged(PropertyChangedEventArgs e)
Parameters
System.ComponentModel.PropertyChangedEventArgs e

The property change event arguments containing information about the changed property.
Overrides

OnPropertyChanged(RadPropertyChangedEventArgs)

Handles property change notifications and applies appropriate updates to the navigation view's state and appearance.

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

The property change event arguments containing details about the changed property.
Overrides

PinItem(RadPageViewItem, NavigationViewItemPinPosition)

Pins a navigation item to a specific position within the navigation view layout.

Declaration
public void PinItem(RadPageViewItem item, NavigationViewItemPinPosition position)
Parameters
RadPageViewItem item

The navigation item to be pinned.
NavigationViewItemPinPosition position

The target pin position for the item.

PinPage(RadPageViewPage, NavigationViewItemPinPosition)

Pins a page item to a specific position within the navigation view layout.

Declaration
public void PinPage(RadPageViewPage page, NavigationViewItemPinPosition position)
Parameters
RadPageViewPage page

The page whose navigation item will be pinned.
NavigationViewItemPinPosition position

The target pin position for the item.

RemoveItemCore(RadPageViewItem)

Handles the removal of a navigation item from the view, performing necessary cleanup operations.

Declaration
protected override void RemoveItemCore(RadPageViewItem item)
Parameters
RadPageViewItem item

The navigation item being removed from the view.
Overrides

SelectNextItemCore(RadPageViewItem, Boolean, Boolean)

Handles navigation between items in the view, supporting hierarchical structures and proper focus management.

Declaration
protected override bool SelectNextItemCore(RadPageViewItem current, bool forward, bool wrap)
Parameters
RadPageViewItem current

The currently selected navigation item.
System.Boolean forward

True to navigate forward, false to navigate backward.
System.Boolean wrap

True to allow wrapping from the last item to the first or vice versa.
Returns
System.Boolean

True if navigation was successful, false otherwise.
Overrides

SetDisplayMode(NavigationViewDisplayModes)

Configures the navigation view for the specified display mode and applies the appropriate layout settings.

Declaration
protected virtual void SetDisplayMode(NavigationViewDisplayModes mode)
Parameters
NavigationViewDisplayModes mode

The display mode to be applied to the navigation view.

SetSelectedItem(RadPageViewItem)

Sets the specified navigation item as the currently selected item and updates the navigation view accordingly.

Declaration
protected override void SetSelectedItem(RadPageViewItem item)
Parameters
RadPageViewItem item

The navigation item to be selected.
Overrides

ShouldArrangeChild(RadElement)

Determines whether a specific child element should participate in the arrange phase of layout.

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

The child element to evaluate for arrangement participation.
Returns
System.Boolean

True if the child should be arranged, false if it should be excluded from arrangement.
Overrides

ShouldMeasureChild(RadElement)

Determines whether a specific child element should participate in the measure phase of layout.

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

The child element to evaluate for measurement participation.
Returns
System.Boolean

True if the child should be measured, false if it should be excluded from measurement.
Overrides

UnpinItem(RadPageViewItem)

Removes the pinned status from a navigation item, allowing it to return to its normal position.

Declaration
public void UnpinItem(RadPageViewItem item)
Parameters
RadPageViewItem item

The navigation item to be unpinned.

UnpinPage(RadPageViewPage)

Removes the pinned status from a page item, allowing it to return to its normal position.

Declaration
public void UnpinPage(RadPageViewPage page)
Parameters
RadPageViewPage page

The page to be unpinned.

Events

Collapsed

Occurs after the hamburger menu is collapsed.

Declaration
public event EventHandler Collapsed
Event Type
System.EventHandler

Collapsing

Occurs before the hamburger menu is collapsed.

Declaration
public event CancelEventHandler Collapsing
Event Type
System.ComponentModel.CancelEventHandler

Expanded

Occurs after the hamburger menu is expanded.

Declaration
public event EventHandler Expanded
Event Type
System.EventHandler

Expanding

Occurs before the hamburger menu is expanded.

Declaration
public event CancelEventHandler Expanding
Event Type
System.ComponentModel.CancelEventHandler

ItemCollapsed

Occurs after a hierarchical navigation item is collapsed.

Declaration
public event EventHandler ItemCollapsed
Event Type
System.EventHandler

ItemCollapsing

Occurs before a hierarchical navigation item is collapsed.

Declaration
public event CancelEventHandler ItemCollapsing
Event Type
System.ComponentModel.CancelEventHandler

ItemExpanded

Occurs after a hierarchical navigation item is expanded.

Declaration
public event EventHandler ItemExpanded
Event Type
System.EventHandler

ItemExpanding

Occurs before a hierarchical navigation item is expanded.

Declaration
public event CancelEventHandler ItemExpanding
Event Type
System.ComponentModel.CancelEventHandler

ItemPopupClosed

Occurs after a hierarchy popup associated with a RadPageViewNavigationViewItem has closed. The actual item is passed as the sender in the event handler.

Declaration
public event EventHandler ItemPopupClosed
Event Type
System.EventHandler

ItemPopupClosing

Occurs before a hierarchy popup associated with a RadPageViewNavigationViewItem closes. The actual item is passed as the sender in the event handler.

Declaration
public event CancelEventHandler ItemPopupClosing
Event Type
System.ComponentModel.CancelEventHandler

ItemPopupOpened

Occurs after a hierarchical popup associated with a RadPageViewNavigationViewItem has opened. The actual item is passed as the sender in the event handler.

Declaration
public event EventHandler ItemPopupOpened
Event Type
System.EventHandler

ItemPopupOpening

Occurs before a hierarchical popup associated with a RadPageViewNavigationViewItem opens. The actual item is passed as the sender in the event handler.

Declaration
public event CancelEventHandler ItemPopupOpening
Event Type
System.ComponentModel.CancelEventHandler

Extension Methods