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

Definition

Namespace:Telerik.Web.UI

Assembly:Telerik.Web.UI.dll

Syntax:

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

Inheritance: objectControlWebControlRibbonBarGroup

Implements: IAttributeAccessorIComponentIControlBuilderAccessorIControlDesignerAccessorIDataBindingsAccessorIDisposableIExpressionsAccessorIParserAccessorIRibbonBarSubComponentIUrlResolutionServiceIXmlSerializable...

Inherited Members WebControl.AddAttributesToRender(HtmlTextWriter)WebControl.ApplyStyle(Style)WebControl.CopyBaseAttributes(WebControl)WebControl.CreateControlStyle()WebControl.LoadViewState(object)WebControl.TrackViewState()WebControl.MergeStyle(Style)WebControl.Render(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.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.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 RibbonBarGroup()

Properties

Gets or sets the url to an image displayed when the group is collapsed.

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

URL. The default value is empty string.

Use the property to set the image for a collapsed group.

C#
public IRibbonBarSubComponent Container { get; }

Determines if the group's launcher will be available or not.

C#
public bool EnableLauncher { get; set; }
Property Value:

Boolean. The default value is true.

Use the property to enable/disable the group's launcher button.

Gets a RibbonBarItemCollection object that contains the items of the group.

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

A RibbonBarItemCollection that contains the items of the group. By default the collection is empty (the group has no items).

Use the Items property to access the items of the group. You can also use the Items property to manage the items. You can add, remove or modify items from the Items collection.

Example:
cs-api-definition
group.Items[0].Enabled = true;
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.

Gets a reference to the RibbonBarTab instance holding this group.

C#
public RibbonBarTab Tab { get; }
Property Value:

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

Use the property to get the RibbonBarTab holding the group.

Gets or sets the text of the group.

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

The text of a group. The default value is empty string.

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

Gets or sets the value property of the group.

C#
public string Value { get; set; }

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

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 virtual IRenderer CreateControlRenderer()
Returns:

IRenderer

Searches the RibbonBarGroup 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 specified value. If a button is not found, null (Nothing in Visual Basic) is returned.

Searches the RibbonBarGroup 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 specified value. If a menu item is not found, null (Nothing in Visual Basic) is returned.

Searches the RibbonBarGroup 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 all functional Items in the Group. This excludes ButtonStrips and ToggleLists.

C#
public List<RibbonBarItem> GetFunctionalItems()
Returns:

List<RibbonBarItem>

A list with functional Items.

Returns functionl Items in the Group depending on their visibility.

C#
public List<RibbonBarItem> GetFunctionalItems(bool visibleOnly)
Parameters:visibleOnlybool

Tells the method whether to filter out invisible functionl Items.

Returns:

List<RibbonBarItem>

All functionl Items in the Group if visibleOnly is false. If visibleOnly is true, returns only the visible Items.

Gets all RibbonBarToggleList items in the Group.

C#
public List<RibbonBarToggleList> GetToggleLists()
Returns:

List<RibbonBarToggleList>

Returns strictly the Visible functionl Items in the Group.

C#
public List<RibbonBarItem> GetVisibleFunctionalItems()
Returns:

List<RibbonBarItem>

All visible functional Items in the Group.

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

Overrides: WebControl.RenderBeginTag(HtmlTextWriter)

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 WriteXmlForButtons(XmlWriter writer)
Parameters:writerXmlWriter