Class RadPageViewItem
Serves as the base class for all page view items within the RadPageView control, providing common functionality for item representation, interaction, content management, and visual appearance customization.
Inheritance
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll
Syntax
public abstract class RadPageViewItem : RadPageViewElementBase, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider
Constructors
RadPageViewItem()
Declaration
protected RadPageViewItem()
Fields
AutoFlipMarginProperty
ButtonsAlignmentProperty
DescriptionProperty
IsPinnedProperty
IsPreviewProperty
IsSelectedProperty
TitleProperty
Properties
AutoFlipMargin
Gets or sets a value indicating whether the item margin will be automatically flipped according to the orientation of items in the RadPageView control to maintain proper spacing and alignment.
Declaration
public bool AutoFlipMargin { get; set; }
Property Value
|
System.Boolean
|
ButtonsAlignment
Gets or sets the alignment of the item's associated buttons relative to the item content, controlling the positioning of close and pin buttons within the item layout.
Declaration
public PageViewItemButtonsAlignment ButtonsAlignment { get; set; }
Property Value
|
PageViewItemButtonsAlignment
|
ButtonsPanel
Gets the RadPageViewItemButtonsPanel that contains all buttons associated with the item, including close and pin buttons for user interaction.
Declaration
public RadPageViewItemButtonsPanel ButtonsPanel { get; }
Property Value
|
RadPageViewItemButtonsPanel
|
Content
Gets or sets the RadElement instance that represents the content of this item. The content is used when the item is not bound to a RadPageViewPage instance.
Declaration
public RadElement Content { get; set; }
Property Value
|
RadElement
|
CurrentSize
Gets the current size of the item. This may differ from Bounds.Size as it reflects internal changes within the item itself during layout and measurement operations.
Declaration
public SizeF CurrentSize { get; }
Property Value
|
System.Drawing.SizeF
|
Description
Gets or sets the description of the item. The description is displayed in the footer area of the owning view element. If no description is explicitly set, the Text property value is returned.
Declaration
public string Description { get; set; }
Property Value
|
System.String
|
ForcedLayoutSize
Gets the size that is forced by the layout element for this item. This may differ from the DesiredSize when layout constraints or sizing modes override the natural item measurements.
Declaration
public SizeF ForcedLayoutSize { get; }
Property Value
|
System.Drawing.SizeF
|
IsPinned
Gets or sets a value indicating whether the item is pinned. Pinned items appear in front of other items and maintain their position regardless of selection state or other ordering changes.
Declaration
public virtual bool IsPinned { get; set; }
Property Value
|
System.Boolean
|
IsPreview
Gets or sets a value indicating whether the item is opened for preview, allowing temporary content display without fully selecting the item or changing the current selection state.
Declaration
public virtual bool IsPreview { get; set; }
Property Value
|
System.Boolean
|
IsSelected
Gets a value indicating whether this item is currently selected (associated with the SelectedPage of the owning RadPageView). Selection affects visual appearance and content display.
Declaration
public virtual bool IsSelected { get; set; }
Property Value
|
System.Boolean
|
IsSystemItem
Gets or sets a value indicating whether the current instance is internally created by the view element and represents built-in functionality rather than user-created content.
Declaration
public bool IsSystemItem { get; }
Property Value
|
System.Boolean
|
Owner
Gets the RadPageViewElement that owns this item.
Declaration
public virtual RadPageViewElement Owner { get; }
Property Value
|
RadPageViewElement
|
Page
Gets the RadPageViewPage instance associated with this item. This page contains the actual content displayed when the item is selected.
Declaration
public RadPageViewPage Page { get; }
Property Value
|
RadPageViewPage
|
Row
Declaration
public int Row { get; set; }
Property Value
|
System.Int32
|
ShowKeyboardCues
Gets or sets the show keyboard cues.
Declaration
public override bool ShowKeyboardCues { get; set; }
Property Value
|
System.Boolean
The show keyboard cues. |
Overrides
Title
Gets or sets the title of the item. The title is displayed in the header area of the owning view element. If no title is explicitly set, the Text property value is returned.
Declaration
public string Title { get; set; }
Property Value
|
System.String
|
UseMnemonic
Gets or sets the use mnemonic.
Declaration
public override bool UseMnemonic { get; set; }
Property Value
|
System.Boolean
The use mnemonic. |
Overrides
Methods
ArrangeChildren(SizeF)
Declaration
protected override void ArrangeChildren(SizeF available)
Parameters
|
System.Drawing.SizeF
available
|
Overrides
Attach(RadPageViewPage)
Attaches this item to the specified RadPageViewPage, establishing a bidirectional relationship and synchronizing visual properties from the page to the item.
Declaration
public virtual void Attach(RadPageViewPage page)
Parameters
|
RadPageViewPage
page
The page to attach to this item. |
CalculateMeasuredSize(SizeF, SizeF)
Declaration
protected override SizeF CalculateMeasuredSize(SizeF contentSize, SizeF childSize)
Parameters
|
System.Drawing.SizeF
contentSize
|
|
System.Drawing.SizeF
childSize
|
Returns
|
System.Drawing.SizeF
|
Overrides
CreateButtonsPanel()
Creates the buttons panel for this page view item, containing close and pin buttons.
Declaration
protected virtual RadPageViewItemButtonsPanel CreateButtonsPanel()
Returns
|
RadPageViewItemButtonsPanel
A new RadPageViewItemButtonsPanel instance associated with this item. |
CreateChildElements()
Creates child elements including the buttons panel and sets up property bindings for close and pin buttons to synchronize with the item's selected and pinned states.
Declaration
protected override void CreateChildElements()
Overrides
Detach()
Detaches this item from its associated RadPageViewPage, breaking the bidirectional relationship and clearing page references to prepare for disposal or reassignment.
Declaration
public virtual void Detach()
DisposeManagedResources()
Disposes of managed resources by detaching from the associated page and clearing owner references to prevent memory leaks and ensure proper cleanup.
Declaration
protected override void DisposeManagedResources()
Overrides
InitializeFields()
Initializes default field values for the page view item, setting up drag support, sizing constraints, text and image alignment, and keyboard interaction properties.
Declaration
protected override void InitializeFields()
Overrides
MeasureOverride(SizeF)
Declaration
protected override SizeF MeasureOverride(SizeF availableSize)
Parameters
|
System.Drawing.SizeF
availableSize
|
Returns
|
System.Drawing.SizeF
|
Overrides
OnClick(EventArgs)
Declaration
protected override void OnClick(EventArgs e)
Parameters
|
System.EventArgs
e
|
Overrides
OnContentChanging(RadElement)
Declaration
protected virtual bool OnContentChanging(RadElement value)
Parameters
|
RadElement
value
|
Returns
|
System.Boolean
|
OnMouseDown(MouseEventArgs)
Declaration
protected override void OnMouseDown(MouseEventArgs e)
Parameters
|
System.Windows.Forms.MouseEventArgs
e
|
Overrides
OnMouseEnter(EventArgs)
Declaration
protected override void OnMouseEnter(EventArgs e)
Parameters
|
System.EventArgs
e
|
Overrides
OnMouseLeave(EventArgs)
Declaration
protected override void OnMouseLeave(EventArgs e)
Parameters
|
System.EventArgs
e
|
Overrides
OnMouseMove(MouseEventArgs)
Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
|
System.Windows.Forms.MouseEventArgs
e
|
Overrides
OnMouseUp(MouseEventArgs)
Declaration
protected override void OnMouseUp(MouseEventArgs e)
Parameters
|
System.Windows.Forms.MouseEventArgs
e
|
Overrides
OnPropertyChanged(RadPropertyChangedEventArgs)
Declaration
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
|
RadPropertyChangedEventArgs
e
|
Overrides
OnUnloaded(ComponentThemableElementTree)
Declaration
protected override void OnUnloaded(ComponentThemableElementTree oldTree)
Parameters
|
ComponentThemableElementTree
oldTree
|
Overrides
PaintElement(IGraphics, Single, SizeF)
Declaration
protected override void PaintElement(IGraphics graphics, float angle, SizeF scale)
Parameters
|
IGraphics
graphics
|
|
System.Single
angle
|
|
System.Drawing.SizeF
scale
|
Overrides
ProcessMnemonic(Char)
Declaration
public override bool ProcessMnemonic(char charCode)
Parameters
|
System.Char
charCode
|
Returns
|
System.Boolean
|
Overrides
RotateButtonsAlignment(PageViewItemButtonsAlignment)
Declaration
protected virtual PageViewItemButtonsAlignment RotateButtonsAlignment(PageViewItemButtonsAlignment alignment)
Parameters
|
PageViewItemButtonsAlignment
alignment
|
Returns
|
PageViewItemButtonsAlignment
|
RotatePadding(Padding)
Declaration
protected virtual Padding RotatePadding(Padding margin)
Parameters
|
System.Windows.Forms.Padding
margin
|
Returns
|
System.Windows.Forms.Padding
|
RTLTransformButtonsAlignment(PageViewItemButtonsAlignment)
Declaration
protected virtual PageViewItemButtonsAlignment RTLTransformButtonsAlignment(PageViewItemButtonsAlignment alignment)
Parameters
|
PageViewItemButtonsAlignment
alignment
|
Returns
|
PageViewItemButtonsAlignment
|
SetBoundsCore(Rectangle)
Declaration
protected override void SetBoundsCore(Rectangle bounds)
Parameters
|
System.Drawing.Rectangle
bounds
|
Overrides
SetContentCore(RadElement)
SetContentOrientation(PageViewContentOrientation, Boolean)
Declaration
protected override void SetContentOrientation(PageViewContentOrientation orientation, bool recursive)
Parameters
|
PageViewContentOrientation
orientation
|
|
System.Boolean
recursive
|
Overrides
ShouldMeasureChild(RadElement)
Declaration
protected override bool ShouldMeasureChild(RadElement child)
Parameters
|
RadElement
child
|
Returns
|
System.Boolean
|
Overrides
ShouldSerializeProperty(PropertyDescriptor)
Determines whether the specified property should be serialized, with special handling for the AutoEllipsis property to serialize only when it differs from the default value.
Declaration
public override bool? ShouldSerializeProperty(PropertyDescriptor property)
Parameters
|
System.ComponentModel.PropertyDescriptor
property
The property descriptor to check for serialization. |
Returns
|
System.Nullable<System.Boolean>
True if the property should be serialized; false if it should not; null for default behavior. |
Overrides
ToString()
Returns a string representation of this page view item including the type name and text content.
Declaration
public override string ToString()
Returns
|
System.String
A string containing the type name and text of the item. |