RibbonBarMenuItem
This Class defines RibbonBarMenuItem.
Definition
Namespace:Telerik.Web.UI
Assembly:Telerik.Web.UI.dll
Syntax:
public class RibbonBarMenuItem : WebControl, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor, IRibbonBarSubComponent, IXmlSerializableInheritance: objectControlWebControlRibbonBarMenuItem
Implements:
Inherited Members
Constructors
public RibbonBarMenuItem()Fields
protected const string NonBreakingSpace = " "Properties
Gets or sets an optional parameter passed to the Command event along with the associated CommandName.
[Bindable(true)]
public string CommandArgument { get; set; }Gets or sets the command name associated with the MenuItem that is passed to the Command event.
public string CommandName { get; set; }Gets or sets the container.
public IRibbonBarSubComponent Container { get; }The container.
Gets or sets the image's URL of the item, used when it's disabled.
public string DisabledImageUrl { get; set; }The URL to the image. The default value is empty string.
Use the DisabledImageUrl property to specify a custom image that will be used when the item is disabled.
Gets or sets the rendered alt text of the item's image dom element.
public string ImageAltText { get; set; }alt text of an item's image. The default value is empty string.
Use the property to set the alt text for the item's image element, when needed for accessibility.
Gets or sets the image's URL of the item, used when it's enabled.
public string ImageUrl { get; set; }The URL to the image. The default value is empty string.
Use the ImageUrl property to specify a custom image that will be used when the item is enabled.
Gets a RibbonBarMenuItemCollection object that contains the sub-items of the MenuItem.
[PersistenceMode(PersistenceMode.InnerProperty)]
public RibbonBarMenuItemCollection Items { get; }A RibbonBarMenuItemCollection that contains the sub-items of the MenuItem. By default the collection is empty (the MenuItem has no sub-items).
Use the Items property to access the sub-items of the MenuItem. You can also use the Items property to manage the items. You can add, remove or modify items from the Items collection.
Gets or sets navigation URL for the item. Usually pointing to a page.
public string NavigateUrl { get; set; }URL. The default value is empty string.
Use the NavigateUrl property to specify a custom a url to a page which should be loaded on click on the item.
Gets the parent item of the menu item. Returns null if the parent is the menu itself.
public RibbonBarMenuItem ParentItem { get; }Gets or sets the parent web control.
public WebControl ParentWebControl { get; }The parent web control.
Implements:
Gets a reference to the RibbonBar instance.
public RadRibbonBar RibbonBar { get; }RadRibbonBar instance. If not set, the returned is null.
Implements:
Use the property to get the RibbonBar instance.
Gets or sets the text of a certain item.
public string Text { get; set; }The text of an item. The default value is empty string.
Use the property to set the displayed text for an item.
Gets or sets the tooltip of a certain item.
public override string ToolTip { get; set; }The text displayed in the RibbonbBar's enhanced ToolTip. The default value is empty string.
Overrides:
When the ToolTip value is empty, the default ASP ToolTip is displayed with the Text of the item as a value. When ToolTip is set, the enhanced RibbonBar tooltip is shown instead of the default one.
Methods
Searches the RibbonBarMenuItem for the first RibbonBarMenuItem which Value property is equal to the specified value.
public RibbonBarMenuItem FindMenuItemByValue(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 the Visible sub-items.
public IList<RibbonBarMenuItem> GetVisibleItems()All visible sub-items.
Reads the XML.
Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled.
public override void RenderControl(HtmlTextWriter writer)The object that receives the control content.
Overrides: