Class RadPageView

Represents a control that has a collection of pages and displays one page at a time.

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()

Declaration
public RadPageView()

Properties

AllowShowFocusCues

Indicates focus cues display, when available, based on the corresponding control type and the 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

Gets or sets whether the edit control is auto-sized

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

Overrides

BackColor

RadPageView consists of multiple visual elements and separate settings are provided to customize their appearance. Current BackColor property might be ignored.

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

Overrides

CanRaiseEvents

Determines whether event raising is currently enabled.

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

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

DisplayRectangle

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 an 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

RadPageView consists of multiple visual elements and separate settings are provided to customize their appearance. Current ForeColor property might be ignored.

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

Overrides

ItemSize

Gets or sets the size of the items when ItemSizeMode of RadPageView is PageViewItemSizeMode.EqualSize.

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

ItemSizeMode

Gets or sets how an item will be sized within a RadPageViewElement instance.

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

PageBackColor

Gets or sets the BackColor of all pages.

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

Pages

Gets the collection of pages for this view.

Declaration
public RadPageViewPageCollection Pages { get; }
Property Value
RadPageViewPageCollection

PeekPopup

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

Declaration
public RadCallout PeekPopup { get; }
Property Value
RadCallout

PeekPopupInterval

Gets or sets the interval needed 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 whether the pages will be wrapped around when performing selection using the arrow keys. If the property is set to true, pressing the right arrow key when the last page is selected will result in selecting the first page.

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

true if [wrapped around]; otherwise, false.

Text

This property is not relevant for this class.

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

Overrides

UseMnemonic

Determines whether ampersand character will be treated as mnemonic or not.

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 mode of the view.

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()

Declaration
protected override void Construct()
Overrides

CreateAccessibilityInstance()

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

CreateControlsInstance()

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

CreatePagesInstance()

Declaration
protected virtual RadPageViewPageCollection CreatePagesInstance()
Returns
RadPageViewPageCollection

CreateUI()

Declaration
protected virtual RadPageViewElement CreateUI()
Returns
RadPageViewElement

EndInit()

Declaration
public override void EndInit()
Overrides

EnsurePageVisible(RadPageViewPage)

Declaration
public void EnsurePageVisible(RadPageViewPage page)
Parameters
RadPageViewPage page

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)

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

OnItemListMenuDisplaying(RadPageViewMenuDisplayingEventArgs)

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

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)

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

OnPageAdded(RadPageViewEventArgs)

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

OnPageAdding(RadPageViewCancelEventArgs)

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

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)

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

OnPageExpanding(RadPageViewCancelEventArgs)

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

OnPageIndexChanged(RadPageViewIndexChangedEventArgs)

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

OnPageIndexChanging(RadPageViewIndexChangingEventArgs)

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

OnPageRemoved(RadPageViewEventArgs)

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

OnPageRemoving(RadPageViewCancelEventArgs)

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

OnPagesCleared(EventArgs)

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

OnPagesClearing(CancelEventArgs)

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

OnSelectedPageChanged(EventArgs)

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

OnSelectedPageChanging(RadPageViewCancelEventArgs)

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

OnViewModeChanged(RadPageViewModeEventArgs)

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

OnViewModeChanging(RadPageViewModeChangingEventArgs)

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

ProcessCodedUIMessage(ref IPCMessage)

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

Overrides

ProcessMnemonic(Char)

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

Returns
System.Boolean

Overrides

ResumeEvents()

Resumes event raising, 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)

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

SuspendEvents()

Temporary suspends event raising.

Declaration
public void SuspendEvents()

UpdateUI()

Declaration
protected void UpdateUI()

Events

ItemCreating

Raised when page item is about to be created.

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

ItemDropped

Occurs when an item was dropped over another item.

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

ItemDropping

Occurs when an item is about to be dropped over another item.

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

ItemListMenuDisplayed

Raised when the built-in ItemsList menu is displayed.

Declaration
public event EventHandler ItemListMenuDisplayed
Event Type
System.EventHandler

ItemListMenuDisplaying

Raised when the built-in ItemsList menu is about to be displayed. Cancelable.

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

NewPageRequested

Raised when the current mode of the view is about to change. Cancelable.

Declaration
public event EventHandler NewPageRequested
Event Type
System.EventHandler

PageAdded

Raised when a new page has been successfully added to the view.

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

PageAdding

Raised when a new page is about to be added to the view. Cancelable.

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

PageCollapsed

Raised when the content of a RadPageViewPage is collapsed. This event is only raised when the view mode of the control is set to ExplorerBar.

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

PageCollapsing

Raised when the content of a RadPageViewPage is collapsing. This event is only raised when the view mode of the control is set to ExplorerBar.

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

PageExpanded

Raised when the content of a RadPageViewPage is expanded. This event is only raised when the view mode of the control is set to ExplorerBar.

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

PageExpanding

Raised when the content of a RadPageViewPage is expanding. This event is only raised when the view mode of the control is set to ExplorerBar.

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

PageIndexChanged

Raised when a page's index has been successfully changed.

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

PageIndexChanging

Raised when a page is about to change its index. Cancelable.

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

PageRemoved

Raised when a page has been successfully removed from the view.

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

PageRemoving

Raised when a page is about to be removed from the view. Cancelable.

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

PagesCleared

Raised when all pages have been successfully removed from the view.

Declaration
public event EventHandler PagesCleared
Event Type
System.EventHandler

PagesClearing

Raised when all pages are about to be removed from the view. Cancelable.

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

PeekPopupClosed

Raised when the peek pop-up has been closed.

Declaration
public event EventHandler PeekPopupClosed
Event Type
System.EventHandler

PeekPopupOpening

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

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

SelectedPageChanged

Raised when currently selected page has changed.

Declaration
public event EventHandler SelectedPageChanged
Event Type
System.EventHandler

SelectedPageChanging

Raised when currently selected page has changed.

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

ViewModeChanged

Raised when the current mode of the view has changed.

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

ViewModeChanging

Raised when the current mode of the view is about to change. Cancelable.

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

Extension Methods