Class

RadPageViewExplorerBarElement

Declaration

public RadPageViewExplorerBarElement()

Declaration

public static readonly RadProperty ContentSizeModeProperty

Field Value

Gets or sets a value from the ExplorerBarContentSizeMode enum that defines how the content areas for each item are sized.

Declaration

public ExplorerBarContentSizeMode ContentSizeMode { get; set; }

Property Value

Gets a value indicating whether non-client area modification is enabled for the explorer bar view.

Declaration

protected override bool EnableNCModification { get; }

Property Value

Overrides RadPageViewElement.EnableNCModification

Gets a value indicating whether non-client area painting is enabled for the explorer bar view.

Declaration

protected override bool EnableNCPainting { get; }

Property Value

Overrides RadPageViewElement.EnableNCPainting

Gets an instance of the RadScrollBarElement that represents the scrollbar of the RadPageViewExplorerBarElement.

Declaration

[Browsable(false)]
public RadScrollBarElement Scrollbar { get; }

Property Value

Arranges the content areas for all explorer bar items by calculating layout information and positioning each item's associated content area element within the available space.

Declaration

protected override RectangleF ArrangeContent(RectangleF clientRect)

Parameters

Returns

Overrides RadPageViewElement.ArrangeContent(RectangleF)

Arranges the explorer bar element by resetting the layout offset based on scrollbar visibility and delegating to the base arrangement implementation.

Declaration

protected override SizeF ArrangeOverride(SizeF finalSize)

Parameters

Returns

Overrides RadPageViewElement.ArrangeOverride(SizeF)

Arranges the scrollbar within the specified client rectangle, positioning it based on the current stack position and RTL settings, then updates the scrollbar metrics.

Declaration

protected virtual RectangleF ArrangeScrollbar(RectangleF clientRect)

Parameters

Returns

Checks whether the scrollbar should be shown by comparing the client rectangle dimensions with the full layout length to determine if content overflow exists.

Declaration

protected virtual bool CheckShowScrollbar(RectangleF clientRect)

Parameters

Returns

Creates and initializes the child elements including the scrollbar for the explorer bar view, setting up event handlers and default properties for proper scrolling functionality.

Declaration

protected override void CreateChildElements()

Overrides RadPageViewStackElement.CreateChildElements()

Creates a new explorer bar item instance for use in the explorer bar view.

Declaration

protected override RadPageViewItem CreateItem()

Returns

Overrides RadPageViewStackElement.CreateItem()

Disposes of managed resources by unsubscribing from event handlers to prevent memory leaks and ensure proper cleanup of the explorer bar element.

Declaration

protected override void DisposeManagedResources()

Overrides RadPageViewElement.DisposeManagedResources()

Ensures the specified item is visible by scrolling to it within the explorer bar view.

Declaration

protected override bool EnsureItemVisibleCore(RadPageViewItem item)

Parameters

Returns

Overrides RadPageViewElement.EnsureItemVisibleCore(RadPageViewItem)

Ensures the specified explorer bar item is visible by calculating the required scroll offset and adjusting the scrollbar value to position the item within the visible area.

Declaration

protected virtual void EnsureVisible(RadPageViewExplorerBarItem item)

Parameters

Finds the parent control of the specified control by traversing up the hierarchy, excluding RadPageViewPage instances to find the actual parent control.

Declaration

protected virtual Control FindParentControl(Control activeControl)

Parameters

Returns

Finds the parent RadPageViewItem associated with the specified control by traversing up the control hierarchy to locate the containing RadPageViewPage.

Declaration

protected virtual RadPageViewItem FindParentItem(Control activeControl)

Parameters

Returns

Finds the vertical offset of the specified control by traversing up the parent hierarchy and accumulating Y coordinates until reaching the element tree control.

Declaration

protected virtual int FindParentOffset(Control activeControl)

Parameters

Returns

Gets the border thickness for the explorer bar element, returning empty padding when checking draw border to disable default border drawing in favor of non-client area painting.

Declaration

protected override Padding GetBorderThickness(bool checkDrawBorder)

Parameters

Returns

Overrides LightVisualElement.GetBorderThickness(bool)

Gets the client rectangle by adjusting the base client rectangle with non-client area metrics, accounting for header, footer, and border dimensions when an owner is present.

Declaration

protected override RectangleF GetClientRectangle(SizeF finalSize)

Parameters

Returns

Overrides LightVisualElement.GetClientRectangle(SizeF)

Gets the content area element associated with the specified item. In explorer bar view, each item has its own dedicated content area element for displaying expanded content.

Declaration

public override RadPageViewContentAreaElement GetContentAreaForItem(RadPageViewItem item)

Parameters

Returns

Overrides RadPageViewElement.GetContentAreaForItem(RadPageViewItem)

Gets the layout information for all content areas by calculating the content rectangle for each explorer bar item and creating layout info objects for arrangement.

Declaration

protected List<ContentAreaLayoutInfo> GetContentAreaLayoutInfos(RectangleF clientRect)

Parameters

Returns

Gets the focused control from the specified control collection by recursively searching through the hierarchy for a control that contains focus.

Declaration

protected virtual Control GetFocusedControl(Control.ControlCollection controls)

Parameters

Returns

Gets the initial offset for positioning items within the client rectangle, based on the current scrolling position and layout requirements.

Declaration

protected override float GetInitialItemsOffset(RectangleF clientRect)

Parameters

Returns

Overrides RadPageViewStackElement.GetInitialItemsOffset(RectangleF)

Gets the rectangle area available for items layout by adjusting the client rectangle to account for header and footer elements with their margins and desired sizes.

Declaration

public override RectangleF GetItemsRect()

Returns

Overrides RadPageViewStackElement.GetItemsRect()

Gets the non-client area metrics including border thickness and header/footer dimensions, with processing controlled by the allowNCCALCSIZEProcessing flag.

Declaration

protected override Padding GetNCMetrics()

Returns

Overrides RadPageViewElement.GetNCMetrics()

Gets the next focused control from the control collection based on tab index navigation, supporting both forward and backward navigation through controls.

Declaration

protected virtual Control GetNextFocusedControl(Control.ControlCollection controls, int currentTabIndex, int step)

Parameters

Returns

Gets the arrow direction for peek popup displays in the explorer bar view, returning up direction to align with the vertical layout of the explorer bar items.

Declaration

protected override ArrowDirection GetPeekPopupArrowDirection()

Returns

Overrides RadPageViewElement.GetPeekPopupArrowDirection()

Initializes default field values for the explorer bar element, setting the item selection mode to content after selected and stack position to top for proper explorer bar behavior.

Declaration

protected override void InitializeFields()

Overrides RadPageViewStackElement.InitializeFields()

Determines whether the specified element is considered external to the normal child element hierarchy, excluding the scrollbar from external element checks.

Declaration

protected override bool IsChildElementExternal(RadElement element)

Parameters

Returns

Overrides RadPageViewElement.IsChildElementExternal(RadElement)

Determines whether the specified key represents a "next" navigation key based on the current stack position, with Up key for top position and Left key for left position.

Declaration

protected override bool IsNextKey(Keys key)

Parameters

Returns

Overrides RadPageViewStackElement.IsNextKey(Keys)

Determines whether the specified key represents a "previous" navigation key based on the current stack position, with Down key for top position and Right key for left position.

Declaration

protected override bool IsPreviousKey(Keys key)

Parameters

Returns

Overrides RadPageViewStackElement.IsPreviousKey(Keys)

Measures the content area by measuring the scrollbar and returns empty size since content areas are handled individually for each explorer bar item.

Declaration

protected override SizeF MeasureContentArea(ref SizeF availableSize)

Parameters

Returns

Overrides RadPageViewStackElement.MeasureContentArea(ref SizeF)

Measures all items in the explorer bar, accounting for scrollbar space and calculating content sizes for each expanded item based on their associated content area requirements.

Declaration

protected override SizeF MeasureItems(SizeF availableSize)

Parameters

Returns

Overrides RadPageViewStackElement.MeasureItems(SizeF)

Handles bounds changes by checking if non-client area metrics have changed and refreshing the non-client area accordingly to maintain proper visual layout.

Declaration

protected override void OnBoundsChanged(RadPropertyChangedEventArgs e)

Parameters

Overrides UIItemBase.OnBoundsChanged(RadPropertyChangedEventArgs)

Handles content bounds changes by updating the bounds of all visible pages to match their associated content area elements, ensuring proper page layout synchronization.

Declaration

protected override void OnContentBoundsChanged()

Overrides RadPageViewElement.OnContentBoundsChanged()

Raises the ExpandedChanged event when an explorer bar item's expanded state changes, allowing subscribers to respond to expansion and collapse operations.

Declaration

protected virtual void OnExpandedChanged(RadPageViewExpandedChangedEventArgs e)

Parameters

Handles the collapsing event for an explorer bar item by raising the appropriate events and allowing cancellation of the collapse operation.

Declaration

protected virtual bool OnItemCollapsing(RadPageViewExplorerBarItem item)

Parameters

Returns

Handles the expanding event for an explorer bar item by raising the appropriate events and allowing cancellation of the expansion operation.

Declaration

protected virtual bool OnItemExpanding(RadPageViewExplorerBarItem item)

Parameters

Returns

Handles mouse up events on explorer bar items by toggling their expanded state when left-clicked, providing the primary interaction mechanism for expand/collapse operations.

Declaration

protected override void OnItemMouseUp(RadPageViewItem sender, MouseEventArgs e)

Parameters

Overrides RadPageViewElement.OnItemMouseUp(RadPageViewItem, MouseEventArgs)

Handles the loaded event by setting the page visibility for all explorer bar items based on their expanded state, ensuring proper initial display of content areas.

Declaration

protected override void OnLoaded()

Overrides RadPageViewElement.OnLoaded()

Handles mouse wheel events by translating wheel movements into scrollbar value changes, enabling smooth scrolling through the explorer bar items.

Declaration

protected override void OnMouseWheel(MouseEventArgs e)

Parameters

Overrides RadElement.OnMouseWheel(MouseEventArgs)

Handles non-client area painting by rendering header, footer, and border elements in separate bitmaps for each area (top, left, right, bottom) and compositing them onto the graphics context.

Declaration

protected override void OnNCPaint(Graphics g)

Parameters

Overrides RadPageViewElement.OnNCPaint(Graphics)

Handles page addition by creating an explorer bar item and associating it with a content area element, setting up the proper item-to-content relationship for the explorer bar view.

Declaration

protected override void OnPageAdded(RadPageViewEventArgs e)

Parameters

Overrides RadPageViewElement.OnPageAdded(RadPageViewEventArgs)

Handles page removal by disposing of the associated content area element and cleaning up the item-to-content relationship for the explorer bar view.

Declaration

protected override void OnPageRemoved(RadPageViewEventArgs e)

Parameters

Overrides RadPageViewElement.OnPageRemoved(RadPageViewEventArgs)

Handles property change events, with special handling for stack position changes to update scrollbar parameters and ensure proper layout orientation.

Declaration

protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)

Parameters

Overrides RadPageViewStackElement.OnPropertyChanged(RadPropertyChangedEventArgs)

Handles selected page changes by refreshing the non-client area to ensure proper visual updates when the selected explorer bar item changes.

Declaration

protected override void OnSelectedPageChanged(RadPageViewEventArgs e)

Parameters

Overrides RadPageViewElement.OnSelectedPageChanged(RadPageViewEventArgs)

Finds the explorer bar item that contains a control with focus by checking all items for focused controls within their page control collections.

Declaration

protected virtual RadPageViewStackItem PageWithFocusedControl()

Returns

Overrides border painting to disable default border rendering for the explorer bar view, as borders are handled through the non-client area painting mechanism.

Declaration

protected override void PaintBorder(IGraphics graphics, float angle, SizeF scale)

Parameters

Overrides UIItemBase.PaintBorder(IGraphics, float, SizeF)

Performs the arrangement of elements by correcting the client rectangle for scrollbar space, arranging content and items, and updating scrollbar positioning.

Declaration

protected override RectangleF PerformArrange(RectangleF clientRect)

Parameters

Returns

Overrides RadPageViewElement.PerformArrange(RectangleF)

Processes auto-scroll functionality for the specified control by calculating the required scroll offset and updating the scrollbar value to ensure the control becomes visible.

Declaration

protected virtual void ProcessAutoScroll(Control activeControl, bool ensureVisibility)

Parameters

Processes key down events to handle expansion and collapse of explorer bar items using arrow keys, with key mappings that depend on the current stack position orientation.

Declaration

protected override void ProcessKeyDown(KeyEventArgs e)

Parameters

Overrides RadPageViewElement.ProcessKeyDown(KeyEventArgs)

Scrolls to make the specified control visible in the explorer bar view by expanding its parent item if needed, processing auto-scroll, and focusing the control.

Declaration

public virtual void ScrollToControl(Control control)

Parameters

Scrolls the view to make the specified explorer bar item visible within the client area, adjusting the scrollbar value and layout offset as needed.

Declaration

public virtual bool ScrollToItem(RadPageViewExplorerBarItem item)

Parameters

Returns

Sets the index of an explorer bar item by moving it within both the items collection and the children collection, ensuring proper synchronization between logical and visual ordering.

Declaration

protected override void SetItemIndex(int currentIndex, int newIndex)

Parameters

Overrides RadPageViewElement.SetItemIndex(int, int)

Sets the selected content for the specified item. In explorer bar view, content selection is handled differently as each item has its own associated content area.

Declaration

protected override void SetSelectedContent(RadPageViewItem item)

Parameters

Overrides RadPageViewElement.SetSelectedContent(RadPageViewItem)

Sets the value of a property with validation for explorer bar specific constraints, preventing invalid item selection modes and stack positions that are not supported by the explorer bar view.

Declaration

protected override ValueUpdateResult SetValueCore(RadPropertyValue propVal, object propModifier, object newValue, ValueSource source)

Parameters

Returns

Overrides RadElement.SetValueCore(RadPropertyValue, object, object, ValueSource)

Updates scrollbar metrics and arranges the scrollbar within the client rectangle, managing scrollbar visibility based on content overflow and correcting layout offsets as needed.

Declaration

protected virtual void UpdateAndArrangeScrollbar(RectangleF clientRect)

Parameters

Updates the scrollbar metrics including large change, minimum, and maximum values based on the client rectangle dimensions and full layout length calculations.

Declaration

protected virtual void UpdateScrollbarMetrics(RectangleF clientRect)

Parameters

Occurs when an explorer bar item's expanded state changes, allowing subscribers to respond to expansion and collapse operations.

Declaration

public event EventHandler<RadPageViewExpandedChangedEventArgs> ExpandedChanged

Event Value