Represent the overflow button at the end of each strip
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
[TypeConverter(typeof(ExpandableObjectConverter))]
public class RadCommandBarOverflowButton : RadCommandBarVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IBindableComponent, IComponent, IDisposable, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider
Inheritance: objectDisposableObjectRadObjectRadElementVisualElementRadComponentElementRadItemUIItemBaseLightVisualElementRadCommandBarVisualElementRadCommandBarOverflowButton...
Implements:
Inherited Members
Constructors
Creates an overflow button for the specified strip and initializes its overflow and customization menus.
public RadCommandBarOverflowButton(CommandBarStripElement owner)
The strip whose overflowed items and commands are shown by this button.
Fields
The popup that displays overflowed items and overflow commands.
protected RadDropDownMenu dropDownMenuElement
Identifies the property that tracks whether the strip has items in its overflow panel.
public static RadProperty HasOverflowedItemsProperty
The strip whose items are presented by this overflow button.
protected CommandBarStripElement owner
The panel that hosts items moved out of the strip.
protected RadCommandBarOverflowPanelElement panel
Properties
Gets the "Add or Remove Items" menu item from overflow menu
public RadMenuItem AddRemoveButtonsMenuItem { get; }
Gets or sets the ArrowPrimitive element of the button.
[Browsable(false)]
public ArrowPrimitive ArrowPrimitive { get; set; }
Gets the menu item from overflow menu which opens the Customize Dialog
public RadMenuItem CustomizeButtonMenuItem { get; }
[Browsable(false)]
public CommandBarCustomizeDialogProvider DialogProvider { get; set; }
Gets the RadDropDownMenu that is shown on click.
public RadDropDownMenu DropDownMenu { get; }
Gets whether there are items in the overflow panel.
public bool HasOverflowedItems { get; }
Gets or sets the dropdown menu element theme name.
[Browsable(false)]
public string HostControlThemeName { get; set; }
Gets or sets the panel in which overflowed items are arranged.
public LayoutPanel ItemsLayout { get; }
Gets or sets the orientation of the overflow button.
public override Orientation Orientation { get; set; }
Overrides:
Gets the overflow panel which contains the overflowed items
public RadCommandBarOverflowPanelElement OverflowPanel { get; }
Methods
Enables the button's fill and border and assigns its minimum display size.
protected override void CreateChildElements()
Overrides:
Unhooks menu events, disposes the popup, and releases inherited managed resources.
protected override void DisposeManagedResources()
Overrides:
Copies the containing control's binding context to the overflow menu and subscribes to future binding-context changes.
protected override void OnLoaded()
Overrides:
Opens the overflow menu unless the cancellable opening event rejects the request.
protected override void OnMouseDown(MouseEventArgs e)
Mouse-button and position data for the event.
Overrides:
Clears the pressed state and repaints the button when the pointer leaves it.
protected override void OnMouseLeave(EventArgs e)
Event data for the mouse-leave event.
Overrides:
Raises the event.
protected void OnOverflowMenuClosed(object sender, RadPopupClosedEventArgs args)
The element that is reponsible for firing the event.
argsRadPopupClosedEventArgsA RadPopupClosedEventArgs that contains the event data.
Raises the event.
protected virtual void OnOverflowMenuClosing(object sender, RadPopupClosingEventArgs args)
The element that is reponsible for firing the event.
argsRadPopupClosingEventArgsA RadPopupClosingEventArgs that contains the event data.
Raises the event.
protected bool OnOverflowMenuOpening(CancelEventArgs e)
A CancelEventArgs that contains the event data.
Returns:Shows or hides the overflow panel based on whether it contains items and synchronizes the popup's right-to-left setting.
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Details of the changed property.
Overrides:
Updates the overflow popup's image list when the root element reports an image-list change.
protected override void OnTunnelEvent(RadElement sender, RoutedEventArgs args)
The element that raised the tunneled event.
argsRoutedEventArgsThe routed event data.
Overrides:
Removes the binding-context-change subscription associated with the old element tree.
protected override void OnUnloaded(ComponentThemableElementTree oldTree)
The element tree from which the button was unloaded.
Overrides:
Rebuilds the add/remove submenu from strip items that are allowed in the overflow menu and applies the owner's size and visual settings.
public void PopulateDropDownMenu()
Events
Occurs after the overflow menu is closed.
public event EventHandler OverflowMenuClosed
Occurs before the overflow menu is closed. Set Cancel to keep it open.
public event CancelEventHandler OverflowMenuClosing
This event fires when overflow menu is opened.
public event EventHandler OverflowMenuOpened
This event fires before oferflow menu is opened.
public event CancelEventHandler OverflowMenuOpening