New to Telerik UI for ASP.NET AJAX? Start a free 30-day trial

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:

C#
public class RibbonBarTab : WebControl, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor, IRibbonBarSubComponent, IXmlSerializable

Inheritance: objectControlWebControlRibbonBarTab

Implements: IAttributeAccessorIComponentIControlBuilderAccessorIControlDesignerAccessorIDataBindingsAccessorIDisposableIExpressionsAccessorIParserAccessorIRibbonBarSubComponentIUrlResolutionServiceIXmlSerializable...

Inherited Members WebControl.ApplyStyle(Style)WebControl.CopyBaseAttributes(WebControl)WebControl.CreateControlStyle()WebControl.LoadViewState(object)WebControl.TrackViewState()WebControl.MergeStyle(Style)WebControl.Render(HtmlTextWriter)WebControl.RenderBeginTag(HtmlTextWriter)WebControl.RenderEndTag(HtmlTextWriter)WebControl.SaveViewState()WebControl.AccessKeyWebControl.AttributesWebControl.BackColorWebControl.BorderColorWebControl.BorderWidthWebControl.BorderStyleWebControl.ControlStyleWebControl.ControlStyleCreatedWebControl.CssClassWebControl.DisabledCssClassWebControl.StyleWebControl.EnabledWebControl.EnableThemingWebControl.FontWebControl.ForeColorWebControl.HasAttributesWebControl.HeightWebControl.IsEnabledWebControl.SupportsDisabledAttributeWebControl.SkinIDWebControl.TabIndexWebControl.TagNameWebControl.ToolTipWebControl.WidthControl.ResolveAdapter()Control.HasEvents()Control.GetRouteUrl(object)Control.GetRouteUrl(string, object)Control.GetRouteUrl(RouteValueDictionary)Control.GetRouteUrl(string, RouteValueDictionary)Control.GetUniqueIDRelativeTo(Control)Control.ApplyStyleSheetSkin(Page)Control.OnDataBinding(EventArgs)Control.DataBind()Control.DataBind(bool)Control.DataBindChildren()Control.AddParsedSubObject(object)Control.EnsureID()Control.OnInit(EventArgs)Control.ClearChildState()Control.ClearChildControlState()Control.ClearChildViewState()Control.ClearEffectiveClientIDMode()Control.ClearCachedClientID()Control.Focus()Control.LoadControlState(object)Control.MapPathSecure(string)Control.OpenFile(string)Control.OnLoad(EventArgs)Control.OnPreRender(EventArgs)Control.BuildProfileTree(string, bool)Control.SaveControlState()Control.RenderChildren(HtmlTextWriter)Control.RenderControl(HtmlTextWriter)Control.RenderControl(HtmlTextWriter, ControlAdapter)Control.OnUnload(EventArgs)Control.Dispose()Control.RaiseBubbleEvent(object, EventArgs)Control.OnBubbleEvent(object, EventArgs)Control.AddedControl(Control, int)Control.CreateControlCollection()Control.CreateChildControls()Control.ResolveUrl(string)Control.ResolveClientUrl(string)Control.FindControl(string)Control.FindControl(string, int)Control.GetDesignModeState()Control.HasControls()Control.IsLiteralContent()Control.EnsureChildControls()Control.RemovedControl(Control)Control.SetDesignModeState(IDictionary)Control.SetRenderMethodDelegate(RenderMethod)Control.ClientIDModeControl.ClientIDControl.ClientIDSeparatorControl.ContextControl.AdapterControl.DesignModeControl.EventsControl.IDControl.IsChildControlStateClearedControl.EnableViewStateControl.ViewStateModeControl.IsViewStateEnabledControl.NamingContainerControl.IdSeparatorControl.LoadViewStateByIDControl.PageControl.RenderingCompatibilityControl.TemplateControlControl.ParentControl.TemplateSourceDirectoryControl.AppRelativeTemplateSourceDirectoryControl.SiteControl.VisibleControl.UniqueIDControl.HasChildViewStateControl.ControlsControl.ValidateRequestModeControl.ViewStateControl.ViewStateIgnoresCaseControl.ChildControlsCreatedControl.IsTrackingViewStateControl.DisposedControl.DataBindingControl.InitControl.LoadControl.PreRenderControl.Unloadobject.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()object.GetType()object.MemberwiseClone()...

Constructors

C#
public RibbonBarTab()

Properties

C#
public IRibbonBarSubComponent Container { get; }
C#
public RibbonBarContextualTabGroup ContextualTabGroup { get; }
C#
[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.

C#
[PersistenceMode(PersistenceMode.InnerDefaultProperty)]
public RibbonBarGroupCollection Groups { get; }
Property Value:

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.

Example:
cs-api-definition
tab.Groups[0].Text = "ExampleGroupText";
C#
public WebControl ParentWebControl { get; }

Implements: IRibbonBarSubComponent.ParentWebControl

C#
protected IRenderer Renderer { get; }

Gets a reference to the RibbonBar instance.

C#
public RadRibbonBar RibbonBar { get; }
Property Value:

RadRibbonBar instance. If not set, the returned is null.

Implements: IRibbonBarSubComponent.RibbonBar

Use the property to get the RibbonBar instance.

C#
protected override HtmlTextWriterTag TagKey { get; }

Overrides: WebControl.TagKey

Gets or sets the text of the tab.

C#
public string Text { get; set; }
Property Value:

The text of the tab. The default value is empty string.

Use the property to set the displayed text of the tab.

Gets or sets the value property of the tab.

C#
public string Value { get; set; }

You can use it to associate custom data with the tab.

Example:
C#
This example illustrates how to use the <strong>Value</strong> property on <xref href="Telerik.Web.UI.RadRibbonBar.ButtonClick?text=ButtonClick" data-throw-if-not-resolved="false"></xref> event.

Methods

C#
protected override void AddAttributesToRender(HtmlTextWriter writer)
Parameters:writerHtmlTextWriter

Overrides: WebControl.AddAttributesToRender(HtmlTextWriter)

C#
protected virtual IRenderer CreateControlRenderer()
Returns:

IRenderer

Searches the RibbonBarTab for the first RibbonBarButton which Value property is equal to the specified value.

C#
public RibbonBarButton FindButtonByValue(string value)
Parameters:valuestring

The Value to search for.

Returns:

RibbonBarButton

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.

C#
public RibbonBarGroup FindGroupByValue(string value)
Parameters:valuestring

The Value to search for.

Returns:

RibbonBarGroup

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.

C#
public RibbonBarMenuItem FindMenuItemByValue(string value)
Parameters:valuestring

The Value to search for.

Returns:

RibbonBarMenuItem

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.

C#
public RibbonBarToggleButton FindToggleButtonByValue(string value)
Parameters:valuestring

The Value to search for.

Returns:

RibbonBarToggleButton

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.

C#
public List<RibbonBarGroup> GetVisibleGroups()
Returns:

List<RibbonBarGroup>

All visible groups inside this tab.

C#
public void ReadXml(XmlReader reader)
Parameters:readerXmlReader
C#
protected virtual void ReadXmlForGroups(XmlReader reader)
Parameters:readerXmlReader
C#
protected override void RenderContents(HtmlTextWriter writer)
Parameters:writerHtmlTextWriter

Overrides: WebControl.RenderContents(HtmlTextWriter)

C#
protected void WriteXml(XmlWriter writer)
Parameters:writerXmlWriter
C#
protected virtual void WriteXmlForGroups(XmlWriter writer)
Parameters:writerXmlWriter