RibbonBarSplitButton
Composite Ribbon button offering a primary action with an attached drop-down of additional button options, dynamically resolving shared images and rendering mode at runtime (with XML persistence).
Definition
Namespace:Telerik.Web.UI
Assembly:Telerik.Web.UI.dll
Syntax:
public class RibbonBarSplitButton : RibbonBarMenuBaseItem, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor, IRibbonBarSubComponent, IXmlSerializableInheritance: objectControlWebControlRibbonBarItemRibbonBarClickableItemRibbonBarMenuBaseItemRibbonBarSplitButton...
Implements:
Inherited Members
Constructors
public RibbonBarSplitButton()Properties
Gets a RibbonBarButtonCollection object that contains the buttons of the SplitButton.
[PersistenceMode(PersistenceMode.InnerProperty)]
public RibbonBarButtonCollection Buttons { get; }A RibbonBarButtonCollection that contains the buttons of the SplitButton. By default the collection is empty (SplitButton has no buttons).
Use the Buttons property to access the buttons of the SplitButton. You can also use the Buttons property to manage the buttons. You can add, remove or modify buttons.
Determines whether button selection on button click is enabled.
public bool EnableButtonSelection { get; set; }Boolean. The default value is false.
Use the property to enable/disable button selection. Button selection is the ability to select a button from the drop-down, which becames the default action for the Split Button.
Gets/sets the Image Rendering Mode, localy for the item.
public override RibbonBarImageRenderingMode ImageRenderingMode { get; set; }The value is from the enum RibbonBarImageRenderingMode. It depends of the value of ImageRenderingMode property of RadRibbonBar.
Overrides:
In case ImageRenderingMode is not explicitly set (meaning RibbonBar's ImageRenderingMode is Auto), it's considered as follows:
- If ImageUrl is set and ImageUrlLarge is not set - the mode is Clip;
- Any other case - Dual.
Gets the type of the RibbonBarItem. Usefull when iterating through the Items collection of RibbonBarGroup
public override RibbonBarItemType ItemType { get; }Overrides:
public override WebControl ParentWebControl { get; }Overrides:
Property allowing one to select a default action of the Split Button. If proper conditions are met, the text and the image of the SplitButton are also updated using the selected button.
public int SelectedButtonIndex { get; set; }Integer. The default value is -1.
Use the property to select a button as a default action of the Split Button.
Methods
Searches the RibbonBarSplitButton for the first RibbonBarMenuItem which Value property is equal to the specified value.
public RibbonBarButton FindButtonByValue(string value)The Value to search for.
Returns:A RibbonBarMenuItem whose Value property is equal to the specifed value. If a button is not found, null (Nothing in Visual Basic) is returned.
Returns all buttons with Visible=true in the Buttons collection.
public IList<RibbonBarButton> GetVisibleButtons()A list of RibbonBarButton objects.