RibbonBarTab
Represents a top-level tab within the Ribbon, hosting groups, handling rendering via pluggable renderers and supporting XML serialization of contained groups.
Definition
Namespace:Telerik.Web.UI
Assembly:Telerik.Web.UI.dll
Syntax:
public class RibbonBarTab : WebControl, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor, IRibbonBarSubComponent, IXmlSerializable
Inheritance: objectControlWebControlRibbonBarTab
Implements:
Inherited Members
Constructors
public RibbonBarTab()
Properties
public IRibbonBarSubComponent Container { get; }
public RibbonBarContextualTabGroup ContextualTabGroup { get; }
[Obsolete("This property is obsolete since Q3 2011 BETA. Contextual tabs are now added in contextual tab groups defined in RadRibbonBar.", false)]
public string ContextualTabID { get; set; }
Gets a RibbonBarGroupCollection object that contains the groups of the tab.
[PersistenceMode(PersistenceMode.InnerDefaultProperty)]
public RibbonBarGroupCollection Groups { get; }
A RibbonBarGroupCollection that contains the groups of the tab. By default the collection is empty (the tab has no groups).
Use the Groups property to access the groups of the tab. You can also use the Groups property to manage the items. You can add, remove or modify groups from the Groups collection.
public WebControl ParentWebControl { get; }
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.
protected override HtmlTextWriterTag TagKey { get; }
Overrides:
Gets or sets the text of the tab.
public string Text { get; set; }
The text of the tab. The default value is empty string.
Use the property to set the displayed text of the tab.
Methods
protected override void AddAttributesToRender(HtmlTextWriter writer)
Overrides:
Searches the RibbonBarTab for the first RibbonBarButton which Value property is equal to the specified value.
public RibbonBarButton FindButtonByValue(string value)
The Value to search for.
Returns:A RibbonBarButton whose Value property is equal to the specifed value. If a button is not found, null (Nothing in Visual Basic) is returned.
Searches the RibbonBarTab for the first RibbonBarGroup which Value property is equal to the specified value.
public RibbonBarGroup FindGroupByValue(string value)
The Value to search for.
Returns:A RibbonBarGroup whose Value property is equal to the specifed value. If a group is not found, null (Nothing in Visual Basic) is returned.
Searches the RibbonBarTab 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 menu item is not found, null (Nothing in Visual Basic) is returned.
Searches the RibbonBarTab for the first RibbonBarToggleButton which Value property is equal to the specified value.
public RibbonBarToggleButton FindToggleButtonByValue(string value)
The Value to search for.
Returns:A RibbonBarToggleButton whose Value property is equal to the specifed value. If a toggle button is not found, null (Nothing in Visual Basic) is returned.
Returns the Visible groups in the tab.
public List<RibbonBarGroup> GetVisibleGroups()
All visible groups inside this tab.
protected override void RenderContents(HtmlTextWriter writer)
Overrides: