Class

RadPageViewNavigationViewElement

Initializes a new instance of the RadPageViewNavigationViewElement class.

Declaration

public RadPageViewNavigationViewElement()

Identifies the CollapsedGlyph dependency property.

Declaration

public static RadProperty CollapsedGlyphProperty

Field Value

Identifies the CollapsedPaneWidth dependency property.

Declaration

public static RadProperty CollapsedPaneWidthProperty

Field Value

Identifies the CompactModeThresholdWidth dependency property.

Declaration

public static RadProperty CompactModeThresholdWidthProperty

Field Value

Identifies the DisplayMode dependency property.

Declaration

public static RadProperty DisplayModeProperty

Field Value

Identifies the ExpandedGlyph dependency property.

Declaration

public static RadProperty ExpandedGlyphProperty

Field Value

Identifies the ExpandedModeThresholdWidth dependency property.

Declaration

public static RadProperty ExpandedModeThresholdWidthProperty

Field Value

Identifies the ExpandedPaneWidth dependency property.

Declaration

public static RadProperty ExpandedPaneWidthProperty

Field Value

Identifies the HeaderHeight dependency property.

Declaration

public static RadProperty HeaderHeightProperty

Field Value

Identifies the HierarchyIndent dependency property.

Declaration

public static RadProperty HierarchyIndentProperty

Field Value

Identifies the HierarchyPopupExpandMode dependency property.

Declaration

public static RadProperty HierarchyPopupExpandModeProperty

Field Value

Identifies the ItemExpandCollapseMode dependency property.

Declaration

public static RadProperty ItemExpandCollapseModeProperty

Field Value

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

Declaration

public bool AllowAnimation { get; set; }

Property Value

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

Declaration

public int AnimationFrames { get; set; }

Property Value

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

Declaration

public int AnimationInterval { get; set; }

Property Value

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

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

Declaration

public int CollapsedPaneWidth { get; set; }

Property Value

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

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

Declaration

public NavigationViewDisplayModes DisplayMode { get; set; }

Property Value

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

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

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

Declaration

public int ExpandedPaneWidth { get; set; }

Property Value

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

Declaration

public RadButtonElement HamburgerButton { get; }

Property Value

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

Declaration

public NavigationViewHeaderElement HeaderElement { get; }

Property Value

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

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

Declaration

public int HierarchyIndent { get; set; }

Property Value

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

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

Declaration

public bool IsCollapsed { get; }

Property Value

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

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

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

Declaration

public override StripViewNewItemVisibility NewItemVisibility { get; set; }

Property Value

Overrides RadPageViewStripElement.NewItemVisibility

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

Declaration

public virtual RadPopupControlBase Popup { get; }

Property Value

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

Declaration

public virtual StackLayoutElement PopupStack { get; }

Property Value

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

Declaration

public void AddFooterItem(RadPageViewItem item)

Parameters

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

Declaration

public void AddFooterPage(RadPageViewPage page)

Parameters

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

Declaration

public void AddHeaderItem(RadPageViewItem item)

Parameters

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

Declaration

public void AddHeaderPage(RadPageViewPage page)

Parameters

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

Declaration

protected override void AddItemCore(RadPageViewItem item)

Parameters

Overrides RadPageViewStripElement.AddItemCore(RadPageViewItem)

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

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

Declaration

protected override RectangleF ArrangeItems(RectangleF itemsRect)

Parameters

Returns

Overrides RadPageViewStripElement.ArrangeItems(RectangleF)

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

Returns

Overrides RadPageViewElement.ArrangeOverride(SizeF)

This method is not relevant for this class.

Declaration

protected override void CloseItem(RadPageViewItem item)

Parameters

Overrides RadPageViewStripElement.CloseItem(RadPageViewItem)

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

Declaration

public virtual void Collapse()

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

Declaration

protected override void CreateChildElements()

Overrides RadPageViewStripElement.CreateChildElements()

Creates the hamburger button element for the navigation view.

Declaration

protected virtual HamburgerButtonElement CreateHamburgerButton()

Returns

Creates the header element for the navigation view.

Declaration

protected virtual NavigationViewHeaderElement CreateHeaderElement()

Returns

Creates a new navigation view item.

Declaration

protected override RadPageViewItem CreateItem()

Returns

Overrides RadPageViewStripElement.CreateItem()

Creates a new item container for the navigation view.

Declaration

protected override StripViewItemContainer CreateItemContainer()

Returns

Overrides RadPageViewStripElement.CreateItemContainer()

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

Declaration

protected virtual RadPopupControlBase CreatePopup()

Returns

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

Declaration

protected virtual StackLayoutElement CreatePopupStack()

Returns

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

Declaration

protected virtual void EnsureDisplayMode(NavigationViewDisplayModes mode)

Parameters

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

Declaration

public virtual void Expand()

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

Declaration

protected virtual NavigationViewDisplayModes GetEffectiveDisplayMode()

Returns

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

Declaration

protected virtual NavigationViewDisplayModes GetEffectiveDisplayMode(float width)

Parameters

Returns

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

Declaration

protected override ArrowDirection GetPeekPopupArrowDirection()

Returns

Overrides RadPageViewStripElement.GetPeekPopupArrowDirection()

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

Declaration

protected override SizeF MeasureItems(SizeF availableSize)

Parameters

Returns

Overrides RadPageViewStripElement.MeasureItems(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

Returns

Overrides RadPageViewElement.MeasureOverride(SizeF)

Fires the event.

Declaration

protected virtual void OnCollapsed(EventArgs e)

Parameters

Fires the event.

Declaration

protected virtual void OnCollapsing(CancelEventArgs e)

Parameters

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

Declaration

protected override void OnEnabledChanged(RadPropertyChangedEventArgs e)

Parameters

Overrides RadItem.OnEnabledChanged(RadPropertyChangedEventArgs)

Fires the event.

Declaration

protected virtual void OnExpanded(EventArgs e)

Parameters

Fires the event.

Declaration

protected virtual void OnExpanding(CancelEventArgs e)

Parameters

Fires the event.

Declaration

protected virtual void OnItemCollapsed(object item, EventArgs e)

Parameters

Fires the event.

Declaration

protected virtual void OnItemCollapsing(object item, CancelEventArgs e)

Parameters

Fires the event.

Declaration

protected virtual void OnItemExpanded(object item, EventArgs e)

Parameters

Fires the event.

Declaration

protected virtual void OnItemExpanding(object item, CancelEventArgs e)

Parameters

Fires the event.

Declaration

protected virtual void OnItemPopupClosed(object item, EventArgs e)

Parameters

Fires the event.

Declaration

protected virtual void OnItemPopupClosing(object item, CancelEventArgs e)

Parameters

Fires the event.

Declaration

protected virtual void OnItemPopupOpened(object item, EventArgs e)

Parameters

Fires the event.

Declaration

protected virtual void OnItemPopupOpening(object item, CancelEventArgs e)

Parameters

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

Declaration

protected override void OnLoaded()

Overrides RadPageViewElement.OnLoaded()

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

Declaration

protected override void OnNotifyPropertyChanged(PropertyChangedEventArgs e)

Parameters

Overrides RadObject.OnNotifyPropertyChanged(PropertyChangedEventArgs)

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

Declaration

protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)

Parameters

Overrides RadPageViewStripElement.OnPropertyChanged(RadPropertyChangedEventArgs)

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

Declaration

public void PinItem(RadPageViewItem item, NavigationViewItemPinPosition position)

Parameters

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

Declaration

public void PinPage(RadPageViewPage page, NavigationViewItemPinPosition position)

Parameters

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

Declaration

protected override void RemoveItemCore(RadPageViewItem item)

Parameters

Overrides RadPageViewElement.RemoveItemCore(RadPageViewItem)

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

Returns

Overrides RadPageViewElement.SelectNextItemCore(RadPageViewItem, bool, bool)

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

Declaration

protected virtual void SetDisplayMode(NavigationViewDisplayModes mode)

Parameters

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

Declaration

protected override void SetSelectedItem(RadPageViewItem item)

Parameters

Overrides RadPageViewStripElement.SetSelectedItem(RadPageViewItem)

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

Declaration

protected override bool ShouldArrangeChild(RadElement child)

Parameters

Returns

Overrides RadElement.ShouldArrangeChild(RadElement)

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

Declaration

protected override bool ShouldMeasureChild(RadElement child)

Parameters

Returns

Overrides RadElement.ShouldMeasureChild(RadElement)

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

Declaration

public void UnpinItem(RadPageViewItem item)

Parameters

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

Declaration

public void UnpinPage(RadPageViewPage page)