RadPageViewPage
Represents a page in a RadPageView instance.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
public class RadPageViewPage : Panel, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable
Inheritance: objectMarshalByRefObjectComponentControlScrollableControlPanelRadPageViewPage...
Derived Classes:
Implements:
Inherited Members
Constructors
Creates a hidden page with default text and image alignment and an empty child-page collection.
public RadPageViewPage()
Creates a hidden page and initializes its displayed text.
public RadPageViewPage(string text)
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.
public override Color BackColor { get; set; }
Overrides:
Gets or sets the IPC context used to communicate with coded UI clients.
[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.
public string Description { get; set; }
Gets the dock setting; assignments are reset to None because the view controls page layout.
[Browsable(false)]
public override DockStyle Dock { get; set; }
Overrides:
Gets or sets the image to be displayed by the associated RadPageViewItem instance.
public Image Image { get; set; }
Gets or sets the alignment of the image on the drawing surface.
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.
[Browsable(false)]
public bool IsContentVisible { get; set; }
Gets the RadPageViewItem instance which is the UI representation of this page.
[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.
[Browsable(true)]
public virtual SizeF ItemSize { get; set; }
Gets the RadPageView instance that owns this page.
[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.
public int PageLength { get; set; }
Gets or sets the associated peek content for this page.
[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.
[Browsable(false)]
public RadPageViewSubPageCollection SubPages { get; }
Gets or sets the Svg Image.
public RadSvgImage SvgImage { get; set; }
Gets or sets the text to be displayed in the associated item.
[Browsable(true)]
public override string Text { get; set; }
Overrides:
Gets or sets the alignment of the text content on the drawing surface.
public ContentAlignment TextAlignment { get; set; }
Gets or sets the position of text and image relative to each other.
public TextImageRelation TextImageRelation { get; set; }
Gets or sets the title of the Page. Title appears in the Header area of the owning RadPageView.
public string Title { get; set; }
Gets or sets the tooltip to be displayed when the item hovers page's associated item.
public string ToolTipText { get; set; }
Methods
Associates this page with a view and refreshes its inherited background color.
protected virtual void Attach(RadPageView view)
The view that owns this page.
Raises the page's background-color change notification after its inherited color source changes.
protected virtual void CallBackColorChanged()
Creates the collection used to hold this page's child pages in hierarchical views.
protected virtual RadPageViewSubPageCollection CreateChildPagesInstance()
Clears the association between this page and its owning view.
protected virtual void Detach()
Subscribes the added child control to focus handling used for ExplorerBar auto-scrolling.
protected override void OnControlAdded(ControlEventArgs e)
The event data for the added child control.
Overrides:
Removes the focus handler from a child control before it leaves this page.
protected override void OnControlRemoved(ControlEventArgs e)
The event data for the removed child control.
Overrides:
Updates the associated page item's description when the page description changes.
Synchronizes the associated page item's enabled state with this page.
protected override void OnEnabledChanged(EventArgs e)
The event data.
Overrides:
Provides a derived-page hook after the image alignment changes.
Provides a derived-page hook after the raster image changes.
Synchronizes the page item's content-visibility state when the page's visibility setting changes.
protected virtual void OnIsContentVisibleChanged()
Raises the page's background-color change notification when the owning view's page color changes.
Provides a derived-page hook after the SVG image changes.
Provides a derived-page hook after the text alignment changes.
Keeps the associated page item's text synchronized with this page's Text.
protected override void OnTextChanged(EventArgs e)
The event data.
Overrides:
Provides a derived-page hook after the text-to-image relation changes.
protected virtual void OnTextImageRelationChanged(EventArgs e)
The event data.
Updates the associated item's title and refreshes the selected NavigationView header.
Updates the associated page item's tooltip when ToolTipText changes.
Reads or writes the requested public page property for coded UI IPC messages.
protected virtual void ProcessCodedUIMessage(ref IPCMessage request)
The coded UI request and its property payload.
Routes an IPC message through the coded UI property handler.
public void ProcessMessage(ref IPCMessage request)
The message to process.
Resets the specified value sources for a visual property and updates the associated item's style.
public void ResetValue(RadProperty property, ValueResetFlags flags)
The visual property to reset.
flagsValueResetFlagsThe value sources to reset.
Resets all value sources for a visual property and updates the associated item's style.
public void ResetValue(RadProperty property)
The visual property to reset.
Sets a local style value on the placeholder used to transfer visual properties to the associated item.
public void SetValue(RadProperty property, object value)
The visual property to set.
valueobjectThe value assigned to the property.
Returns a string containing this page's displayed text.
Copies locally assigned image and text-layout properties to the associated item and clears unset overrides.
public void UpdateItemStyle()
Processes coded UI IPC requests before forwarding other window messages to the base control.
protected override void WndProc(ref Message m)
The Windows message being processed.
Overrides: