New to Telerik UI for WinForms? Start a free 30-day trial

Represents a page in a RadPageView instance.

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.UI.dll

Syntax:

C#
public class RadPageViewPage : Panel, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable

Inheritance: objectMarshalByRefObjectComponentControlScrollableControlPanelRadPageViewPage...

Derived Classes: RadPageViewItemPage

Implements: IBindableComponentIComponentIDisposableIDropTargetISynchronizeInvokeIWin32Window...

Inherited Members Panel.OnResize(EventArgs)Panel.AutoSizePanel.AutoSizeModePanel.BorderStylePanel.CreateParamsPanel.DefaultSizePanel.TabStopPanel.AutoSizeChanged...

Constructors

Creates a hidden page with default text and image alignment and an empty child-page collection.

C#
public RadPageViewPage()

Creates a hidden page and initializes its displayed text.

C#
public RadPageViewPage(string text)
Parameters:textstring

The text displayed by the page's associated item.

Properties

Gets the local background color, or falls back to the owning view's page or loaded content-area color.

C#
public override Color BackColor { get; set; }

Overrides: Control.BackColor

Gets or sets the IPC context used to communicate with coded UI clients.

C#
[Browsable(false)]
public IntPtr Context { get; set; }

Gets or sets the title of the Page. Title appears in the Header area of the owning RadPageView.

C#
public string Description { get; set; }

Gets the dock setting; assignments are reset to None because the view controls page layout.

C#
[Browsable(false)]
public override DockStyle Dock { get; set; }

Overrides: Control.Dock

Gets or sets the image to be displayed by the associated RadPageViewItem instance.

C#
public Image Image { get; set; }

Gets or sets the alignment of the image on the drawing surface.

C#
public ContentAlignment ImageAlignment { get; set; }

Gets or sets a boolean value determining whether the content of the current RadPageViewPage is visible. This property is only functional in the when the RadPageView control is in ExplorerBar view mode.

C#
[Browsable(false)]
public bool IsContentVisible { get; set; }

Gets the RadPageViewItem instance which is the UI representation of this page.

C#
[Browsable(false)]
public RadPageViewItem Item { get; }

Gets or sets the size of the item of RadPageView.This size will be used in is PageViewItemSizeMode.Individual mode.

C#
[Browsable(true)]
public virtual SizeF ItemSize { get; set; }

Gets the RadPageView instance that owns this page.

C#
[Browsable(false)]
public RadPageView Owner { get; }

Gets or sets the length of the current RadPageViewPage. The length represents the fixed amount of space the page will take when the layout of the control is performed. Note: This property is only functional when the RadPageView control is in ExplorerBar mode and its content size mode is set to FixedLength.

C#
public int PageLength { get; set; }

Gets or sets the associated peek content for this page.

C#
[Browsable(false)]
public Control PeekPopupContent { get; set; }

Gets the child collection of pages for this page. This collection is only relevant for the NavigationView which supports hierarchy.

C#
[Browsable(false)]
public RadPageViewSubPageCollection SubPages { get; }

Gets or sets the Svg Image.

C#
public RadSvgImage SvgImage { get; set; }

Gets or sets the text to be displayed in the associated item.

C#
[Browsable(true)]
public override string Text { get; set; }

Overrides: Panel.Text

Gets or sets the alignment of the text content on the drawing surface.

C#
public ContentAlignment TextAlignment { get; set; }

Gets or sets the position of text and image relative to each other.

C#
public TextImageRelation TextImageRelation { get; set; }

Gets or sets the title of the Page. Title appears in the Header area of the owning RadPageView.

C#
public string Title { get; set; }

Gets or sets the tooltip to be displayed when the item hovers page's associated item.

C#
public string ToolTipText { get; set; }

Methods

Associates this page with a view and refreshes its inherited background color.

C#
protected virtual void Attach(RadPageView view)
Parameters:viewRadPageView

The view that owns this page.

Raises the page's background-color change notification after its inherited color source changes.

C#
protected virtual void CallBackColorChanged()

Creates the collection used to hold this page's child pages in hierarchical views.

C#
protected virtual RadPageViewSubPageCollection CreateChildPagesInstance()
Returns:

RadPageViewSubPageCollection

Clears the association between this page and its owning view.

C#
protected virtual void Detach()

Detaches the page and releases its peek content and associated page item.

C#
protected override void Dispose(bool disposing)
Parameters:disposingbool

true to release managed resources.

Overrides: Control.Dispose(bool)

Subscribes the added child control to focus handling used for ExplorerBar auto-scrolling.

C#
protected override void OnControlAdded(ControlEventArgs e)
Parameters:eControlEventArgs

The event data for the added child control.

Overrides: Control.OnControlAdded(ControlEventArgs)

Removes the focus handler from a child control before it leaves this page.

C#
protected override void OnControlRemoved(ControlEventArgs e)
Parameters:eControlEventArgs

The event data for the removed child control.

Overrides: Control.OnControlRemoved(ControlEventArgs)

Updates the associated page item's description when the page description changes.

C#
protected virtual void OnDescriptionChanged(EventArgs e)
Parameters:eEventArgs

The event data.

Synchronizes the associated page item's enabled state with this page.

C#
protected override void OnEnabledChanged(EventArgs e)
Parameters:eEventArgs

The event data.

Overrides: Control.OnEnabledChanged(EventArgs)

Provides a derived-page hook after the image alignment changes.

C#
protected virtual void OnImageAlignmentChanged(EventArgs e)
Parameters:eEventArgs

The event data.

Provides a derived-page hook after the raster image changes.

C#
protected virtual void OnImageChanged(EventArgs e)
Parameters:eEventArgs

The event data.

Synchronizes the page item's content-visibility state when the page's visibility setting changes.

C#
protected virtual void OnIsContentVisibleChanged()

Raises the page's background-color change notification when the owning view's page color changes.

C#
protected virtual void OnPageBackColorChanged(EventArgs e)
Parameters:eEventArgs

The event data.

Provides a derived-page hook after the SVG image changes.

C#
protected virtual void OnSvgImageChanged(EventArgs e)
Parameters:eEventArgs

The event data.

Provides a derived-page hook after the text alignment changes.

C#
protected virtual void OnTextAlignmentChanged(EventArgs e)
Parameters:eEventArgs

The event data.

Keeps the associated page item's text synchronized with this page's Text.

C#
protected override void OnTextChanged(EventArgs e)
Parameters:eEventArgs

The event data.

Overrides: Control.OnTextChanged(EventArgs)

Provides a derived-page hook after the text-to-image relation changes.

C#
protected virtual void OnTextImageRelationChanged(EventArgs e)
Parameters:eEventArgs

The event data.

Updates the associated item's title and refreshes the selected NavigationView header.

C#
protected virtual void OnTitleChanged(EventArgs e)
Parameters:eEventArgs

The event data.

Updates the associated page item's tooltip when ToolTipText changes.

C#
protected virtual void OnToolTipTextChanged(EventArgs e)
Parameters:eEventArgs

The event data.

Reads or writes the requested public page property for coded UI IPC messages.

C#
protected virtual void ProcessCodedUIMessage(ref IPCMessage request)
Parameters:requestIPCMessage

The coded UI request and its property payload.

Routes an IPC message through the coded UI property handler.

C#
public void ProcessMessage(ref IPCMessage request)
Parameters:requestIPCMessage

The message to process.

Resets the specified value sources for a visual property and updates the associated item's style.

C#
public void ResetValue(RadProperty property, ValueResetFlags flags)
Parameters:propertyRadProperty

The visual property to reset.

flagsValueResetFlags

The value sources to reset.

Resets all value sources for a visual property and updates the associated item's style.

C#
public void ResetValue(RadProperty property)
Parameters:propertyRadProperty

The visual property to reset.

Sets a local style value on the placeholder used to transfer visual properties to the associated item.

C#
public void SetValue(RadProperty property, object value)
Parameters:propertyRadProperty

The visual property to set.

valueobject

The value assigned to the property.

Returns a string containing this page's displayed text.

C#
public override string ToString()
Returns:

string

Overrides: Panel.ToString()

Copies locally assigned image and text-layout properties to the associated item and clears unset overrides.

C#
public void UpdateItemStyle()

Processes coded UI IPC requests before forwarding other window messages to the base control.

C#
protected override void WndProc(ref Message m)
Parameters:mMessage

The Windows message being processed.

Overrides: ScrollableControl.WndProc(ref Message)