Class

RadPageView

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

Declaration

public RadPageView()

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

Declaration

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

Property Value

Overrides RadControl.AllowShowFocusCues

Declaration

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

Property Value

Overrides ScrollableControl.AutoScroll

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

Declaration

protected override bool CanRaiseEvents { get; }

Property Value

Overrides Control.CanRaiseEvents

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

[Browsable(true)]
public RadPageViewPage DefaultPage { get; set; }

Property Value

Gets the default size for the control.

Declaration

protected override Size DefaultSize { get; }

Property Value

Overrides Control.DefaultSize

Gets the display rectangle for the control content area.

Declaration

public override Rectangle DisplayRectangle { get; }

Property Value

Overrides ScrollableControl.DisplayRectangle

Declaration

protected override bool EnableNCModification { get; }

Property Value

Overrides RadNCEnabledControl.EnableNCModification

Declaration

protected override bool EnableNCPainting { get; }

Property Value

Overrides RadNCEnabledControl.EnableNCPainting

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

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

Declaration

[Browsable(true)]
public Size ItemSize { get; set; }

Property Value

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

Declaration

[Browsable(true)]
public PageViewItemSizeMode ItemSizeMode { get; set; }

Property Value

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

Declaration

public Color PageBackColor { get; set; }

Property Value

Gets the collection of pages contained within this view.

Declaration

public RadPageViewPageCollection Pages { get; }

Property Value

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

[Browsable(false)]
public RadCallout PeekPopup { get; }

Property Value

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

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

Declaration

[Browsable(false)]
public RadPageViewPage SelectedPage { 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 the ampersand character (&) will be treated as a mnemonic prefix.

Declaration

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

Property Value

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

Declaration

public virtual RadPageViewElement ViewElement { get; }

Property Value

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

Declaration

public virtual PageViewMode ViewMode { get; set; }

Property Value

Determines whether an element may be edited via the EditUIElements dialog at design-time.

Declaration

protected override bool CanEditElementAtDesignTime(RadElement element)

Parameters

Returns

Overrides RadControl.CanEditElementAtDesignTime(RadElement)

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

Declaration

protected override void Construct()

Overrides RadControl.Construct()

Creates an accessibility object for this control.

Declaration

protected override AccessibleObject CreateAccessibilityInstance()

Returns

Overrides Control.CreateAccessibilityInstance()

Creates and returns a new controls collection for this control.

Declaration

protected override Control.ControlCollection CreateControlsInstance()

Returns

Overrides Control.CreateControlsInstance()

Creates and returns a new pages collection for this control.

Declaration

protected virtual RadPageViewPageCollection CreatePagesInstance()

Returns

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

Declaration

protected virtual RadPageViewElement CreateUI()

Returns

Resumes layout.

Declaration

public override void EndInit()

Overrides RadControl.EndInit()

Ensures that the specified page is visible within the view.

Declaration

public void EnsurePageVisible(RadPageViewPage page)

Parameters

Declaration

protected override Padding GetNCMetrics()

Returns

Overrides RadNCEnabledControl.GetNCMetrics()

Declaration

protected override bool IsInputKey(Keys keyData)

Parameters

Returns

Overrides RadControl.IsInputKey(Keys)

Declaration

protected override void OnGotFocus(EventArgs e)

Parameters

Overrides RadControl.OnGotFocus(EventArgs)

Raises the ItemListMenuDisplayed event.

Declaration

protected virtual void OnItemListMenuDisplayed(EventArgs e)

Parameters

Raises the ItemListMenuDisplaying event.

Declaration

protected virtual void OnItemListMenuDisplaying(RadPageViewMenuDisplayingEventArgs e)

Parameters

Declaration

protected override void OnKeyDown(KeyEventArgs e)

Parameters

Overrides RadControl.OnKeyDown(KeyEventArgs)

Declaration

protected override void OnLostFocus(EventArgs e)

Parameters

Overrides RadControl.OnLostFocus(EventArgs)

Declaration

protected override void OnMouseWheel(MouseEventArgs e)

Parameters

Overrides RadControl.OnMouseWheel(MouseEventArgs)

Declaration

protected override void OnNCPaint(Graphics g)

Parameters

Overrides RadNCEnabledControl.OnNCPaint(Graphics)

Raises the NewPageRequested event.

Declaration

protected virtual void OnNewPageRequested(EventArgs e)

Parameters

Raises the PageAdded event.

Declaration

protected virtual void OnPageAdded(RadPageViewEventArgs e)

Parameters

Raises the PageAdding event.

Declaration

protected virtual void OnPageAdding(RadPageViewCancelEventArgs e)

Parameters

Declaration

protected virtual void OnPageCollapsed(RadPageViewEventArgs e)

Parameters

Declaration

protected virtual void OnPageCollapsing(RadPageViewCancelEventArgs e)

Parameters

Raises the PageExpanded event.

Declaration

protected virtual void OnPageExpanded(RadPageViewEventArgs e)

Parameters

Raises the PageExpanding event.

Declaration

protected virtual void OnPageExpanding(RadPageViewCancelEventArgs e)

Parameters

Raises the PageIndexChanged event.

Declaration

protected virtual void OnPageIndexChanged(RadPageViewIndexChangedEventArgs e)

Parameters

Raises the PageIndexChanging event.

Declaration

protected virtual void OnPageIndexChanging(RadPageViewIndexChangingEventArgs e)

Parameters

Raises the PageRemoved event.

Declaration

protected virtual void OnPageRemoved(RadPageViewEventArgs e)

Parameters

Raises the PageRemoving event.

Declaration

protected virtual void OnPageRemoving(RadPageViewCancelEventArgs e)

Parameters

Raises the PagesCleared event.

Declaration

protected virtual void OnPagesCleared(EventArgs e)

Parameters

Raises the PagesClearing event.

Declaration

protected virtual void OnPagesClearing(CancelEventArgs e)

Parameters

Raises the SelectedPageChanged event.

Declaration

protected virtual void OnSelectedPageChanged(EventArgs e)

Parameters

Raises the SelectedPageChanging event.

Declaration

protected virtual void OnSelectedPageChanging(RadPageViewCancelEventArgs e)

Parameters

Raises the ViewModeChanged event.

Declaration

protected virtual void OnViewModeChanged(RadPageViewModeEventArgs e)

Parameters

Raises the ViewModeChanging event.

Declaration

protected virtual void OnViewModeChanging(RadPageViewModeChangingEventArgs e)

Parameters

Processes CodedUI messages for automation support.

Declaration

protected override void ProcessCodedUIMessage(ref IPCMessage request)

Parameters

Overrides RadControl.ProcessCodedUIMessage(ref IPCMessage)

Declaration

protected override bool ProcessMnemonic(char charCode)

Parameters

Returns

Overrides RadControl.ProcessMnemonic(char)

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

Declaration

public void ResumeEvents()

Declaration

protected override void ScaleControl(SizeF factor, BoundsSpecified specified)

Parameters

Overrides RadControl.ScaleControl(SizeF, BoundsSpecified)

Sets the selected page of the control.

Declaration

protected virtual void SetSelectedPage(RadPageViewEventArgs e)

Parameters

Temporarily suspends event raising for this control.

Declaration

public void SuspendEvents()

Updates the user interface based on the current view mode.

Declaration

protected void UpdateUI()

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

Declaration

public event EventHandler<RadPageViewItemCreatingEventArgs> ItemCreating

Event Value

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

Declaration

public event EventHandler<RadPageViewItemDroppedEventArgs> ItemDropped

Event Value

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 Value

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

Declaration

public event EventHandler ItemListMenuDisplayed

Event Value

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 Value

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

Declaration

public event EventHandler NewPageRequested

Event Value

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

Declaration

public event EventHandler<RadPageViewEventArgs> PageAdded

Event Value

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 Value

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 Value

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 Value

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 Value

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 Value

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

Declaration

public event EventHandler<RadPageViewIndexChangedEventArgs> PageIndexChanged

Event Value

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

Declaration

public event EventHandler<RadPageViewIndexChangingEventArgs> PageIndexChanging

Event Value

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

Declaration

public event EventHandler<RadPageViewEventArgs> PageRemoved

Event Value

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 Value

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

Declaration

public event EventHandler PagesCleared

Event Value

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 Value

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

Declaration

public event EventHandler PeekPopupClosed

Event Value

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

Declaration

public event EventHandler<RadPageViewPeekPopupEventArgs> PeekPopupOpening

Event Value

Occurs when the currently selected page has changed.

Declaration

public event EventHandler SelectedPageChanged

Event Value

Occurs when the currently selected page is about to change.

Declaration

public event EventHandler<RadPageViewCancelEventArgs> SelectedPageChanging

Event Value

Occurs when the current view mode has been successfully changed.

Declaration

public virtual event EventHandler<RadPageViewModeEventArgs> ViewModeChanged

Event Value

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

Declaration

public virtual event EventHandler<RadPageViewModeChangingEventArgs> ViewModeChanging

Event Value