Class

RadPageViewElement

Initializes a new instance of the RadPageViewElement class.

Declaration

public RadPageViewElement()

Identifies the EnsureSelectedItemVisible dependency property.

Declaration

public static RadProperty EnsureSelectedItemVisibleProperty

Field Value

Identifies the ItemBorderAndFillOrientation dependency property.

Declaration

public static RadProperty ItemBorderAndFillOrientationProperty

Field Value

Identifies the ItemContentOrientation dependency property.

Declaration

public static RadProperty ItemContentOrientationProperty

Field Value

Identifies the ItemDragHint dependency property.

Declaration

public static RadProperty ItemDragHintProperty

Field Value

Identifies the ItemDragMode dependency property.

Declaration

public static RadProperty ItemDragModeProperty

Field Value

Identifies the ItemSizeMode dependency property.

Declaration

public static RadProperty ItemSizeModeProperty

Field Value

Identifies the ItemSpacing dependency property.

Declaration

public static RadProperty ItemSpacingProperty

Field Value

Identifies the ShowItemCloseButton dependency property.

Declaration

public static RadProperty ShowItemCloseButtonProperty

Field Value

Gets or sets the mouse button that will be used to select page view items.

Declaration

public MouseButtons ActionMouseButton { get; set; }

Property Value

Gets the active text editor used for in-place editing of page view items.

Declaration

public IInputEditor ActiveEditor { get; }

Property Value

Gets or sets a value indicating whether in-place editing of page view item text is allowed.

Declaration

[Browsable(false)]
public bool AllowEdit { get; set; }

Property Value

Gets the element that represents the content area where page controls are displayed.

Declaration

[Browsable(false)]
public RadPageViewElementBase ContentArea { get; }

Property Value

Gets or sets the default RadPageViewPage that will be selected when the element is initialized.

Declaration

public RadPageViewPage DefaultPage { get; set; }

Property Value

Declaration

protected virtual bool EnableNCModification { get; }

Property Value

Declaration

protected virtual bool EnableNCPainting { get; }

Property Value

Gets or sets a value indicating whether a peek pop-up window can be displayed when a page view item is hovered with the mouse. The content of the peek pop-up must be set in the PeekPopupOpening event.

Declaration

public virtual bool EnablePeekPopup { get; set; }

Property Value

Gets or sets a value indicating whether the currently selected item will be automatically scrolled into view.

Declaration

public bool EnsureSelectedItemVisible { get; set; }

Property Value

Gets the footer element that can be used to display text or content at the bottom of the page view.

Declaration

public virtual RadPageViewLabelElement Footer { get; }

Property Value

Gets the header element that can be used to display text or content at the top of the page view.

Declaration

public virtual RadPageViewLabelElement Header { get; }

Property Value

Gets or sets how each page view item's border and fill elements are oriented within this instance.

Declaration

public PageViewContentOrientation ItemBorderAndFillOrientation { get; set; }

Property Value

Gets or sets the content orientation for text and images within page view items in this RadPageViewElement instance.

Declaration

public PageViewContentOrientation ItemContentOrientation { get; set; }

Property Value

Gets or sets the RadImageShape instance that describes the visual hint indicating where an item will be dropped after a drag operation.

Declaration

[Browsable(false)]
[VsbBrowsable(true)]
public RadImageShape ItemDragHint { get; set; }

Property Value

Gets or sets the mode that controls how item drag and drop operations are handled within this element.

Declaration

public PageViewItemDragMode ItemDragMode { get; set; }

Property Value

Gets or sets the RadDragDropService instance that handles item drag and drop operations.

Declaration

[Browsable(false)]
public RadDragDropService ItemDragService { get; set; }

Property Value

Gets or sets the size that will be applied to page view items when ItemSizeMode is set to EqualSize.

Declaration

public Size ItemSize { get; set; }

Property Value

Gets or sets how page view items are sized within this RadPageViewElement instance.

Declaration

public PageViewItemSizeMode ItemSizeMode { get; set; }

Property Value

Gets or sets the spacing in pixels between adjacent page view items within this element.

Declaration

public int ItemSpacing { get; set; }

Property Value

Gets a read-only collection containing all the RadPageViewItem instances currently present within this element.

Declaration

[Browsable(false)]
public IReadOnlyCollection<RadPageViewItem> Items { get; }

Property Value

Gets the RadElement instance that serves as the parent container for all page view items.

Declaration

protected abstract RadElement ItemsParent { get; }

Property Value

Gets the RadContextMenu that displays the overflow pages when there are too many items to display.

Declaration

public RadContextMenu OverflowPagesContextMenu { get; }

Property Value

Gets the RadPageView instance that owns this element. May be null if this element is hosted on another RadControl instance.

Declaration

public RadPageView Owner { get; }

Property Value

Gets the peek pop-up window, which is represented by a RadCallout. The content of the peek pop-up must be set in the PeekPopupOpening event and EnablePeekPopup must be enabled.

Declaration

public RadCallout PeekPopup { get; }

Property Value

Gets or sets the time interval in milliseconds required to display a PeekPopup after a RadPageViewItem is hovered.

Declaration

public int PeekPopupInterval { get; set; }

Property Value

Gets the timer used to delay the display of the peek pop-up window.

Declaration

protected Timer PeekTimer { get; }

Property Value

Gets or sets the currently selected RadPageViewItem in this view.

Declaration

[Browsable(false)]
public RadPageViewItem SelectedItem { get; set; }

Property Value

Gets or sets a value indicating whether page selection will wrap around when using arrow keys for navigation. If set to true, pressing the right arrow key when the last page is selected will select the first page.

Declaration

[Browsable(true)]
public bool SelectionWrap { get; set; }

Property Value

Gets or sets a value indicating whether a close button will be displayed in each item, allowing the item to be closed.

Declaration

public bool ShowItemCloseButton { get; set; }

Property Value

Gets or sets a value indicating whether selecting an item will update the content displayed in the element's ContentArea.

Declaration

public bool UpdateSelectedItemContent { get; set; }

Property Value

Adds the specified RadPageViewItem to this element's items collection.

Declaration

public void AddItem(RadPageViewItem item)

Parameters

Performs the core logic for adding an item to the collection.

Declaration

protected virtual void AddItemCore(RadPageViewItem item)

Parameters

Declaration

protected virtual RectangleF ArrangeContent(RectangleF clientRect)

Parameters

Returns

Declaration

protected void ArrangeExternalElements(RectangleF clientRect, SizeF finalSize)

Parameters

Arranges the page view items and returns the available rectangle where the content area should be positioned.

Declaration

protected virtual RectangleF ArrangeItems(RectangleF itemsRect)

Parameters

Returns

Arranges the element by positioning both child elements and content within the specified final size, coordinating the layout of all visual components within the element bounds.

Declaration

protected override SizeF ArrangeOverride(SizeF finalSize)

Parameters

Returns

Overrides RadPageViewElementBase.ArrangeOverride(SizeF)

Puts the currently selected page view item into edit mode for in-place text editing.

Declaration

public bool BeginEdit()

Returns

Declaration

protected virtual bool CanDropOverItem(RadPageViewItem dragItem, RadPageViewItem hitItem)

Parameters

Returns

Determines whether the specified item can have a peek pop-up displayed when EnablePeekPopup is enabled.

Declaration

protected virtual bool CanPeekItem(RadPageViewItem item)

Parameters

Returns

Declaration

protected virtual bool CanSelectItem(RadPageViewItem item)

Parameters

Returns

Declaration

protected virtual void CloseItem(RadPageViewItem item)

Parameters

Creates the child elements that compose this page view element.

Declaration

protected override void CreateChildElements()

Overrides RadElement.CreateChildElements()

Creates a new RadPageViewItem instance for this element.

Declaration

protected abstract RadPageViewItem CreateItem()

Returns

Declaration

protected virtual RadContextMenu CreateOverflowPagesContextMenu()

Returns

Displays the item list menu using the specified element as the menu's owner.

Declaration

public void DisplayItemListMenu(RadPageViewElementBase menuOwner)

Parameters

Displays the item list menu using the specified element as the menu's owner and the specified alignment options.

Declaration

public void DisplayItemListMenu(RadPageViewElementBase menuOwner, HorizontalPopupAlignment hAlign, VerticalPopupAlignment vAlign)

Parameters

Displays the item list menu using the provided event arguments that contain menu configuration.

Declaration

protected virtual void DisplayItemListMenu(RadPageViewMenuDisplayingEventArgs e)

Parameters

Releases the managed resources used by this element.

Declaration

protected override void DisposeManagedResources()

Overrides LightVisualElement.DisposeManagedResources()

Commits any changes and ends the edit operation on the current page view item.

Declaration

public bool EndEdit()

Returns

Declaration

protected virtual void EndItemDrag(RadPageViewItem item)

Parameters

Ensures that the specified RadPageViewItem is visible within the view area.

Declaration

public bool EnsureItemVisible(RadPageViewItem item)

Parameters

Returns

Performs the core logic for ensuring that the specified item is visible.

Declaration

protected virtual bool EnsureItemVisibleCore(RadPageViewItem item)

Parameters

Returns

Finds the RadPageViewItem that contains the specified content element.

Declaration

public RadPageViewItem FindItem(RadElement content)

Parameters

Returns

Gets the default (automatic) item orientation, which may depend on implementation-specific settings.

Declaration

protected virtual PageViewContentOrientation GetAutomaticItemOrientation(bool content)

Parameters

Returns

Calculates the client rectangle for the specified content area element, excluding padding and border thickness.

Declaration

public virtual Rectangle GetClientRectangleFromContentElement(RadPageViewContentAreaElement contentArea)

Parameters

Returns

Gets the RadPageViewContentAreaElement instance that represents the content area associated with the specified item. By default, this method returns the main content area of the RadPageView control.

Declaration

public virtual RadPageViewContentAreaElement GetContentAreaForItem(RadPageViewItem item)

Parameters

Returns

Gets the rectangular area where the currently active page content may be displayed.

Declaration

public virtual Rectangle GetContentAreaRectangle()

Returns

Gets the RadPageViewItem at the specified index.

Declaration

public RadPageViewItem GetItemAt(int index)

Parameters

Returns

Gets the rectangular area where page view items are displayed within this element.

Declaration

public virtual RectangleF GetItemsRect()

Returns

Declaration

protected virtual Padding GetNCMetrics()

Returns

Declaration

protected virtual ArrowDirection GetPeekPopupArrowDirection()

Returns

Initializes the default field values for this element.

Declaration

protected override void InitializeFields()

Overrides RadPageViewElementBase.InitializeFields()

Inserts the specified RadPageViewItem at the specified index in this element's items collection.

Declaration

public void InsertItem(int index, RadPageViewItem item)

Parameters

Performs the core logic for inserting an item at the specified index.

Declaration

protected virtual void InsertItemCore(int index, RadPageViewItem item)

Parameters

Declaration

protected virtual bool IsChildElementExternal(RadElement element)

Parameters

Returns

Declaration

protected virtual bool IsNextKey(Keys key)

Parameters

Returns

Declaration

protected virtual bool IsPreviousKey(Keys key)

Parameters

Returns

Gets the RadPageViewItem that contains the specified point in client coordinates.

Declaration

public RadPageViewItem ItemFromPoint(Point client)

Parameters

Returns

Declaration

protected void MeasureExternalElements(SizeF clientSize, SizeF availableSize)

Parameters

Declaration

protected virtual SizeF MeasureItems(SizeF availableSize)

Parameters

Returns

Measures the element by calculating the desired size based on content and children, with special handling for vertical orientations where width and height dimensions are swapped in the final measurement.

Declaration

protected override SizeF MeasureOverride(SizeF availableSize)

Parameters

Returns

Overrides RadPageViewElementBase.MeasureOverride(SizeF)

Declaration

protected virtual void OnContentBoundsChanged()

Declaration

protected virtual void OnEditorInitialized(object sender, RadPageViewEditorEventArgs e)

Parameters

Declaration

protected virtual void OnItemClick(RadPageViewItem sender, EventArgs e)

Parameters

Declaration

protected virtual void OnItemContentChanged(RadPageViewItem item)

Parameters

Declaration

protected virtual bool OnItemContentChanging(RadPageViewItem item, RadElement newContent)

Parameters

Returns

Declaration

protected virtual RadPageViewItem OnItemCreating(RadPageViewItemCreatingEventArgs args)

Parameters

Returns

Declaration

protected virtual void OnItemDrag(RadPageViewItem sender, MouseEventArgs e)

Parameters

Declaration

protected virtual void OnItemDropped(object sender, RadPageViewItemDroppedEventArgs args)

Parameters

Declaration

protected virtual void OnItemDropping(object sender, RadPageViewItemDroppingEventArgs args)

Parameters

Declaration

protected virtual void OnItemMouseDown(RadPageViewItem sender, MouseEventArgs e)

Parameters

Declaration

protected virtual void OnItemMouseEnter(RadPageViewItem item)

Parameters

Declaration

protected virtual void OnItemMouseLeave(RadPageViewItem item)

Parameters

Declaration

protected virtual void OnItemMouseUp(RadPageViewItem sender, MouseEventArgs e)

Parameters

Declaration

protected virtual void OnItemPropertyChanged(RadPageViewItem item, RadPropertyChangedEventArgs e)

Parameters

Declaration