Introduction
Knowledge Base
API Reference / Server-side / Telerik.Web.UI / RibbonBarToggleList
New to Telerik UI for ASP.NET AJAX? Start a free 30-day trial

RibbonBarToggleList

Class

Container Ribbon item managing a mutually (or independently) toggleable set of toggle buttons, with XML persistence and selection state helpers.

Definition

Namespace:Telerik.Web.UI

Assembly:Telerik.Web.UI.dll

Syntax:
C#
public class RibbonBarToggleList : RibbonBarItem, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor, IRibbonBarSubComponent, IXmlSerializable

Inheritance: objectControlWebControlRibbonBarItemRibbonBarToggleList

Implements: IAttributeAccessorIComponentIControlBuilderAccessorIControlDesignerAccessorIDataBindingsAccessorIDisposableIExpressionsAccessorIParserAccessorIRibbonBarSubComponentIUrlResolutionServiceIXmlSerializable...

Inherited Members RibbonBarItem.CreateControlRenderer()RibbonBarItem.ContainerRibbonBarItem.ParentRibbonBarItem.RibbonBarRibbonBarItem.GroupRibbonBarItem.RendererWebControl.AddAttributesToRender(HtmlTextWriter)WebControl.ApplyStyle(Style)WebControl.CopyBaseAttributes(WebControl)WebControl.CreateControlStyle()WebControl.LoadViewState(object)WebControl.TrackViewState()WebControl.MergeStyle(Style)WebControl.Render(HtmlTextWriter)WebControl.RenderContents(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.TagKeyWebControl.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.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.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

RibbonBarToggleList()

C#
public RibbonBarToggleList()

Properties

ItemType

Gets the type of the RibbonBarItem. Usefull when iterating through the Items collection of RibbonBarGroup

C#
public override RibbonBarItemType ItemType { get; }

Overrides: RibbonBarItem.ItemType

ParentWebControl

C#
public override WebControl ParentWebControl { get; }

Overrides: RibbonBarItem.ParentWebControl

ToggleButtons

Gets a RibbonBarToggleButtonCollection object that contains the toggle buttons of the ToggleList.

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public RibbonBarToggleButtonCollection ToggleButtons { get; }
Property Value:

A RibbonBarToggleButtonCollection that contains the toggle buttons of the ToggleList. By default the collection is empty (ToggleList has no ToggleButtons).

Use the ToggleButtons property to access the toggle buttons of the ToggleList. You can also use the ToggleButtons property to manage the toggle buttons. You can add, remove or modify toggle buttons.

Example:
cs-api-definition
toggleList.ToggleButtons[0].Text = "Example";

ToggledButton

Gets the currently toggled RibbonBarToggleButton.

C#
public RibbonBarToggleButton ToggledButton { get; }
Property Value:

The currently toggled RibbonBarToggleButton. When there isn't a toggle button or the collection is empty, the returned result is null.

Use the ToggledButton property to access the toggled button of the ToggleList.

Example:
cs-api-definition
toggleList.ToggledButton.Text = "Example";

Methods

GetVisibleButtons()

Gets a list of RibbonBarToggleButton that contains the visible toggle buttons of the ToggleList.

C#
public List<RibbonBarToggleButton> GetVisibleButtons()
Returns:

List<RibbonBarToggleButton>

OnPreRender(EventArgs)

C#
protected override void OnPreRender(EventArgs e)
Parameters:eEventArgs

Overrides: Control.OnPreRender(EventArgs)

ReadXml(XmlReader)

Loads the control from an XML string.

C#
public void ReadXml(XmlReader reader)
Parameters:readerXmlReader

The XmlReader from which the control will be populated.

Use the LoadXml method to populate the control from an XML string.

ReadXmlForToggleButtons(XmlReader)

C#
protected virtual void ReadXmlForToggleButtons(XmlReader reader)
Parameters:readerXmlReader

RenderBeginTag(HtmlTextWriter)

C#
public override void RenderBeginTag(HtmlTextWriter writer)
Parameters:writerHtmlTextWriter

Overrides: WebControl.RenderBeginTag(HtmlTextWriter)

RenderEndTag(HtmlTextWriter)

C#
public override void RenderEndTag(HtmlTextWriter writer)
Parameters:writerHtmlTextWriter

Overrides: WebControl.RenderEndTag(HtmlTextWriter)

WriteXml(XmlWriter)

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

WriteXmlForToggleButtons(XmlWriter)

C#
protected virtual void WriteXmlForToggleButtons(XmlWriter writer)
Parameters:writerXmlWriter
In this article
DefinitionConstructorsRibbonBarToggleList()PropertiesItemTypeParentWebControlToggleButtonsToggledButtonMethodsGetVisibleButtons()OnPreRender(EventArgs)ReadXml(XmlReader)ReadXmlForToggleButtons(XmlReader)RenderBeginTag(HtmlTextWriter)RenderEndTag(HtmlTextWriter)WriteXml(XmlWriter)WriteXmlForToggleButtons(XmlWriter)
Not finding the help you need?
Contact Support