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.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
[TelerikToolboxCategory("Containers")]
public class RadPageView : RadNCEnabledControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IAnalyticsProviderInheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlRadNonClientUIControlRadNCEnabledControlRadPageView...
Derived Classes:
Implements:
Inherited Members
Constructors
Initializes a new instance of the RadPageView class with default settings.
public RadPageView()Properties
Gets or sets a value indicating whether focus cues are displayed based on the control type and current UI state.
[Browsable(true)]
public override bool AllowShowFocusCues { get; set; }Overrides:
[Browsable(false)]
public override bool AutoScroll { get; set; }Overrides:
Gets a value indicating whether event raising is currently enabled for this control.
protected override bool CanRaiseEvents { get; }Overrides:
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.
[Browsable(true)]
public RadPageViewPage DefaultPage { get; set; }Gets the default size for the control.
protected override Size DefaultSize { get; }Overrides:
Gets the display rectangle for the control content area.
public override Rectangle DisplayRectangle { get; }Overrides:
protected override bool EnableNCModification { get; }Overrides:
protected override bool EnableNCPainting { get; }Overrides:
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.
public virtual bool EnablePeekPopup { get; set; }Gets or sets the size of the page view items when ItemSizeMode is set to EqualSize.
[Browsable(true)]
public Size ItemSize { get; set; }Gets or sets how page view items will be sized within a RadPageViewElement instance.
[Browsable(true)]
public PageViewItemSizeMode ItemSizeMode { get; set; }Gets or sets the background color that will be applied to all pages in the control.
public Color PageBackColor { get; set; }Gets the collection of pages contained within this view.
public RadPageViewPageCollection Pages { get; }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.
[Browsable(false)]
public RadCallout PeekPopup { get; }Gets or sets the time interval in milliseconds required to show a PeekPopup after a RadPageViewItem is hovered.
public int PeekPopupInterval { get; set; }Gets or sets the RadPageViewPage instance that is currently selected within the view.
[Browsable(false)]
public RadPageViewPage SelectedPage { get; set; }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.
[Browsable(true)]
public bool SelectionWrap { get; set; }Gets or sets a value indicating whether the ampersand character (&) will be treated as a mnemonic prefix.
[Browsable(true)]
public bool UseMnemonic { get; set; }Gets the current RadPageViewElement instance that represents the UI of the view.
public virtual RadPageViewElement ViewElement { get; }Gets or sets the current display mode of the page view control.
public virtual PageViewMode ViewMode { get; set; }Methods
Determines whether an element may be edited via the EditUIElements dialog at design-time.
protected override bool CanEditElementAtDesignTime(RadElement element)Overrides:
Constructs the internal components of the RadPageView control including the page collection and view mode setup.
protected override void Construct()Overrides:
Creates an accessibility object for this control.
protected override AccessibleObject CreateAccessibilityInstance()A new accessibility object for this control.
Overrides:
Creates and returns a new controls collection for this control.
protected override Control.ControlCollection CreateControlsInstance()A new RadPageViewControlCollection instance.
Overrides:
Creates and returns a new pages collection for this control.
protected virtual RadPageViewPageCollection CreatePagesInstance()A new RadPageViewPageCollection instance.
Creates the appropriate RadPageViewElement instance based on the current view mode.
Resumes layout.
public override void EndInit()Overrides:
Ensures that the specified page is visible within the view.
public void EnsurePageVisible(RadPageViewPage page)The RadPageViewPage to make visible.
Raises the ItemListMenuDisplayed event.
Raises the ItemListMenuDisplaying event.
protected virtual void OnItemListMenuDisplaying(RadPageViewMenuDisplayingEventArgs e)A RadPageViewMenuDisplayingEventArgs that contains the event data.
Raises the NewPageRequested event.
Raises the PageAdded event.
protected virtual void OnPageAdded(RadPageViewEventArgs e)A RadPageViewEventArgs that contains the event data.
Raises the PageAdding event.
protected virtual void OnPageAdding(RadPageViewCancelEventArgs e)A RadPageViewCancelEventArgs that contains the event data.
protected virtual void OnPageCollapsing(RadPageViewCancelEventArgs e)Raises the PageExpanded event.
protected virtual void OnPageExpanded(RadPageViewEventArgs e)A RadPageViewEventArgs that contains the event data.
Raises the PageExpanding event.
protected virtual void OnPageExpanding(RadPageViewCancelEventArgs e)A RadPageViewCancelEventArgs that contains the event data.
Raises the PageIndexChanged event.
protected virtual void OnPageIndexChanged(RadPageViewIndexChangedEventArgs e)A RadPageViewIndexChangedEventArgs that contains the event data.
Raises the PageIndexChanging event.
protected virtual void OnPageIndexChanging(RadPageViewIndexChangingEventArgs e)A RadPageViewIndexChangingEventArgs that contains the event data.
Raises the PageRemoved event.
protected virtual void OnPageRemoved(RadPageViewEventArgs e)A RadPageViewEventArgs that contains the event data.
Raises the PageRemoving event.
protected virtual void OnPageRemoving(RadPageViewCancelEventArgs e)A RadPageViewCancelEventArgs that contains the event data.
Raises the PagesCleared event.
Raises the PagesClearing event.
protected virtual void OnPagesClearing(CancelEventArgs e)A CancelEventArgs that contains the event data.
Raises the SelectedPageChanged event.
Raises the SelectedPageChanging event.
protected virtual void OnSelectedPageChanging(RadPageViewCancelEventArgs e)A RadPageViewCancelEventArgs that contains the event data.
Raises the ViewModeChanged event.
protected virtual void OnViewModeChanged(RadPageViewModeEventArgs e)A RadPageViewModeEventArgs that contains the event data.
Raises the ViewModeChanging event.
protected virtual void OnViewModeChanging(RadPageViewModeChangingEventArgs e)A RadPageViewModeChangingEventArgs that contains the event data.
Processes CodedUI messages for automation support.
protected override void ProcessCodedUIMessage(ref IPCMessage request)The CodedUI message to process.
Overrides:
Resumes event raising that was previously suspended by a SuspendEvents() call.
public void ResumeEvents()protected override void ScaleControl(SizeF factor, BoundsSpecified specified)Overrides:
Sets the selected page of the control.
protected virtual void SetSelectedPage(RadPageViewEventArgs e)A RadPageViewEventArgs that contains the page to select.
Temporarily suspends event raising for this control.
public void SuspendEvents()Updates the user interface based on the current view mode.
protected void UpdateUI()Events
Occurs when a page item is about to be created, allowing customization of the creation process.
public event EventHandler<RadPageViewItemCreatingEventArgs> ItemCreatingOccurs when a page item has been successfully dropped over another item during drag and drop operations.
public event EventHandler<RadPageViewItemDroppedEventArgs> ItemDroppedOccurs when a page item is about to be dropped over another item during drag and drop operations.
public event EventHandler<RadPageViewItemDroppingEventArgs> ItemDroppingOccurs when the built-in items list menu has been displayed.
public event EventHandler ItemListMenuDisplayedOccurs when the built-in items list menu is about to be displayed, allowing the display to be canceled.
public event EventHandler<RadPageViewMenuDisplayingEventArgs> ItemListMenuDisplayingOccurs when a request to create a new page has been made, typically through user interaction.
public event EventHandler NewPageRequestedOccurs when a new page has been successfully added to the page collection.
public event EventHandler<RadPageViewEventArgs> PageAddedOccurs when a new page is about to be added to the page collection, allowing the addition to be canceled.
public event EventHandler<RadPageViewCancelEventArgs> PageAddingOccurs when the content of a RadPageViewPage has been collapsed. This event is only applicable when the view mode is set to ExplorerBar.
public virtual event EventHandler<RadPageViewEventArgs> PageCollapsedOccurs when the content of a RadPageViewPage is about to collapse. This event is only applicable when the view mode is set to ExplorerBar.
public virtual event EventHandler<RadPageViewCancelEventArgs> PageCollapsingOccurs when the content of a RadPageViewPage has been expanded. This event is only applicable when the view mode is set to ExplorerBar.
public virtual event EventHandler<RadPageViewEventArgs> PageExpandedOccurs when the content of a RadPageViewPage is about to expand. This event is only applicable when the view mode is set to ExplorerBar.
public virtual event EventHandler<RadPageViewCancelEventArgs> PageExpandingOccurs when a page's index position has been successfully changed.
public event EventHandler<RadPageViewIndexChangedEventArgs> PageIndexChangedOccurs when a page is about to change its index position, allowing the change to be canceled.
public event EventHandler<RadPageViewIndexChangingEventArgs> PageIndexChangingOccurs when a page has been successfully removed from the page collection.
public event EventHandler<RadPageViewEventArgs> PageRemovedOccurs when a page is about to be removed from the page collection, allowing the removal to be canceled.
public event EventHandler<RadPageViewCancelEventArgs> PageRemovingOccurs when all pages have been successfully removed from the page collection.
public event EventHandler PagesClearedOccurs when all pages are about to be removed from the page collection, allowing the clearing to be canceled.
public event CancelEventHandler PagesClearingOccurs when the peek pop-up window has been closed.
public event EventHandler PeekPopupClosedOccurs when the peek pop-up window is about to be opened.
public event EventHandler<RadPageViewPeekPopupEventArgs> PeekPopupOpeningOccurs when the currently selected page has changed.
public event EventHandler SelectedPageChangedOccurs when the currently selected page is about to change.
public event EventHandler<RadPageViewCancelEventArgs> SelectedPageChangingOccurs when the current view mode has been successfully changed.
public virtual event EventHandler<RadPageViewModeEventArgs> ViewModeChangedOccurs when the current view mode is about to change, allowing the change to be canceled.
public virtual event EventHandler<RadPageViewModeChangingEventArgs> ViewModeChanging