Class RadPageView

Represents a container control that displays a collection of pages, showing one page at a time with various view modes. Inherits from RadNCEnabledControl and provides tab-like functionality with multiple display styles.

Inheritance
System.Object
RadControl
RadNonClientUIControl
RadNCEnabledControl
RadPageView
RadNavigationView
RadOfficeNavigationBar
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

[TelerikToolboxCategory("Containers")]
public class RadPageView : RadNCEnabledControl, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider

Constructors

RadPageView()

Initializes a new instance of the RadPageView class with default settings.

Declaration
public RadPageView()

Properties

AllowShowFocusCues

Gets or sets a value indicating whether focus cues are displayed based on the control type and current UI state.

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

Overrides

AutoScroll

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

AutoSize

This member is not intended to be used directly from your code.

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

Overrides

BackColor

This member is not intended to be used directly from your code.

Declaration
public override Color BackColor { get; set; }
Property Value
System.Drawing.Color

Overrides

CanRaiseEvents

Gets a value indicating whether event raising is currently enabled for this control.

Declaration
protected override bool CanRaiseEvents { get; }
Property Value
System.Boolean

DefaultPage

Gets or sets the default RadPageViewPage that will be loaded after EndInit of the control. If the DefaultPage is null, the currently selected page will be loaded.

Declaration
public RadPageViewPage DefaultPage { get; set; }
Property Value
RadPageViewPage

DefaultSize

Gets the default size for the control.

Declaration
protected override Size DefaultSize { get; }
Property Value
System.Drawing.Size

DisplayRectangle

Gets the display rectangle for the control content area.

Declaration
public override Rectangle DisplayRectangle { get; }
Property Value
System.Drawing.Rectangle

EnableNCModification

Declaration
protected override bool EnableNCModification { get; }
Property Value
System.Boolean

Overrides

EnableNCPainting

Declaration
protected override bool EnableNCPainting { get; }
Property Value
System.Boolean

Overrides

EnablePeekPopup

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

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

ForeColor

This member is not intended to be used directly from your code.

Declaration
public override Color ForeColor { get; set; }
Property Value
System.Drawing.Color

Overrides

ItemSize

Gets or sets the size of the page view items when ItemSizeMode is set to EqualSize.

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

ItemSizeMode

Gets or sets how page view items will be sized within a RadPageViewElement instance.

Declaration
public PageViewItemSizeMode ItemSizeMode { get; set; }
Property Value
PageViewItemSizeMode

PageBackColor

Gets or sets the background color that will be applied to all pages in the control.

Declaration
public Color PageBackColor { get; set; }
Property Value
System.Drawing.Color

Pages

Gets the collection of pages contained within this view.

Declaration
public RadPageViewPageCollection Pages { get; }
Property Value
RadPageViewPageCollection

PeekPopup

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

Declaration
public RadCallout PeekPopup { get; }
Property Value
RadCallout

PeekPopupInterval

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

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

SelectedPage

Gets or sets the RadPageViewPage instance that is currently selected within the view.

Declaration
public RadPageViewPage SelectedPage { get; set; }
Property Value
RadPageViewPage

SelectionWrap

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
public bool SelectionWrap { get; set; }
Property Value
System.Boolean

Text

This member is not intended to be used directly from your code.

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

Overrides

UseMnemonic

Gets or sets a value indicating whether the ampersand character (&) will be treated as a mnemonic prefix.

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

ViewElement

Gets the current RadPageViewElement instance that represents the UI of the view.

Declaration
public virtual RadPageViewElement ViewElement { get; }
Property Value
RadPageViewElement

ViewMode

Gets or sets the current display mode of the page view control.

Declaration
public virtual PageViewMode ViewMode { get; set; }
Property Value
PageViewMode

Methods

CanEditElementAtDesignTime(RadElement)

Declaration
protected override bool CanEditElementAtDesignTime(RadElement element)
Parameters
RadElement element

Returns
System.Boolean

Overrides

Construct()

Constructs the internal components of the RadPageView control including the page collection and view mode setup.

Declaration
protected override void Construct()
Overrides

CreateAccessibilityInstance()

Creates an accessibility object for this control.

Declaration
protected override AccessibleObject CreateAccessibilityInstance()
Returns
System.Windows.Forms.AccessibleObject

A new accessibility object for this control.

CreateControlsInstance()

Creates and returns a new controls collection for this control.

Declaration
protected override Control.ControlCollection CreateControlsInstance()
Returns
System.Windows.Forms.Control.ControlCollection

A new RadPageViewControlCollection instance.

CreatePagesInstance()

Creates and returns a new pages collection for this control.

Declaration
protected virtual RadPageViewPageCollection CreatePagesInstance()
Returns
RadPageViewPageCollection

A new RadPageViewPageCollection instance.

CreateUI()

Creates the appropriate RadPageViewElement instance based on the current view mode.

Declaration
protected virtual RadPageViewElement CreateUI()
Returns
RadPageViewElement

A new RadPageViewElement instance.

EndInit()

Declaration
public override void EndInit()
Overrides

EnsurePageVisible(RadPageViewPage)

Ensures that the specified page is visible within the view.

Declaration
public void EnsurePageVisible(RadPageViewPage page)
Parameters
RadPageViewPage page

The RadPageViewPage to make visible.

GetNCMetrics()

Declaration
protected override Padding GetNCMetrics()
Returns
System.Windows.Forms.Padding

Overrides

IsInputKey(Keys)

Declaration
protected override bool IsInputKey(Keys keyData)
Parameters
System.Windows.Forms.Keys keyData

Returns
System.Boolean

Overrides

OnGotFocus(EventArgs)

Declaration
protected override void OnGotFocus(EventArgs e)
Parameters
System.EventArgs e

Overrides

OnItemListMenuDisplayed(EventArgs)

Raises the ItemListMenuDisplayed event.

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

An System.EventArgs that contains the event data.

OnItemListMenuDisplaying(RadPageViewMenuDisplayingEventArgs)

Raises the ItemListMenuDisplaying event.

Declaration
protected virtual void OnItemListMenuDisplaying(RadPageViewMenuDisplayingEventArgs e)
Parameters
RadPageViewMenuDisplayingEventArgs e

A RadPageViewMenuDisplayingEventArgs that contains the event data.

OnKeyDown(KeyEventArgs)

Declaration
protected override void OnKeyDown(KeyEventArgs e)
Parameters
System.Windows.Forms.KeyEventArgs e

Overrides

OnLostFocus(EventArgs)

Declaration
protected override void OnLostFocus(EventArgs e)
Parameters
System.EventArgs e

Overrides

OnMouseWheel(MouseEventArgs)

Declaration
protected override void OnMouseWheel(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

Overrides

OnNCPaint(Graphics)

Declaration
protected override void OnNCPaint(Graphics g)
Parameters
System.Drawing.Graphics g

Overrides

OnNewPageRequested(EventArgs)

Raises the NewPageRequested event.

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

An System.EventArgs that contains the event data.

OnPageAdded(RadPageViewEventArgs)

Raises the PageAdded event.

Declaration
protected virtual void OnPageAdded(RadPageViewEventArgs e)
Parameters
RadPageViewEventArgs e

A RadPageViewEventArgs that contains the event data.

OnPageAdding(RadPageViewCancelEventArgs)

Raises the PageAdding event.

Declaration
protected virtual void OnPageAdding(RadPageViewCancelEventArgs e)
Parameters
RadPageViewCancelEventArgs e

A RadPageViewCancelEventArgs that contains the event data.

OnPageCollapsed(RadPageViewEventArgs)

Declaration
protected virtual void OnPageCollapsed(RadPageViewEventArgs e)
Parameters
RadPageViewEventArgs e

OnPageCollapsing(RadPageViewCancelEventArgs)

Declaration
protected virtual void OnPageCollapsing(RadPageViewCancelEventArgs e)
Parameters
RadPageViewCancelEventArgs e

OnPageExpanded(RadPageViewEventArgs)

Raises the PageExpanded event.

Declaration
protected virtual void OnPageExpanded(RadPageViewEventArgs e)
Parameters
RadPageViewEventArgs e

A RadPageViewEventArgs that contains the event data.

OnPageExpanding(RadPageViewCancelEventArgs)

Raises the PageExpanding event.

Declaration
protected virtual void OnPageExpanding(RadPageViewCancelEventArgs e)
Parameters
RadPageViewCancelEventArgs e

A RadPageViewCancelEventArgs that contains the event data.

OnPageIndexChanged(RadPageViewIndexChangedEventArgs)

Raises the PageIndexChanged event.

Declaration
protected virtual void OnPageIndexChanged(RadPageViewIndexChangedEventArgs e)
Parameters
RadPageViewIndexChangedEventArgs e

A RadPageViewIndexChangedEventArgs that contains the event data.

OnPageIndexChanging(RadPageViewIndexChangingEventArgs)

Raises the PageIndexChanging event.

Declaration
protected virtual void OnPageIndexChanging(RadPageViewIndexChangingEventArgs e)
Parameters
RadPageViewIndexChangingEventArgs e

A RadPageViewIndexChangingEventArgs that contains the event data.

OnPageRemoved(RadPageViewEventArgs)

Raises the PageRemoved event.

Declaration
protected virtual void OnPageRemoved(RadPageViewEventArgs e)
Parameters
RadPageViewEventArgs e

A RadPageViewEventArgs that contains the event data.

OnPageRemoving(RadPageViewCancelEventArgs)

Raises the PageRemoving event.

Declaration
protected virtual void OnPageRemoving(RadPageViewCancelEventArgs e)
Parameters
RadPageViewCancelEventArgs e

A RadPageViewCancelEventArgs that contains the event data.

OnPagesCleared(EventArgs)

Raises the PagesCleared event.

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

An System.EventArgs that contains the event data.

OnPagesClearing(CancelEventArgs)

Raises the PagesClearing event.

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

A System.ComponentModel.CancelEventArgs that contains the event data.

OnSelectedPageChanged(EventArgs)

Raises the SelectedPageChanged event.

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

An System.EventArgs that contains the event data.

OnSelectedPageChanging(RadPageViewCancelEventArgs)

Raises the SelectedPageChanging event.

Declaration
protected virtual void OnSelectedPageChanging(RadPageViewCancelEventArgs e)
Parameters
RadPageViewCancelEventArgs e

A RadPageViewCancelEventArgs that contains the event data.

OnViewModeChanged(RadPageViewModeEventArgs)

Raises the ViewModeChanged event.

Declaration
protected virtual void OnViewModeChanged(RadPageViewModeEventArgs e)
Parameters
RadPageViewModeEventArgs e

A RadPageViewModeEventArgs that contains the event data.

OnViewModeChanging(RadPageViewModeChangingEventArgs)

Raises the ViewModeChanging event.

Declaration
protected virtual void OnViewModeChanging(RadPageViewModeChangingEventArgs e)
Parameters
RadPageViewModeChangingEventArgs e

A RadPageViewModeChangingEventArgs that contains the event data.

ProcessCodedUIMessage(ref IPCMessage)

Processes CodedUI messages for automation support.

Declaration
protected override void ProcessCodedUIMessage(ref IPCMessage request)
Parameters
IPCMessage request

The CodedUI message to process.
Overrides

ProcessMnemonic(Char)

Declaration
protected override bool ProcessMnemonic(char charCode)
Parameters
System.Char charCode

Returns
System.Boolean

Overrides

ResumeEvents()

Resumes event raising that was previously suspended by a SuspendEvents() call.

Declaration
public void ResumeEvents()

ScaleControl(SizeF, BoundsSpecified)

Declaration
protected override void ScaleControl(SizeF factor, BoundsSpecified specified)
Parameters
System.Drawing.SizeF factor

System.Windows.Forms.BoundsSpecified specified

Overrides

SetSelectedPage(RadPageViewEventArgs)

Sets the selected page of the control.

Declaration
protected virtual void SetSelectedPage(RadPageViewEventArgs e)
Parameters
RadPageViewEventArgs e

A RadPageViewEventArgs that contains the page to select.

SuspendEvents()

Temporarily suspends event raising for this control.

Declaration
public void SuspendEvents()

UpdateUI()

Updates the user interface based on the current view mode.

Declaration
protected void UpdateUI()

Events

ItemCreating

Occurs when a page item is about to be created, allowing customization of the creation process.

Declaration
public event EventHandler<RadPageViewItemCreatingEventArgs> ItemCreating
Event Type
System.EventHandler<RadPageViewItemCreatingEventArgs>

ItemDropped

Occurs when a page item has been successfully dropped over another item during drag and drop operations.

Declaration
public event EventHandler<RadPageViewItemDroppedEventArgs> ItemDropped
Event Type
System.EventHandler<RadPageViewItemDroppedEventArgs>

ItemDropping

Occurs when a page item is about to be dropped over another item during drag and drop operations.

Declaration
public event EventHandler<RadPageViewItemDroppingEventArgs> ItemDropping
Event Type
System.EventHandler<RadPageViewItemDroppingEventArgs>

ItemListMenuDisplayed

Occurs when the built-in items list menu has been displayed.

Declaration
public event EventHandler ItemListMenuDisplayed
Event Type
System.EventHandler

ItemListMenuDisplaying

Occurs when the built-in items list menu is about to be displayed, allowing the display to be canceled.

Declaration
public event EventHandler<RadPageViewMenuDisplayingEventArgs> ItemListMenuDisplaying
Event Type
System.EventHandler<RadPageViewMenuDisplayingEventArgs>

NewPageRequested

Occurs when a request to create a new page has been made, typically through user interaction.

Declaration
public event EventHandler NewPageRequested
Event Type
System.EventHandler

PageAdded

Occurs when a new page has been successfully added to the page collection.

Declaration
public event EventHandler<RadPageViewEventArgs> PageAdded
Event Type
System.EventHandler<RadPageViewEventArgs>

PageAdding

Occurs when a new page is about to be added to the page collection, allowing the addition to be canceled.

Declaration
public event EventHandler<RadPageViewCancelEventArgs> PageAdding
Event Type
System.EventHandler<RadPageViewCancelEventArgs>

PageCollapsed

Occurs when the content of a RadPageViewPage has been collapsed. This event is only applicable when the view mode is set to ExplorerBar.

Declaration
public virtual event EventHandler<RadPageViewEventArgs> PageCollapsed
Event Type
System.EventHandler<RadPageViewEventArgs>

PageCollapsing

Occurs when the content of a RadPageViewPage is about to collapse. This event is only applicable when the view mode is set to ExplorerBar.

Declaration
public virtual event EventHandler<RadPageViewCancelEventArgs> PageCollapsing
Event Type
System.EventHandler<RadPageViewCancelEventArgs>

PageExpanded

Occurs when the content of a RadPageViewPage has been expanded. This event is only applicable when the view mode is set to ExplorerBar.

Declaration
public virtual event EventHandler<RadPageViewEventArgs> PageExpanded
Event Type
System.EventHandler<RadPageViewEventArgs>

PageExpanding

Occurs when the content of a RadPageViewPage is about to expand. This event is only applicable when the view mode is set to ExplorerBar.

Declaration
public virtual event EventHandler<RadPageViewCancelEventArgs> PageExpanding
Event Type
System.EventHandler<RadPageViewCancelEventArgs>

PageIndexChanged

Occurs when a page's index position has been successfully changed.

Declaration
public event EventHandler<RadPageViewIndexChangedEventArgs> PageIndexChanged
Event Type
System.EventHandler<RadPageViewIndexChangedEventArgs>

PageIndexChanging

Occurs when a page is about to change its index position, allowing the change to be canceled.

Declaration
public event EventHandler<RadPageViewIndexChangingEventArgs> PageIndexChanging
Event Type
System.EventHandler<RadPageViewIndexChangingEventArgs>

PageRemoved

Occurs when a page has been successfully removed from the page collection.

Declaration
public event EventHandler<RadPageViewEventArgs> PageRemoved
Event Type
System.EventHandler<RadPageViewEventArgs>

PageRemoving

Occurs when a page is about to be removed from the page collection, allowing the removal to be canceled.

Declaration
public event EventHandler<RadPageViewCancelEventArgs> PageRemoving
Event Type
System.EventHandler<RadPageViewCancelEventArgs>

PagesCleared

Occurs when all pages have been successfully removed from the page collection.

Declaration
public event EventHandler PagesCleared
Event Type
System.EventHandler

PagesClearing

Occurs when all pages are about to be removed from the page collection, allowing the clearing to be canceled.

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

PeekPopupClosed

Occurs when the peek pop-up window has been closed.

Declaration
public event EventHandler PeekPopupClosed
Event Type
System.EventHandler

PeekPopupOpening

Occurs when the peek pop-up window is about to be opened.

Declaration
public event EventHandler<RadPageViewPeekPopupEventArgs> PeekPopupOpening
Event Type
System.EventHandler<RadPageViewPeekPopupEventArgs>

SelectedPageChanged

Occurs when the currently selected page has changed.

Declaration
public event EventHandler SelectedPageChanged
Event Type
System.EventHandler

SelectedPageChanging

Occurs when the currently selected page is about to change.

Declaration
public event EventHandler<RadPageViewCancelEventArgs> SelectedPageChanging
Event Type
System.EventHandler<RadPageViewCancelEventArgs>

ViewModeChanged

Occurs when the current view mode has been successfully changed.

Declaration
public virtual event EventHandler<RadPageViewModeEventArgs> ViewModeChanged
Event Type
System.EventHandler<RadPageViewModeEventArgs>

ViewModeChanging

Occurs when the current view mode is about to change, allowing the change to be canceled.

Declaration
public virtual event EventHandler<RadPageViewModeChangingEventArgs> ViewModeChanging
Event Type
System.EventHandler<RadPageViewModeChangingEventArgs>

Extension Methods