Class RadPageViewElement
Encapsulates the UI representation of a RadPageView instance. Different views will be described by different instances of this class.
Inheritance
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll
Syntax
public abstract class RadPageViewElement : RadPageViewElementBase, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IImageElement, ITextPrimitive, ITextProvider
Constructors
RadPageViewElement()
Declaration
public RadPageViewElement()
Fields
EnsureSelectedItemVisibleProperty
ItemBorderAndFillOrientationProperty
ItemContentOrientationProperty
ItemDragHintProperty
ItemDragModeProperty
ItemSizeModeProperty
ItemSpacingProperty
ShowItemCloseButtonProperty
Properties
ActionMouseButton
Gets or sets the mouse button that will be used to select items. Equals to MouseButtons.Left by default.
Declaration
public MouseButtons ActionMouseButton { get; set; }
Property Value
System.
|
ActiveEditor
Gets or sets the active editor.
Declaration
public IInputEditor ActiveEditor { get; }
Property Value
IInput The active editor. |
AllowEdit
Gets or sets a value indicating whether [allow edit].
Declaration
public bool AllowEdit { get; set; }
Property Value
System.
|
ContentArea
Gets the element which represents the content area of the tab view.
Declaration
public RadPageViewElementBase ContentArea { get; }
Property Value
DefaultPage
EnableNCModification
Declaration
protected virtual bool EnableNCModification { get; }
Property Value
System.
|
EnableNCPainting
Declaration
protected virtual bool EnableNCPainting { get; }
Property Value
System.
|
EnablePeekPopup
Gets or sets a value indicating whether a peek pop-up can be shown when an item is hovered with the mouse.
The content of the peek pop-up needs to be set in the Peek
Declaration
public virtual bool EnablePeekPopup { get; set; }
Property Value
System.
|
EnsureSelectedItemVisible
Determines whether the currently selected item will be automatically scrolled into view.
Declaration
[RadPropertyDefaultValue("EnsureSelectedItemVisible", typeof(RadPageViewElement))]
public bool EnsureSelectedItemVisible { get; set; }
Property Value
System.
|
Footer
Header
Gets the header element of the view.
Declaration
public virtual RadPageViewLabelElement Header { get; }
Property Value
IsEditing
Gets a value indicating whether there is an open editor in the tree view.
Declaration
public bool IsEditing { get; }
Property Value
System.
|
ItemBorderAndFillOrientation
Defines how each item's border and fill is oriented within this instance.
Declaration
[RadPropertyDefaultValue("ItemBorderAndFillOrientation", typeof(RadPageViewElement))]
public PageViewContentOrientation ItemBorderAndFillOrientation { get; set; }
Property Value
ItemContentOrientation
Gets or sets the text orientation of the item within the owning RadPageViewElement instance.
Declaration
[RadPropertyDefaultValue("ItemContentOrientation", typeof(RadPageViewElement))]
public PageViewContentOrientation ItemContentOrientation { get; set; }
Property Value
ItemDragHint
Gets or sets the Rad
Declaration
[VsbBrowsable(true)]
public RadImageShape ItemDragHint { get; set; }
Property Value
ItemDragMode
Gets or sets the mode that controls item drag operation within the element.
Declaration
public PageViewItemDragMode ItemDragMode { get; set; }
Property Value
ItemDragService
Gets or sets the Rad
Declaration
public RadDragDropService ItemDragService { get; set; }
Property Value
Items
Gets all the items currently present within this element.
Declaration
public IReadOnlyCollection<RadPageViewItem> Items { get; }
Property Value
ItemSize
Declaration
public Size ItemSize { get; set; }
Property Value
System.
|
ItemSizeMode
Gets or sets the text orientation of the item within the owning RadPageViewElement instance.
Declaration
[RadPropertyDefaultValue("ItemSizeMode", typeof(RadPageViewElement))]
public PageViewItemSizeMode ItemSizeMode { get; set; }
Property Value
ItemSpacing
Gets or sets the spacing between two items within the element.
Declaration
[RadPropertyDefaultValue("ItemSpacing", typeof(RadPageViewElement))]
public int ItemSpacing { get; set; }
Property Value
System.
|
ItemsParent
Gets the RadElement instance that parents all the items.
Declaration
protected abstract RadElement ItemsParent { get; }
Property Value
OverflowPagesContextMenu
Gets the RadContextMenu that holds the overflow pages.
Declaration
public RadContextMenu OverflowPagesContextMenu { get; }
Property Value
Owner
Gets the RadPageView instance that owns this element. May be null if element is hosted on another RadControl instance.
Declaration
public RadPageView Owner { get; }
Property Value
PeekPopup
Gets the peek pop-up, which is represented by a Rad
Declaration
public RadCallout PeekPopup { get; }
Property Value
PeekPopupInterval
Gets or sets the interval needed to show a Peek
Declaration
public int PeekPopupInterval { get; set; }
Property Value
System.
|
PeekTimer
Declaration
protected Timer PeekTimer { get; }
Property Value
System.
|
SelectedItem
Gets or sets the currently selected item in the view.
Declaration
public RadPageViewItem SelectedItem { get; set; }
Property Value
SelectionWrap
Gets or sets whether the pages will be wrapped around when performing selection using the arrow keys. If the property is set to true, pressing the right arrow key when the last page is selected will result in selecting the first page.
Declaration
public bool SelectionWrap { get; set; }
Property Value
System.
|
ShowItemCloseButton
Determines CloseButton will be displayed in each item, allowing that item to be closed.
Declaration
[RadPropertyDefaultValue("ShowItemCloseButton", typeof(RadPageViewStripElement))]
public bool ShowItemCloseButton { get; set; }
Property Value
System.
|
UpdateSelectedItemContent
Determines whether selecting an item will update the element's ContentArea.
Declaration
public bool UpdateSelectedItemContent { get; set; }
Property Value
System.
|
Methods
AddItem(RadPageViewItem)
AddItemCore(RadPageViewItem)
Declaration
protected virtual void AddItemCore(RadPageViewItem item)
Parameters
Rad
|
ArrangeContent(RectangleF)
Declaration
protected virtual RectangleF ArrangeContent(RectangleF clientRect)
Parameters
System.
|
Returns
System.
|
ArrangeExternalElements(RectangleF, SizeF)
Declaration
protected void ArrangeExternalElements(RectangleF clientRect, SizeF finalSize)
Parameters
System.
|
System.
|
ArrangeItems(RectangleF)
Arranges the items and returns the available rectangle where the content area should be positioned.
Declaration
protected virtual RectangleF ArrangeItems(RectangleF itemsRect)
Parameters
System.
|
Returns
System.
|
ArrangeOverride(SizeF)
Declaration
protected override SizeF ArrangeOverride(SizeF finalSize)
Parameters
System.
|
Returns
System.
|
Overrides
BeginEdit()
Puts the current node in edit mode.
Declaration
public bool BeginEdit()
Returns
System.
|
CancelEdit()
Close the currently active editor and discard changes.
Declaration
public void CancelEdit()
CanDropOverItem(RadPageViewItem, RadPageViewItem)
Declaration
protected virtual bool CanDropOverItem(RadPageViewItem dragItem, RadPageViewItem hitItem)
Parameters
Rad
|
Rad
|
Returns
System.
|
CanPeekItem(RadPageViewItem)
A method that determines, whether over a Rad
Declaration
protected virtual bool CanPeekItem(RadPageViewItem item)
Parameters
Rad
|
Returns
System.
|
CanSelectItem(RadPageViewItem)
Declaration
protected virtual bool CanSelectItem(RadPageViewItem item)
Parameters
Rad
|
Returns
System.
|
CloseItem(RadPageViewItem)
CreateChildElements()
Declaration
protected override void CreateChildElements()
Overrides
CreateItem()
CreateOverflowPagesContextMenu()
Declaration
protected virtual RadContextMenu CreateOverflowPagesContextMenu()
Returns
DisplayItemListMenu(RadPageViewElementBase)
Displays the item list menu, using the provided element as menu's owner.
Declaration
public void DisplayItemListMenu(RadPageViewElementBase menuOwner)
Parameters
Rad
|
DisplayItemListMenu(RadPageViewElementBase, HorizontalPopupAlignment, VerticalPopupAlignment)
Displays the item list menu, using the provided element as menu's owner and the specified horizontal and vertical alignment.
Declaration
public void DisplayItemListMenu(RadPageViewElementBase menuOwner, HorizontalPopupAlignment hAlign, VerticalPopupAlignment vAlign)
Parameters
Rad
|
Horizontal
|
Vertical
|
DisplayItemListMenu(RadPageViewMenuDisplayingEventArgs)
Declaration
protected virtual void DisplayItemListMenu(RadPageViewMenuDisplayingEventArgs e)
Parameters
DisposeManagedResources()
Declaration
protected override void DisposeManagedResources()
Overrides
EndEdit()
Commits any changes and ends the edit operation on the current cell.
Declaration
public bool EndEdit()
Returns
System.
|
EndEditCore(Boolean)
Declaration
protected virtual bool EndEditCore(bool commitChanges)
Parameters
System.
|
Returns
System.
|
EndItemDrag(RadPageViewItem)
Declaration
protected virtual void EndItemDrag(RadPageViewItem item)
Parameters
Rad
|
EnsureItemVisible(RadPageViewItem)
Declaration
public bool EnsureItemVisible(RadPageViewItem item)
Parameters
Rad
|
Returns
System.
|
EnsureItemVisibleCore(RadPageViewItem)
Declaration
protected virtual bool EnsureItemVisibleCore(RadPageViewItem item)
Parameters
Rad
|
Returns
System.
|
FindItem(RadElement)
Declaration
public RadPageViewItem FindItem(RadElement content)
Parameters
Rad
|
Returns
GetAutomaticItemOrientation(Boolean)
Gets the default (automatic) item orientation, which may depend on some settings in inheritors such as RadPageViewStripElement.
Declaration
protected virtual PageViewContentOrientation GetAutomaticItemOrientation(bool content)
Parameters
System. True to indicate that content orientation is to be retrieved, false to get orientation for border and fill. |
Returns
GetClientRectangleFromContentElement(RadPageViewContentAreaElement)
Declaration
public virtual Rectangle GetClientRectangleFromContentElement(RadPageViewContentAreaElement contentArea)
Parameters
Rad
|
Returns
System.
|
GetContentAreaForItem(RadPageViewItem)
Gets an instance of the Rad
Declaration
public virtual RadPageViewContentAreaElement GetContentAreaForItem(RadPageViewItem item)
Parameters
Rad
|
Returns
GetContentAreaRectangle()
Gets the area, where the currently active page may be displayed.
Declaration
public virtual Rectangle GetContentAreaRectangle()
Returns
System.
|
GetItemAt(Int32)
Declaration
public RadPageViewItem GetItemAt(int index)
Parameters
System.
|
Returns
GetItemsRect()
Gets the rectangle where items reside.
Declaration
public virtual RectangleF GetItemsRect()
Returns
System.
|
GetNCMetrics()
Declaration
protected virtual Padding GetNCMetrics()
Returns
System.
|
GetPeekPopupArrowDirection()
InitializeFields()
Declaration
protected override void InitializeFields()
Overrides
InsertItem(Int32, RadPageViewItem)
Declaration
public void InsertItem(int index, RadPageViewItem item)
Parameters
System.
|
Rad
|
InsertItemCore(Int32, RadPageViewItem)
Declaration
protected virtual void InsertItemCore(int index, RadPageViewItem item)
Parameters
System.
|
Rad
|
IsChildElementExternal(RadElement)
Declaration
protected virtual bool IsChildElementExternal(RadElement element)
Parameters
Rad
|
Returns
System.
|
IsNextKey(Keys)
Declaration
protected virtual bool IsNextKey(Keys key)
Parameters
System.
|
Returns
System.
|
IsPreviousKey(Keys)
Declaration
protected virtual bool IsPreviousKey(Keys key)
Parameters
System.
|
Returns
System.
|
ItemFromPoint(Point)
Gets the item that contains the provided point (in control's client coordinates).
Declaration
public RadPageViewItem ItemFromPoint(Point client)
Parameters
System.
|
Returns
MeasureExternalElements(SizeF, SizeF)
Declaration
protected void MeasureExternalElements(SizeF clientSize, SizeF availableSize)
Parameters
System.
|
System.
|
MeasureItems(SizeF)
Declaration
protected virtual SizeF MeasureItems(SizeF availableSize)
Parameters
System.
|
Returns
System.
|
MeasureOverride(SizeF)
Declaration
protected override SizeF MeasureOverride(SizeF availableSize)
Parameters
System.
|
Returns
System.
|
Overrides
OnContentBoundsChanged()
Declaration
protected virtual void OnContentBoundsChanged()
OnEditorInitialized(Object, RadPageViewEditorEventArgs)
Declaration
protected virtual void OnEditorInitialized(object sender, RadPageViewEditorEventArgs e)
Parameters
System.
|
Rad
|
OnItemClick(RadPageViewItem, EventArgs)
Declaration
protected virtual void OnItemClick(RadPageViewItem sender, EventArgs e)
Parameters
Rad
|
System.
|
OnItemContentChanged(RadPageViewItem)
Declaration
protected virtual void OnItemContentChanged(RadPageViewItem item)
Parameters
Rad
|
OnItemContentChanging(RadPageViewItem, RadElement)
Declaration
protected virtual bool OnItemContentChanging(RadPageViewItem item, RadElement newContent)
Parameters
Rad
|
Rad
|
Returns
System.
|
OnItemCreating(RadPageViewItemCreatingEventArgs)
Declaration
protected virtual RadPageViewItem OnItemCreating(RadPageViewItemCreatingEventArgs args)
Parameters
Returns
OnItemDrag(RadPageViewItem, MouseEventArgs)
Declaration
protected virtual void OnItemDrag(RadPageViewItem sender, MouseEventArgs e)
Parameters
Rad
|
System.
|
OnItemDropped(Object, RadPageViewItemDroppedEventArgs)
Declaration
protected virtual void OnItemDropped(object sender, RadPageViewItemDroppedEventArgs args)
Parameters
System.
|
Rad
|
OnItemDropping(Object, RadPageViewItemDroppingEventArgs)
Declaration
protected virtual void OnItemDropping(object sender, RadPageViewItemDroppingEventArgs args)
Parameters
System.
|
Rad
|
OnItemMouseDown(RadPageViewItem, MouseEventArgs)
Declaration
protected virtual void OnItemMouseDown(RadPageViewItem sender, MouseEventArgs e)
Parameters
Rad
|
System.
|
OnItemMouseEnter(RadPageViewItem)
Declaration
protected virtual void OnItemMouseEnter(RadPageViewItem item)
Parameters
Rad
|
OnItemMouseLeave(RadPageViewItem)
Declaration
protected virtual void OnItemMouseLeave(RadPageViewItem item)
Parameters
Rad
|
OnItemMouseUp(RadPageViewItem, MouseEventArgs)
Declaration
protected virtual void OnItemMouseUp(RadPageViewItem sender, MouseEventArgs e)
Parameters
Rad
|
System.
|
OnItemPropertyChanged(RadPageViewItem, RadPropertyChangedEventArgs)
Declaration
protected virtual void OnItemPropertyChanged(RadPageViewItem item, RadPropertyChangedEventArgs e)
Parameters
OnItemsChanged(Object, RadPageViewItemsChangedEventArgs)
Declaration
protected virtual void OnItemsChanged(object sender, RadPageViewItemsChangedEventArgs args)
Parameters
System.
|
Rad
|
OnItemSelected(Object, RadPageViewItemSelectedEventArgs)
Declaration
public virtual void OnItemSelected(object sender, RadPageViewItemSelectedEventArgs args)
Parameters
System.
|
Rad
|
OnItemSelecting(Object, RadPageViewItemSelectingEventArgs)
Declaration
public virtual void OnItemSelecting(object sender, RadPageViewItemSelectingEventArgs args)
Parameters
System.
|
Rad
|
OnLoaded()
OnNCPaint(Graphics)
Declaration
protected virtual void OnNCPaint(Graphics g)
Parameters
System.
|
OnPageAdded(RadPageViewEventArgs)
Declaration
protected virtual void OnPageAdded(RadPageViewEventArgs e)
Parameters
OnPageIndexChanged(RadPageViewIndexChangedEventArgs)
Declaration
protected virtual void OnPageIndexChanged(RadPageViewIndexChangedEventArgs e)
Parameters
OnPageRemoved(RadPageViewEventArgs)
Declaration
protected virtual void OnPageRemoved(RadPageViewEventArgs e)
Parameters
OnPeekPopupClosed(EventArgs)
Declaration
protected virtual void OnPeekPopupClosed(EventArgs e)
Parameters
System.
|
OnPeekPopupOpening(RadPageViewPeekPopupEventArgs)
OnPropertyChanged(RadPropertyChangedEventArgs)
Declaration
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
Overrides
OnSelectedPageChanged(RadPageViewEventArgs)
Declaration
protected virtual void OnSelectedPageChanged(RadPageViewEventArgs e)
Parameters
PerformArrange(RectangleF)
Declaration
protected virtual RectangleF PerformArrange(RectangleF clientRect)
Parameters
System.
|
Returns
System.
|
PerformItemDrop(RadPageViewItem, RadPageViewItem)
Declaration
protected void PerformItemDrop(RadPageViewItem dragItem, RadPageViewItem hitItem)
Parameters
Rad
|
Rad
|
ProcessDragDrop(Point, ISupportDrag)
Declaration
protected override void ProcessDragDrop(Point dropLocation, ISupportDrag dragObject)
Parameters
System.
|
ISupport
|
Overrides
ProcessDragOver(Point, ISupportDrag)
Declaration
protected override bool ProcessDragOver(Point mousePosition, ISupportDrag dragObject)
Parameters
System.
|
ISupport
|
Returns
System.
|
Overrides
ProcessKeyDown(KeyEventArgs)
Declaration
protected virtual void ProcessKeyDown(KeyEventArgs e)
Parameters
System.
|
RemoveItem(RadPageViewItem)
RemoveItemCore(RadPageViewItem)
Declaration
protected virtual void RemoveItemCore(RadPageViewItem item)
Parameters
Rad
|
SelectNextItem()
Declaration
public bool SelectNextItem()
Returns
System.
|
SelectNextItemCore(RadPageViewItem, Boolean, Boolean)
Declaration
protected virtual bool SelectNextItemCore(RadPageViewItem current, bool forward, bool wrap)
Parameters
Rad
|
System.
|
System.
|
Returns
System.
|
SelectPreviousItem()
Declaration
public bool SelectPreviousItem()
Returns
System.
|
SetItemIndex(Int32, Int32)
Declaration
protected virtual void SetItemIndex(int currentIndex, int newIndex)
Parameters
System.
|
System.
|
SetSelectedContent(RadPageViewItem)
Declaration
protected virtual void SetSelectedContent(RadPageViewItem item)
Parameters
Rad
|
SetSelectedItem(RadPageViewItem)
Declaration
protected virtual void SetSelectedItem(RadPageViewItem item)
Parameters
Rad
|
ShowPeekPopup(RadPageViewItem)
Shows a peek pop-up over a Rad
Declaration
public void ShowPeekPopup(RadPageViewItem peekItem)
Parameters
Rad
|
ShowPeekPopupCore(RadPageViewItem)
Declaration
protected virtual void ShowPeekPopupCore(RadPageViewItem peekItem)
Parameters
Rad
|
StartItemDrag(RadPageViewItem)
Declaration
protected virtual void StartItemDrag(RadPageViewItem item)
Parameters
Rad
|
SwapItems(Int32, Int32)
Declaration
public void SwapItems(int index1, int index2)
Parameters
System.
|
System.
|
SwapItems(RadPageViewItem, RadPageViewItem)
Declaration
public void SwapItems(RadPageViewItem item1, RadPageViewItem item2)
Parameters
Rad
|
Rad
|
SwapItemsCore(Int32, Int32)
Declaration
protected virtual void SwapItemsCore(int index1, int index2)
Parameters
System.
|
System.
|
SynchronizeItemsIndices()
Declaration
protected virtual void SynchronizeItemsIndices()
SyncronizeItem(RadPageViewItem)
Declaration
protected virtual void SyncronizeItem(RadPageViewItem item)
Parameters
Rad
|
UpdateItemOrientation(IEnumerable)
Declaration
protected virtual void UpdateItemOrientation(IEnumerable items)
Parameters
System.
|
UpdatePageBounds(RadPageViewPage)
Declaration
protected virtual void UpdatePageBounds(RadPageViewPage page)
Parameters
Rad
|
Events
EditorInitialized
Declaration
public event EventHandler<RadPageViewEditorEventArgs> EditorInitialized
Event Type
System.
|
ItemClicked
Declaration
public event EventHandler ItemClicked
Event Type
System.
|
ItemCreating
Declaration
public event EventHandler<RadPageViewItemCreatingEventArgs> ItemCreating
Event Type
System.
|
ItemDropped
Declaration
public event EventHandler<RadPageViewItemDroppedEventArgs> ItemDropped
Event Type
System.
|
ItemDropping
Declaration
public event EventHandler<RadPageViewItemDroppingEventArgs> ItemDropping
Event Type
System.
|
ItemsChanged
Declaration
public event EventHandler<RadPageViewItemsChangedEventArgs> ItemsChanged
Event Type
System.
|
ItemSelected
Declaration
public event EventHandler<RadPageViewItemSelectedEventArgs> ItemSelected
Event Type
System.
|
ItemSelecting
Declaration
public event EventHandler<RadPageViewItemSelectingEventArgs> ItemSelecting
Event Type
System.
|
PeekPopupClosed
Fired when the peek pop-up has been closed.
Declaration
public event EventHandler PeekPopupClosed
Event Type
System.
|
PeekPopupOpening
Fired when the peek pop-up is about to be shown. In this event you need to populate the content of the peek pop-up, otherwise it will not be displayed.
Declaration
public event EventHandler<RadPageViewPeekPopupEventArgs> PeekPopupOpening
Event Type
System.
|