Implements the Outlook page-view mode, where a stack of pages can be hidden or unchecked through overflow controls.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
public class RadPageViewOutlookElement : RadPageViewStackElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IBindableComponent, IComponent, IDisposable, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider
Inheritance: objectDisposableObjectRadObjectRadElementVisualElementRadComponentElementRadItemUIItemBaseLightVisualElementRadPageViewElementBaseRadPageViewElementRadPageViewStackElementRadPageViewOutlookElement...
Implements:
Inherited Members
Constructors
public RadPageViewOutlookElement()
Fields
Provides the fallback image for an associated overflow button when its page item has no image.
public static Bitmap AssociatedButtonDefaultImage
Identifies the image shown by the overflow menu's show-fewer command; its default is null.
public static RadProperty ShowFewerButtonsImageProperty
Identifies the image shown by the overflow menu's show-more command; its default is null.
public static RadProperty ShowMoreButtonsImageProperty
Properties
Gets the element which represents the grip which can be dragged to adjust the count of visible items in the stack.
[Browsable(false)]
public OutlookViewOverflowGrip OverflowGrip { get; }
Gets the element that represents the container which holds the buttons shown when items in the stack are hidden by using the overflow grip.
[Browsable(false)]
public OverflowItemsContainer OverflowItemsContainer { get; }
Gets or sets the image that is shown on the item in the overflow drop-down menu that is used to show fewer buttons in the control.
[TypeConverter(typeof(ImageTypeConverter))]
public Image ShowFewerButtonsImage { get; set; }
Gets or sets the image that is shown on the item in the overflow drop-down menu that is used to show more buttons in the control.
[TypeConverter(typeof(ImageTypeConverter))]
public Image ShowMoreButtonsImage { get; set; }
Methods
Arranges the overflow container below the page items and positions the grip beneath the item area.
protected override RectangleF ArrangeItems(RectangleF clientRect)
The client rectangle available for the view's items.
Returns:The content rectangle returned by the base item layout.
Overrides:
Makes an item visible. The item will appear as checked in the overflow menu.
public virtual void CheckItem(RadPageViewOutlookItem item)
The item to make visible.
Creates the overflow grip and item container, then binds their menu images to this element's image properties.
protected override void CreateChildElements()
Overrides:
Creates a page item specialized for the Outlook view's overflow behavior.
protected override RadPageViewItem CreateItem()
A new Outlook page-view item.
Overrides:
Unsubscribes from the overflow-grip drag event before releasing base resources.
protected override void DisposeManagedResources()
Overrides:
Drags the overflow grip down to hide the first possible visible item.
Drags the overflow grip up to show the first possible hidden item.
Reduces the base content area by the space occupied by the overflow grip.
protected override RectangleF GetContentAreaRectangle(RectangleF clientRect)
The client rectangle available to the content area.
Returns:The content rectangle after reserving space for the grip.
Overrides:
This method returns the count of the items which are currently visible to the user.
Gets an array containing the items that are currently hidden by using the overflow grip.
Finds the last visible item by scanning the page-item collection from its end.
protected virtual RadPageViewOutlookItem GetNextVisibleItem()
The last visible Outlook item, or null when no item is visible.
Gets an array containing the items that are currently unchecked by using the overflow menu.
Hides a given amount of items from the visible items in the RadPageViewOutlookElement starting from the bottom part of the stack.
Initializes the collections that track hidden and unchecked Outlook items.
protected override void InitializeFields()
Overrides:
Keeps the grip and overflow container inside this view's layout while delegating other elements to the base implementation.
protected override bool IsChildElementExternal(RadElement element)
The child element to classify.
Returns:Whether the element is external to the view's layout.
Overrides:
Measures the grip and overflow container before measuring page items in the remaining space.
Raises ItemAssociatedButtonClicked when an associated overflow button is clicked.
Raises ItemChecked while processing an item check. When initiated by the overflow menu, the caller updates the menu item's checkmark after this handler returns.
protected virtual void OnItemChecked(object sender, OutlookViewItemEventArgs args)
The object that initiated the change.
argsOutlookViewItemEventArgsEvent data containing the affected Outlook item.
Raises ItemCollapsed after a visible item is moved into the overflow area.
protected virtual void OnItemCollapsed(object sender, OutlookViewItemEventArgs args)
The object that initiated the change.
argsOutlookViewItemEventArgsEvent data containing the affected Outlook item.
Raises ItemShown after a hidden item is restored to the visible stack.
protected virtual void OnItemShown(object sender, OutlookViewItemEventArgs args)
The object that initiated the change.
argsOutlookViewItemEventArgsEvent data containing the affected Outlook item.
Raises ItemUnchecked while processing an item uncheck. When initiated by the overflow menu, the caller updates the menu item's checkmark after this handler returns.
protected virtual void OnItemUnchecked(object sender, OutlookViewItemEventArgs args)
The object that initiated the change.
argsOutlookViewItemEventArgsEvent data containing the affected Outlook item.
Called when the element is loaded and ready for use.
protected override void OnLoaded()
Overrides:
Removes an item's overflow button and tracking entries before removing the page item.
protected override void RemoveItemCore(RadPageViewItem item)
The page item being removed.
Overrides:
Rejects direct changes to stack position, item-selection mode, and content orientation unless they come from a default-value override.
protected override ValueUpdateResult SetValueCore(RadPropertyValue propVal, object propModifier, object newValue, ValueSource source)
The property value being updated.
propModifierobjectA modifier associated with the property update.
newValueobjectThe proposed property value.
sourceValueSourceThe source of the proposed value.
Returns:A ValueUpdateResult indicating whether the change was accepted or canceled.
Overrides:
Shows a given amount of items from the hidden items in the RadPageViewOutlookElement starting from the bottom part of the stack.
Makes an item invisible. The item will appear as unchecked in the overflow menu.
public virtual void UncheckItem(RadPageViewOutlookItem item)
The item to make invisible.
Events
Fires when the user clicks on a button associated with a RadPageViewItem instance. This buttons is shown when the item is collapsed by using the overflow grip.
public event EventHandler ItemAssociatedButtonClicked
Fires when an item is checked in the overflow drop-down menu of the RadPageViewOutlookElement.
public event OutlookViewItemEventHandler ItemChecked
Fires when an item is collapsed in the RadPageViewOutlookElement.
public event OutlookViewItemEventHandler ItemCollapsed
Fires when an item is shown in the RadPageViewOutlookElement.
public event OutlookViewItemEventHandler ItemShown
Fires when an item is unchecked in the overflow drop-down menu of the RadPageViewOutlookElement.
public event OutlookViewItemEventHandler ItemUnchecked