New to Telerik UI for WinForms? Start a free 30-day trial

NavigationViewItemLayout

Class

Represents a specialized layout implementation for navigation view items that supports header and footer item pinning. Extends StripViewItemLayout to provide hierarchical arrangement of navigation items with fixed header and footer areas alongside a scrollable content region for regular items.

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.UI.dll

Syntax:

public class NavigationViewItemLayout : StripViewItemLayout, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IBindableComponent, IComponent, IDisposable, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider

Inheritance: objectDisposableObjectRadObjectRadElementVisualElementRadComponentElementRadItemUIItemBaseLightVisualElementRadPageViewElementBaseStripViewItemLayoutNavigationViewItemLayout...

Derived Classes: NavigationViewPopupItemLayout

Implements: IBindableComponentIBorderElementIBoxElementIBoxStyleIComponentICustomTypeDescriptorIDisposableIDrawFillElementIFillElementIImageElementINotifyPropertyChangedIPrimitiveElementIShapedElementIShortcutProviderIStylableElementIStylableNodeISupportDragISupportDropISupportSystemSkinITextPrimitiveITextProvider...

Constructors

NavigationViewItemLayout()

public NavigationViewItemLayout()

Properties

FooterAreaHeight

float

Gets the total height of the footer area containing all pinned footer items and their background. The height is calculated dynamically based on visible footer items and includes spacing and margins.

protected float FooterAreaHeight { get; }

HeaderAreaHeight

float

Gets the total height of the header area containing all pinned header items and their background. The height is calculated dynamically based on visible header items and includes spacing and margins.

protected float HeaderAreaHeight { get; }

Methods

ArrangeItems(RectangleF, RectangleF, IEnumerable<RadElement>, int, int, ref float, ref float)

Arranges a collection of navigation view items within the specified client rectangles with hierarchical level support. Provides a virtual implementation for arranging items that can be overridden by derived classes to customize arrangement behavior.

protected virtual void ArrangeItems(RectangleF client, RectangleF clientNoOffset, IEnumerable<RadElement> items, int zIndex, int level, ref float left, ref float top)

Parameters:clientRectangleF

The client rectangle including scroll offset for item positioning.

clientNoOffsetRectangleF

The client rectangle without scroll offset for reference positioning.

itemsIEnumerable<RadElement>

The collection of RadElement items to arrange.

zIndexint

The Z-index value to assign to the arranged items for layering.

levelint

The hierarchical level of the items being arranged for indentation and styling.

leftfloat

The left position reference that gets updated as items are arranged horizontally.

topfloat

The top position reference that gets updated as items are arranged vertically.

ArrangeItems(RectangleF, RectangleF)

Arranges navigation view items by categorizing them into header, scrollable, and footer groups based on their pin position. Handles the layout of pinned header items, scrollable content items, and pinned footer items with proper background arrangements and scroll bar positioning considerations.

protected override void ArrangeItems(RectangleF client, RectangleF clientNoOffset)

Parameters:clientRectangleF

The client rectangle including scroll offset for arranging scrollable items.

clientNoOffsetRectangleF

The client rectangle without scroll offset for arranging pinned items.

Overrides: StripViewItemLayout.ArrangeItems(RectangleF, RectangleF)

CoerceScrollOffset(int)

Coerces the scroll offset to ensure it remains within valid bounds considering header and footer areas. Adjusts the scroll offset to prevent scrolling beyond the content limits while accounting for the heights of header and footer background separators.

protected override int CoerceScrollOffset(int offset)

Parameters:offsetint

The proposed scroll offset value to validate and adjust.

Returns:

int

The coerced scroll offset value constrained within valid bounds.

Overrides: StripViewItemLayout.CoerceScrollOffset(int)

CreateChildElements()

Creates the child elements required for the navigation view layout including header and footer background items. Configures the visual background elements for pinned header and footer areas with appropriate styling classes.

protected override void CreateChildElements()

Overrides: RadElement.CreateChildElements()

InitializeFields()

Initializes the fields and properties specific to the NavigationViewItemLayout. Configures mouse input notification, capture behavior, and focus settings for navigation view behavior.

protected override void InitializeFields()

Overrides: StripViewItemLayout.InitializeFields()

MeasureOverride(SizeF)

Measures the layout and calculates the desired size including header and footer background elements. Extends the base measurement by adding the heights of header and footer background areas to the total layout size.

protected override SizeF MeasureOverride(SizeF availableSize)

Parameters:availableSizeSizeF

The available size that this element can use to arrange itself and its children.

Returns:

SizeF

The desired size of this element including header and footer areas.

Overrides: StripViewItemLayout.MeasureOverride(SizeF)

ScrollToItem(RadPageViewItem)

Scrolls the layout to ensure the specified navigation view item is visible within the scrollable content area. Handles scrolling logic for items that are not pinned to header or footer areas, adjusting the scroll position to bring the target item into the visible client rectangle.

protected override void ScrollToItem(RadPageViewItem item)

Parameters:itemRadPageViewItem

The RadPageViewItem to scroll to and make visible.

Overrides: StripViewItemLayout.ScrollToItem(RadPageViewItem)