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

RadRibbonBar control allows you to easily organize the navigation of your application in a simple, structured way.

RadRibbonBar mimics the UI of the RibbonBar used in Microsoft Office 2007, thus providing your end-users with a familiar way to navigate around your application.

Definition

Namespace:Telerik.Web.UI

Assembly:Telerik.Web.UI.dll

Syntax:

C#
[EmbeddedSkin("RibbonBar", typeof(RadRibbonBar))]
[EmbeddedSkin("RibbonBar", "Default", typeof(RadRibbonBar))]
[RequiredCss("Telerik.Web.UI.Skins.Common.fonticons.css", RenderMode.Lightweight, typeof(RadRibbonBar))]
[RequiredCss("Telerik.Web.UI.Skins.Common.MaterialRipple.css", RenderMode.Lightweight, typeof(RadButton))]
[RequiredScript(typeof(jQueryPlugins), 0)]
[RequiredScript(typeof(RibbonBarBaseScripts), 1)]
[RequiredScript(typeof(MaterialRipple))]
[ClientScriptResource("Telerik.Web.UI.RadRibbonBar", "Telerik.Web.UI.RibbonBar.RadRibbonBarScripts.js")]
[TelerikToolboxCategory("Navigation")]
[ToolboxBitmap(typeof(RadRibbonBar), "Toolbox.Icons.RibbonBar.png")]
public class RadRibbonBar : RadWebControl, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor, IScriptControl, IControlResolver, ISkinnableControl, IControl, IPostBackEventHandler, IPostBackDataHandler, IXmlSerializable

Inheritance: objectControlWebControlRadWebControlRadRibbonBar

Implements: IAttributeAccessorIComponentIControlIControlBuilderAccessorIControlDesignerAccessorIControlResolverIDataBindingsAccessorIDisposableIExpressionsAccessorIParserAccessorIPostBackDataHandlerIPostBackEventHandlerIScriptControlISkinnableControlIUrlResolutionServiceIXmlSerializable...

Inherited Members WebControl.AddAttributesToRender(HtmlTextWriter)WebControl.ApplyStyle(Style)WebControl.CopyBaseAttributes(WebControl)WebControl.CreateControlStyle()WebControl.MergeStyle(Style)WebControl.Render(HtmlTextWriter)WebControl.RenderBeginTag(HtmlTextWriter)WebControl.RenderEndTag(HtmlTextWriter)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.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.IsChildControlStateClearedControl.EnableViewStateControl.ViewStateModeControl.IsViewStateEnabledControl.NamingContainerControl.IdSeparatorControl.LoadViewStateByIDControl.PageControl.RenderingCompatibilityControl.TemplateControlControl.ParentControl.TemplateSourceDirectoryControl.AppRelativeTemplateSourceDirectoryControl.SiteControl.VisibleControl.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 RadRibbonBar()

Properties

Gets a RibbonBarApplicationMenu object (if one is set).

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public RibbonBarApplicationMenu ApplicationMenu { get; set; }
Property Value:

A RibbonBarApplicationMenu. If not set, returns null.

Use the RibbonBarApplicationMenu property to assign/retrieve an ApplicationMenu to/from RadRibbonBar.

Example:
cs-api-definition
RadRibbonBar1.ApplicationMenu.Items[0].Text = "Example";
C#
public string ApplicationMenuID { get; set; }
C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public RibbonBarContextualTabGroupCollection ContextualTabGroups { get; }

The CssClass property will now be used instead of the former Skin and will be modified in AddAttributesToRender()

C#
protected override string CssClassFormatString { get; }

Overrides: RadWebControl.CssClassFormatString

Example:
C#
protected override string CssClassFormatString
{
       get
       {
           return "RadDock RadDock_{0} rdWTitle rdWFooter";
       }
}

Enables automatic arrange of items within a group.

C#
[ClientPersistedProperty]
public bool EnableAutoArrange { get; set; }
Property Value:

True or False. The default value is True.

Gets or sets whether maximizing/minimizing of the RibbonBar should be enabled.

C#
[ClientPersistedProperty]
public bool EnableMinimizing { get; set; }
Property Value:

True or False. The default value is False.

Gets or sets a value indicating whether the Quick Access Toolbar is enabled. False by default.

C#
public bool EnableQuickAccessToolbar { get; set; }
C#
public override string ID { get; set; }

Overrides: Control.ID

Gets or sets the rendering mode of all RibbonBarClickableItems images.

C#
[ClientPersistedProperty]
public RibbonBarImageRenderingMode ImageRenderingMode { get; set; }
Property Value:

One of the RibbonBarImageRenderingMode values. The default value is Auto.

Used to customize the RibbonBar keyboard navigation functionality

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public RibbonBarKeyboardNavigationSettings KeyboardNavigationSettings { get; }

Gets or sets whether the RibbonBar should be minimized.

C#
[ClientPersistedProperty]
public bool Minimized { get; set; }
Property Value:

True or False. The default value is False.

Gets or sets a value indicating the client-side event handler that is called after an item inside of an ApplicationMenu is clicked. The event is passed the point for conditional cancel of the item's clicking.

C#
[ClientControlEvent]
[ClientPropertyName("applicationMenuItemClicked")]
public string OnClientApplicationMenuItemClicked { get; set; }
Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

Use the OnClientApplicationMenuItemClicked property to specify a JavaScript function that is executed after an item inside of na ApplicationMenu is clicked.

Two parameters are passed to the handler:

  • sender (the client-side RadRibbonBar object);
  • eventArgs with 3 properties:
    • get_applicationMenu() - the instance of the application menu;
    • get_item() - the instance of the clicked application menu item;
    • get_domEvent().
Example:
C#
The following example demonstrates how to use the <strong>OnClientApplicationMenuItemClicked</strong>
property.

<p>
    <p>&lt;script language="javascript"&gt;<br />
    function <strong>ClientApplicationMenuItemClickedHandler</strong>(sender, args)<br />
    {<br />
        alert("The clicked ApplicationMenuItem is: " + args.get_item().get_text());<br />
    }<br />
    &lt;/script&gt;<br />
        <br />
    &lt;telerik:RibbonBarApplicationMenu ID="RadRibbonBarApplicationMenu1" runat="server" Text="Menu"&gt;<br />
    &lt;Items&gt;<br />
    &lt;telerik:RibbonBarApplicationMenuItem Text="MenuItem"/&gt;<br />
    &lt;/Items&gt;<br />
    &lt;/telerik:RibbonBarApplicationMenu&gt;<br />
    &lt;telerik:RadRibbonBar id="RadRibbonBar1" runat="server" ApplicationMenuID="RadRibbonBarApplicationMenu1"
    <strong>OnClientApplicationMenuItemClicked="ClientApplicationMenuItemClickedHandler"</strong>&gt;<br />
    &lt;telerik:RibbonBarTab Text="Tab"&gt;<br />
    &lt;/telerik:RibbonBarTab&gt;<br />
    &lt;/telerik:RadRibbonBar&gt;</p>
</p>

Gets or sets a value indicating the client-side event handler that is called after an item inside of an ApplicationMenu is clicked. The event serves as a point for conditional cancel of the item's clicking.

C#
[ClientControlEvent]
[ClientPropertyName("applicationMenuItemClicking")]
public string OnClientApplicationMenuItemClicking { get; set; }
Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

Use the OnClientApplicationMenuItemClicking property to specify a JavaScript function that is executed after an item inside of na ApplicationMenu is clicked.

Two parameters are passed to the handler:

  • sender (the client-side RadRibbonBar object);
  • eventArgs with 3 properties:
    • get_applicationMenu() - the instance of the application menu;
    • get_item() - the instance of the clicked application menu item;
    • get_domEvent().
Example:
C#
The following example demonstrates how to use the <strong>OnClientApplicationMenuItemClicking</strong>
property.

<p>
    <p>&lt;script language="javascript"&gt;<br />
    function <strong>ClientApplicationMenuItemClickingHandler</strong>(sender, args)<br />
    {<br />
    if (args.get_item().get_text() == "Unclickable")<br />
        args.set_cancel(true);<br />
    }<br />
    &lt;/script&gt;<br />
        <br />
    &lt;telerik:RibbonBarApplicationMenu ID="RadRibbonBarApplicationMenu1" runat="server" Text="Menu"&gt;<br />
    &lt;Items&gt;<br />
    &lt;telerik:RibbonBarApplicationMenuItem Text="Unclickable"/&gt;<br />
    &lt;/Items&gt;<br />
    &lt;/telerik:RibbonBarApplicationMenu&gt;<br />
    &lt;telerik:RadRibbonBar id="RadRibbonBar1" runat="server" ApplicationMenuID="RadRibbonBarApplicationMenu1"
    <strong>OnClientApplicationMenuItemClicking="ClientApplicationMenuItemClickingHandler"</strong>&gt;<br />
    &lt;telerik:RibbonBarTab Text="Tab"&gt;<br />
    &lt;/telerik:RibbonBarTab&gt;<br />
    &lt;/telerik:RadRibbonBar&gt;</p>
</p>

Gets or sets a value indicating the client-side event handler that is called after a button is clicked. The event is passed the point for conditional cancel of the button clicking.

C#
[ClientControlEvent]
[ClientPropertyName("buttonClicked")]
public string OnClientButtonClicked { get; set; }
Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

Use the OnClientButtonClicked property to specify a JavaScript function that is executed after a button is clicked.

Two parameters are passed to the handler:

  • sender (the client-side RadRibbonBar object);
  • eventArgs with 2 properties:
    • get_button() - the instance of the button which is clicked;
    • get_domEvent().
Example:
C#
The following example demonstrates how to use the <strong>OnClientButtonClicked</strong>
property.

<p>
    <p>&lt;script language="javascript"&gt;<br />
    function <strong>ClientButtonClickedHandler</strong>(sender, args)<br />
    {<br />
        alert("Clicked button is: " + args.get_button().get_text());<br />
    }<br />
    &lt;/script&gt;<br />
        <br />
    &lt;telerik:RadRibbonBar id="RadRibbonBar1" runat="server"
    <strong>OnClientButtonClicked="ClientButtonClickedHandler"</strong>&gt;<br />
    &lt;telerik:RibbonBarTab Text="Tab"&gt;<br />
    &lt;telerik:RibbonBarGroup Text="Group"&gt;<br />
    &lt;Items&gt;<br />
    &lt;telerik:RibbonBarButton Text="Button" /&gt;<br />
    &lt;/Items&gt;<br />
    &lt;/telerik:RibbonBarGroup&gt;<br />
    &lt;/telerik:RibbonBarTab&gt;<br />
    &lt;/telerik:RadRibbonBar&gt;</p>
</p>

Gets or sets a value indicating the client-side event handler that is called after a button is clicked. The event serves as a point for conditional cancel of the button clicking.

C#
[ClientControlEvent]
[ClientPropertyName("buttonClicking")]
public string OnClientButtonClicking { get; set; }
Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

Use the OnClientButtonClicking property to specify a JavaScript function that is executed after a button is clicked.

Two parameters are passed to the handler:

  • sender (the client-side RadRibbonBar object);
  • eventArgs with 2 properties:
    • get_button() - the instance of the button which is clicked;
    • get_domEvent().
Example:
C#
The following example demonstrates how to use the <strong>OnClientButtonClicking</strong>
property.

<p>
    <p>&lt;script language="javascript"&gt;<br />
    function <strong>ClientButtonClickingHandler</strong>(sender, args)<br />
    {<br />
    if (args.get_button().get_text() == "Unclickable")<br />
        args.set_cancel(true);<br />
    }<br />
    &lt;/script&gt;<br />
        <br />
    &lt;telerik:RadRibbonBar id="RadRibbonBar1" runat="server"
    <strong>OnClientButtonClicking="ClientButtonClickingHandler"</strong>&gt;<br />
    &lt;telerik:RibbonBarTab Text="Tab"&gt;<br />
    &lt;telerik:RibbonBarGroup Text="Group"&gt;<br />
    &lt;Items&gt;<br />
    &lt;telerik:RibbonBarButton Text="Unclickable" /&gt;<br />
    &lt;/Items&gt;<br />
    &lt;/telerik:RibbonBarGroup&gt;<br />
    &lt;/telerik:RibbonBarTab&gt;<br />
    &lt;/telerik:RadRibbonBar&gt;</p>
</p>

Gets or sets a value indicating the client-side event handler that is called after a toggle button is clicked. The event is passed the point for conditional cancel of the button's toggling.

C#
[ClientControlEvent]
[ClientPropertyName("buttonToggled")]
public string OnClientButtonToggled { get; set; }
Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

Use the OnClientButtonToggled property to specify a JavaScript function that is executed after a toggle button is clicked.

Two parameters are passed to the handler:

  • sender (the client-side RadRibbonBar object);
  • eventArgs with 2 properties:
    • get_button() - the instance of the toggle button which is clicked;
    • get_domEvent().
Example:
C#
The following example demonstrates how to use the <strong>OnClientButtonToggled</strong>
property.

<p>
    <p>&lt;script language="javascript"&gt;<br />
    function <strong>ClientButtonTogglingHandler</strong>(sender, args)<br />
    {<br />
        alert("ToggleButton: " + args.get_button().get_text() + " was toggled");<br />
    }<br />
    &lt;/script&gt;<br />
        <br />
    &lt;telerik:RadRibbonBar id="RadRibbonBar1" runat="server"
    <strong>OnClientButtonToggled="ClientButtonToggledHandler"</strong>&gt;<br />
    &lt;telerik:RibbonBarTab Text="Tab"&gt;<br />
    &lt;telerik:RibbonBarGroup Text="Group"&gt;<br />
    &lt;Items&gt;<br />
    &lt;telerik:RibbonBarToggleButton Text="ToggleButton" /&gt;<br />
    &lt;/Items&gt;<br />
    &lt;/telerik:RibbonBarGroup&gt;<br />
    &lt;/telerik:RibbonBarTab&gt;<br />
    &lt;/telerik:RadRibbonBar&gt;</p>
</p>

Gets or sets a value indicating the client-side event handler that is called after a toggle button is clicked. The event serves as a point for conditional cancel of the button's toggling.

C#
[ClientControlEvent]
[ClientPropertyName("buttonToggling")]
public string OnClientButtonToggling { get; set; }
Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

Use the OnClientButtonToggling property to specify a JavaScript function that is executed after a toggle button is clicked.

Two parameters are passed to the handler:

  • sender (the client-side RadRibbonBar object);
  • eventArgs with 2 properties:
    • get_button() - the instance of the toggle button which is clicked;
    • get_domEvent().
Example:
C#
The following example demonstrates how to use the <strong>OnClientButtonToggling</strong>
property.

<p>
    <p>&lt;script language="javascript"&gt;<br />
    function <strong>ClientButtonTogglingHandler</strong>(sender, args)<br />
    {<br />
    if (args.get_button().get_text() == "Untogglable")<br />
        args.set_cancel(true);<br />
    }<br />
    &lt;/script&gt;<br />
        <br />
    &lt;telerik:RadRibbonBar id="RadRibbonBar1" runat="server"
    <strong>OnClientButtonToggling="ClientButtonTogglingHandler"</strong>&gt;<br />
    &lt;telerik:RibbonBarTab Text="Tab"&gt;<br />
    &lt;telerik:RibbonBarGroup Text="Group"&gt;<br />
    &lt;Items&gt;<br />
    &lt;telerik:RibbonBarToggleButton Text="Untogglable" /&gt;<br />
    &lt;/Items&gt;<br />
    &lt;/telerik:RibbonBarGroup&gt;<br />
    &lt;/telerik:RibbonBarTab&gt;<br />
    &lt;/telerik:RadRibbonBar&gt;</p>
</p>

Gets or sets a value indicating the client-side event handler that is called when the selected color of the RibbonBarColorPicker is changed. The event is passed the point for conditional cancel of the selected color's changing.

C#
[ClientControlEvent]
[ClientPropertyName("colorPickerColorChanged")]
public string OnClientColorPickerColorChanged { get; set; }
Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

Gets or sets a value indicating the client-side event handler that is called when the selected color of the RibbonBarColorPicker is about to be changed. The event serves as a point for conditional cancel of the selected color's changing.

C#
[ClientControlEvent]
[ClientPropertyName("colorPickerColorChanging")]
public string OnClientColorPickerColorChanging { get; set; }
Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

Gets or sets a value indicating the client-side event handler that is called when an item inside the RibbonBarComboBox is selected. The event is passed the point for conditional cancel of the item's selecting.

C#
[ClientControlEvent]
[ClientPropertyName("comboBoxSelectedIndexChanged")]
public string OnClientComboBoxSelectedIndexChanged { get; set; }
Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

Gets or sets a value indicating the client-side event handler that is called when an item inside the RibbonBarComboBox is about to be selected.The event serves as a point for conditional cancel of the item's selecting.

C#
[ClientControlEvent]
[ClientPropertyName("comboBoxSelectedIndexChanging")]
public string OnClientComboBoxSelectedIndexChanging { get; set; }
Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

Gets or sets a value indicating the client-side event handler that is called when an text inside the RibbonBarComboBox is changed.

C#
[ClientControlEvent]
[ClientPropertyName("comboBoxTextChanged")]
public string OnClientComboBoxTextChanged { get; set; }
Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

Gets or sets a value indicating the client-side event handler that is called when an item inside the RibbonBarDropDown is selected. The event is passed the point for conditional cancel of the item's selecting.

C#
[ClientControlEvent]
[ClientPropertyName("dropDownSelectedIndexChanged")]
public string OnClientDropDownSelectedIndexChanged { get; set; }
Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

Gets or sets a value indicating the client-side event handler that is called when an item inside the RibbonBarDropDown is about to be selected.The event serves as a point for conditional cancel of the item's selecting.

C#
[ClientControlEvent]
[ClientPropertyName("dropDownSelectedIndexChanging")]
public string OnClientDropDownSelectedIndexChanging { get; set; }
Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

Gets or sets a value indicating the client-side event handler that is called when a gallery item is clicked.

C#
[ClientControlEvent]
[ClientPropertyName("galleryCommand")]
public string OnClientGalleryCommand { get; set; }
Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

Gets or sets a value indicating the client-side event handler that is called when a gallery item is focused.

C#
[ClientControlEvent]
[ClientPropertyName("galleryCommandPreview")]
public string OnClientGalleryCommandPreview { get; set; }
Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

Gets or sets a value indicating the client-side event handler that is called when a gallery item loses focus.

C#
[ClientControlEvent]
[ClientPropertyName("galleryCommandPreviewEnd")]
public string OnClientGalleryCommandPreviewEnd { get; set; }
Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

Gets or sets a value indicating the client-side event handler that is called after the group launcher is clicked. The event is passed the point for conditional cancel of the group launcher clicking.

C#
[ClientControlEvent]
[ClientPropertyName("launcherClicked")]
public string OnClientLauncherClicked { get; set; }
Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

Use the OnClientLauncherClicked property to specify a JavaScript function that is executed after a group launcher is clicked.

Two parameters are passed to the handler:

  • sender (the client-side RadRibbonBar object);
  • eventArgs with 2 properties:
    • get_group() - the instance of the group which launcher is clicked;
    • get_domEvent().
Example:
C#
The following example demonstrates how to use the <strong>OnClientLauncherClicked</strong>
property.

<p>
    <p>&lt;script language="javascript"&gt;<br />
    function <strong>ClientLauncherClickedHandler</strong>(sender, args)<br />
    {<br />
        alert("Clicked is the launcher of group: " + args.get_group().get_text());<br />
    }<br />
    &lt;/script&gt;<br />
        <br />
    &lt;telerik:RadRibbonBar id="RadRibbonBar1" runat="server"
    <strong>OnClientLauncherClicked="ClientLauncherClickedHandler"</strong>&gt;<br />
    &lt;telerik:RibbonBarTab Text="Tab"&gt;<br />
    &lt;telerik:RibbonBarGroup Text="Group"&gt;<br />
    &lt;/telerik:RibbonBarGroup&gt;<br />
    &lt;/telerik:RibbonBarTab&gt;<br />
    &lt;/telerik:RadRibbonBar&gt;</p>
</p>

Gets or sets a value indicating the client-side event handler that is called after the group launcher is clicked. The event serves as a point for conditional cancel of the group launcher clicking.

C#
[ClientControlEvent]
[ClientPropertyName("launcherClicking")]
public string OnClientLauncherClicking { get; set; }
Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

Use the OnClientLauncherClicking property to specify a JavaScript function that is executed after a group launcher is clicked.

Two parameters are passed to the handler:

  • sender (the client-side RadRibbonBar object);
  • eventArgs with 2 properties:
    • get_group() - the instance of the group which launcher is clicked;
    • get_domEvent().
Example:
C#
The following example demonstrates how to use the <strong>OnClientLauncherClicking</strong>
property.

<p>
    <p>&lt;script language="javascript"&gt;<br />
    function <strong>ClientLauncherClickingHandler</strong>(sender, args)<br />
    {<br />
    if (args.get_group().get_text() == "Unlaunchable")<br />
        args.set_cancel(true);<br />
    }<br />
    &lt;/script&gt;<br />
        <br />
    &lt;telerik:RadRibbonBar id="RadRibbonBar1" runat="server"
    <strong>OnClientLauncherClicking="ClientLauncherClickingHandler"</strong>&gt;<br />
    &lt;telerik:RibbonBarTab Text="Tab"&gt;<br />
    &lt;telerik:RibbonBarGroup Text="Unlaunchable"&gt;<br />
    &lt;/telerik:RibbonBarGroup&gt;<br />
    &lt;/telerik:RibbonBarTab&gt;<br />
    &lt;/telerik:RadRibbonBar&gt;</p>
</p>

Gets or sets a value indicating the client-side event handler that is called after the client object of RadRibbonBar is initialized.

C#
[ClientControlEvent]
[ClientPropertyName("load")]
public string OnClientLoad { get; set; }
Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

Use the OnClientLoad property to specify a JavaScript function that is executed after the client object of RadRibbonBar is initialized.

A single parameter is passed to the handler, which is the client-side RadRibbonBar object.

Example:
C#
The following example demonstrates how to use the <strong>OnClientLoad</strong>
property.

<p>
    <p>&lt;script language="javascript"&gt;<br />
    function <strong>ClientLoadHandler</strong>(sender)<br />
    {<br />
    // perform actions after the RibbonBar is initialized<br />
    }<br />
    &lt;/script&gt;<br />
        <br />
    &lt;telerik:RadRibbonBar id="RadRibbonBar1" runat="server"
    <strong>OnClientLoad="ClientLoadHandler"</strong>&gt;<br />
    &lt;/telerik:RadRibbonBar&gt;</p>
</p>

Gets or sets a value indicating the client-side event handler that is called when the RibbonBar is maximized. The event is passed the point for conditional cancel of the RibbonBar's maximizing.

C#
[ClientControlEvent]
[ClientPropertyName("maximized")]
public string OnClientMaximized { get; set; }
Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

Gets or sets a value indicating the client-side event handler that is called when the RibbonBar is about to be maximized.The event serves as a point for conditional cancel of the RibbonBar's maximizing.

C#
[ClientControlEvent]
[ClientPropertyName("maximizing")]
public string OnClientMaximizing { get; set; }
Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

Gets or sets a value indicating the client-side event handler that is called after a menu item is clicked. The event is passed the point for conditional cancel of the menu item clicking.

C#
[ClientControlEvent]
[ClientPropertyName("menuItemClicked")]
public string OnClientMenuItemClicked { get; set; }
Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

Use the OnClientMenuItemClicked property to specify a JavaScript function that is executed after a menu item is clicked.

Two parameters are passed to the handler:

  • sender (the client-side RadRibbonBar object);
  • eventArgs with 2 properties:
    • get_item() - the instance of the menu item which is clicked;
    • get_domEvent().
Example:
C#
The following example demonstrates how to use the <strong>OnClientMenuItemClicked</strong>
property.

<p>
    <p>&lt;script language="javascript"&gt;<br />
    function <strong>ClientMenuItemClickedHandler</strong>(sender, args)<br />
    {<br />
        alert("The clicked menu item is:" + args.get_item().get_text());<br />
    }<br />
    &lt;/script&gt;<br />
        <br />
    &lt;telerik:RadRibbonBar id="RadRibbonBar1" runat="server"
    <strong>OnClientMenuItemClicked="ClientMenuItemClickedHandler"</strong>&gt;<br />
    &lt;telerik:RibbonBarTab Text="Tab"&gt;<br />
    &lt;telerik:RibbonBarGroup Text="Group"&gt;<br />
    &lt;Items&gt;<br />
    &lt;telerik:RibbonBarMenu Text="Menu"&gt;<br />
    &lt;Buttons&gt;<br />
    &lt;telerik:RibbonBarMenuItem Text="MenuItem" /&gt;<br />
    &lt;/Buttons&gt;<br />
    &lt;/telerik:RibbonBarMenu&gt;<br />
    &lt;/Items&gt;<br />
    &lt;/telerik:RibbonBarGroup&gt;<br />
    &lt;/telerik:RibbonBarTab&gt;<br />
    &lt;/telerik:RadRibbonBar&gt;</p>
</p>

Gets or sets a value indicating the client-side event handler that is called after a menu item is clicked. The event serves as a point for conditional cancel of the menu item clicking.

C#
[ClientControlEvent]
[ClientPropertyName("menuItemClicking")]
public string OnClientMenuItemClicking { get; set; }
Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

Use the OnClientMenuItemClicking property to specify a JavaScript function that is executed after a menu item is clicked.

Two parameters are passed to the handler:

  • sender (the client-side RadRibbonBar object);
  • eventArgs with 2 properties:
    • get_item() - the instance of the menu item which is clicked;
    • get_domEvent().
Example:
C#
The following example demonstrates how to use the <strong>OnClientMenuItemClicking</strong>
property.

<p>
    <p>&lt;script language="javascript"&gt;<br />
    function <strong>ClientMenuItemClickingHandler</strong>(sender, args)<br />
    {<br />
    if (args.get_item().get_text() == "Unclickable")<br />
        args.set_cancel(true);<br />
    }<br />
    &lt;/script&gt;<br />
        <br />
    &lt;telerik:RadRibbonBar id="RadRibbonBar1" runat="server"
    <strong>OnClientMenuItemClicking="ClientMenuItemClickingHandler"</strong>&gt;<br />
    &lt;telerik:RibbonBarTab Text="Tab"&gt;<br />
    &lt;telerik:RibbonBarGroup Text="Group"&gt;<br />
    &lt;Items&gt;<br />
    &lt;telerik:RibbonBarMenu Text="Menu"&gt;<br />
    &lt;Items&gt;<br />
    &lt;telerik:RibbonBarMenuItem Text="Unclickable" /&gt;<br />
    &lt;/Items&gt;<br />
    &lt;/telerik:RibbonBarMenu&gt;<br />
    &lt;/Items&gt;<br />
    &lt;/telerik:RibbonBarGroup&gt;<br />
    &lt;/telerik:RibbonBarTab&gt;<br />
    &lt;/telerik:RadRibbonBar&gt;</p>
</p>

Gets or sets a value indicating the client-side event handler that is called when the RibbonBar is minimized. The event is passed the point for conditional cancel of the RibbonBar's minimizing.

C#
[ClientControlEvent]
[ClientPropertyName("minimized")]
public string OnClientMinimized { get; set; }
Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

Gets or sets a value indicating the client-side event handler that is called when the RibbonBar is about to be minimized.The event serves as a point for conditional cancel of the RibbonBar's minimizing.

C#
[ClientControlEvent]
[ClientPropertyName("minimizing")]
public string OnClientMinimizing { get; set; }
Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

Gets or sets a value indicating the client-side event handler that is called when the value inside the RibbonBarNumericTextBox is changed. The event is passed the point for conditional cancel of the value's changing.

C#
[ClientControlEvent]
[ClientPropertyName("numericTextBoxValueChanged")]
public string OnClientNumericTextBoxValueChanged { get; set; }
Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

Gets or sets a value indicating the client-side event handler that is called when the value inside the RibbonBarNumericTextBox is about to be changed. The event serves as a point for conditional cancel of the value's changing.

C#
[ClientControlEvent]
[ClientPropertyName("numericTextBoxValueChanging")]
public string OnClientNumericTextBoxValueChanging { get; set; }
Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

Gets or sets a value indicating the client-side event handler that is called after a non-selected tab is clicked. The event is passed the point for conditional cancel of the selecting of new tab (ClientSelectedTabChanging).

C#
[ClientControlEvent]
[ClientPropertyName("selectedTabChanged")]
public string OnClientSelectedTabChanged { get; set; }
Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

Use the OnClientSelectedTabChanged property to specify a JavaScript function that is executed after a non-selected tab is clicked.

Two parameters are passed to the handler:

  • sender (the client-side RadRibbonBar object);
  • eventArgs with 3 properties:
    • get_tab() - the instance of the tab which is the new selected tab;
    • get_previouslySelectedTab() - the instance of the tab which was previously selected;
    • get_domEvent().
Example:
C#
The following example demonstrates how to use the <strong>OnClientSelectedTabChanged</strong>
property.

<p>
    <p>&lt;script language="javascript"&gt;<br />
    function <strong>ClientSelectedTabChangedHandler</strong>(sender, args)<br />
    {<br />
    alert("The new selected tab is: " + args.get_tab().get_text());<br />
    alert("The previously selected tab is: " + args.get_previouslySelected().get_text());<br />
    }<br />
    &lt;/script&gt;<br />
        <br />
    &lt;telerik:RadRibbonBar id="RadRibbonBar1" runat="server"
    <strong>OnClientSelectedTabChanged="ClientSelectedTabChangedHandler"</strong>&gt;<br />
    &lt;telerik:RibbonBarTab Text="DefaultSelected"/&gt;<br />
    &lt;telerik:RibbonBarTab Text="Unselectable"/&gt;<br />
    &lt;/telerik:RadRibbonBar&gt;</p>
</p>

Gets or sets a value indicating the client-side event handler that is called after a non-selected tab is clicked. The event serves as a point for conditional cancel of the selecting of new tab.

C#
[ClientControlEvent]
[ClientPropertyName("selectedTabChanging")]
public string OnClientSelectedTabChanging { get; set; }
Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

Use the OnClientSelectedTabChanging property to specify a JavaScript function that is executed after a non-selected tab is clicked.

Two parameters are passed to the handler:

  • sender (the client-side RadRibbonBar object);
  • eventArgs with 3 properties:
    • get_tab() - the instance of the tab which is just clicked;
    • get_previouslySelectedTab() - the instance of the tab which still is the selected tab (it's cancelable event);
    • get_domEvent().
Example:
C#
The following example demonstrates how to use the <strong>OnClientSelectedTabChanging</strong>
property.

<p>
    <p>&lt;script language="javascript"&gt;<br />
    function <strong>ClientSelectedTabChangingHandler</strong>(sender, args)<br />
    {<br />
    if (args.get_tab().get_text() == "Unselectable")<br />
        args.set_cancel(true);<br />
    else<br />
        alert("The tab about to be selected is: " + arge.get_tab().get_text());<br />
    }<br />
    &lt;/script&gt;<br />
        <br />
    &lt;telerik:RadRibbonBar id="RadRibbonBar1" runat="server"
    <strong>OnClientSelectedTabChanging="ClientSelectedTabChangingHandler"</strong>&gt;<br />
    &lt;telerik:RibbonBarTab Text="DefaultSelected"/&gt;<br />
    &lt;telerik:RibbonBarTab Text="Unselectable"/&gt;<br />
    &lt;/telerik:RadRibbonBar&gt;</p>
</p>

Gets or sets a value indicating the client-side event handler that is called after a button inside of a split button is clicked. The event is passed the point for conditional cancel of the button clicking.

C#
[ClientControlEvent]
[ClientPropertyName("splitButtonClicked")]
public string OnClientSplitButtonClicked { get; set; }
Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

Use the OnClientSplitButtonClicked property to specify a JavaScript function that is executed after a button inside of a split button is clicked.

Two parameters are passed to the handler:

  • sender (the client-side RadRibbonBar object);
  • eventArgs with 2 properties:
    • get_button() - the instance of the button which is clicked;
    • get_domEvent().
Example:
C#
The following example demonstrates how to use the <strong>OnClientSplitButtonClicked</strong>
property.

<p>
    <p>&lt;script language="javascript"&gt;<br />
    function <strong>ClientSplitButtonClickedHandler</strong>(sender, args)<br />
    {<br />
        alert("The clicked button is:" + args.get_button().get_text());<br />
    }<br />
    &lt;/script&gt;<br />
        <br />
    &lt;telerik:RadRibbonBar id="RadRibbonBar1" runat="server"
    <strong>OnClientSplitButtonClicked="ClientSplitButtonClickedHandler"</strong>&gt;<br />
    &lt;telerik:RibbonBarTab Text="Tab"&gt;<br />
    &lt;telerik:RibbonBarGroup Text="Group"&gt;<br />
    &lt;Items&gt;<br />
    &lt;telerik:RibbonBarSplitButton Text="SplitButton"&gt;<br />
    &lt;Buttons&gt;<br />
    &lt;telerik:RibbonBarButton Text="Button" /&gt;<br />
    &lt;/Buttons&gt;<br />
    &lt;/telerik:RibbonBarSplitButton&gt;<br />
    &lt;/Items&gt;<br />
    &lt;/telerik:RibbonBarGroup&gt;<br />
    &lt;/telerik:RibbonBarTab&gt;<br />
    &lt;/telerik:RadRibbonBar&gt;</p>
</p>

Gets or sets a value indicating the client-side event handler that is called after a button inside split button is clicked. The event serves as a point for conditional cancel of the button clicking.

C#
[ClientControlEvent]
[ClientPropertyName("splitButtonClicking")]
public string OnClientSplitButtonClicking { get; set; }
Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

Use the OnClientSplitButtonClicking property to specify a JavaScript function that is executed after a button inside of a split button is clicked.

Two parameters are passed to the handler:

  • sender (the client-side RadRibbonBar object);
  • eventArgs with 2 properties:
    • get_button() - the instance of the button which is clicked;
    • get_domEvent().
Example:
C#
The following example demonstrates how to use the <strong>OnClientSplitButtonClicking</strong>
property.

<p>
    <p>&lt;script language="javascript"&gt;<br />
    function <strong>ClientSplitButtonClickingHandler</strong>(sender, args)<br />
    {<br />
    if (args.get_button().get_text() == "Unclickable")<br />
        args.set_cancel(true);<br />
    }<br />
    &lt;/script&gt;<br />
        <br />
    &lt;telerik:RadRibbonBar id="RadRibbonBar1" runat="server"
    <strong>OnClientSplitButtonClicking="ClientSplitButtonClickingHandler"</strong>&gt;<br />
    &lt;telerik:RibbonBarTab Text="Tab"&gt;<br />
    &lt;telerik:RibbonBarGroup Text="Group"&gt;<br />
    &lt;Items&gt;<br />
    &lt;telerik:RibbonBarSplitButton Text="SplitButton"&gt;<br />
    &lt;Buttons&gt;<br />
    &lt;telerik:RibbonBarButton Text="Unclickable" /&gt;<br />
    &lt;/Buttons&gt;<br />
    &lt;/telerik:RibbonBarSplitButton&gt;<br />
    &lt;/Items&gt;<br />
    &lt;/telerik:RibbonBarGroup&gt;<br />
    &lt;/telerik:RibbonBarTab&gt;<br />
    &lt;/telerik:RadRibbonBar&gt;</p>
</p>

Gets or sets a value indicating the client-side event handler that is called after a toggle button inside of ToggleList is clicked. The event is passed the point for conditional cancel of the toggle list's toggle-state change.

C#
[ClientControlEvent]
[ClientPropertyName("toggleListToggled")]
public string OnClientToggleListToggled { get; set; }
Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

Use the OnClientToggleListToggled property to specify a JavaScript function that is executed after a toggle button inside of a ToggleList is clicked.

Two parameters are passed to the handler:

  • sender (the client-side RadRibbonBar object);
  • eventArgs with 2 properties:
    • get_button() - the instance of the toggle button which is clicked;
    • get_domEvent().
Example:
C#
The following example demonstrates how to use the <strong>OnClientToggleListToggled</strong>
property.

<p>
    <p>&lt;script language="javascript"&gt;<br />
    function <strong>ClientToggleListToggledHandler</strong>(sender, args)<br />
    {<br />
    alert("Toggled button is: " + args.get_button().get_text()<br />
    }<br />
    &lt;/script&gt;<br />
        <br />
    &lt;telerik:RadRibbonBar id="RadRibbonBar1" runat="server"
    <strong>OnClientToggleListToggled="ClientToggleListToggledHandler"</strong>&gt;<br />
    &lt;telerik:RibbonBarTab Text="Tab"&gt;<br />
    &lt;telerik:RibbonBarGroup Text="Group"&gt;<br />
    &lt;Items&gt;<br />
    &lt;telerik:RibbonBarToggleList&gt;<br />
    &lt;ToggleButtons&gt;<br />
    &lt;telerik:RibbonBarToggleButton Text="ToggleButton" /&gt;<br />
    &lt;/ToggleButtons&gt;<br />
    &lt;/telerik:RibbonBarToggleList&gt;<br />
    &lt;/Items&gt;<br />
    &lt;/telerik:RibbonBarGroup&gt;<br />
    &lt;/telerik:RibbonBarTab&gt;<br />
    &lt;/telerik:RadRibbonBar&gt;</p>
</p>

Gets or sets a value indicating the client-side event handler that is called after a toggle button inside of ToggleList is clicked. The event serves as a point for conditional cancel of the toggle list's toggle-state change.

C#
[ClientControlEvent]
[ClientPropertyName("toggleListToggling")]
public string OnClientToggleListToggling { get; set; }
Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

Use the OnClientToggleListToggling property to specify a JavaScript function that is executed after a toggle button inside of a ToggleList is clicked.

Two parameters are passed to the handler:

  • sender (the client-side RadRibbonBar object);
  • eventArgs with 2 properties:
    • get_button() - the instance of the toggle button which is clicked;
    • get_domEvent().
Example:
C#
The following example demonstrates how to use the <strong>OnClientToggleListToggling</strong>
property.

<p>
    <p>&lt;script language="javascript"&gt;<br />
    function <strong>ClientToggleListTogglingHandler</strong>(sender, args)<br />
    {<br />
    if (args.get_button().get_text() == "Untogglable")<br />
        args.set_cancel(true);<br />
    }<br />
    &lt;/script&gt;<br />
        <br />
    &lt;telerik:RadRibbonBar id="RadRibbonBar1" runat="server"
    <strong>OnClientToggleListToggling="ClientToggleListTogglingHandler"</strong>&gt;<br />
    &lt;telerik:RibbonBarTab Text="Tab"&gt;<br />
    &lt;telerik:RibbonBarGroup Text="Group"&gt;<br />
    &lt;Items&gt;<br />
    &lt;telerik:RibbonBarToggleList&gt;<br />
    &lt;ToggleButtons&gt;<br />
    &lt;telerik:RibbonBarToggleButton Text="Untogglable" /&gt;<br />
    &lt;/ToggleButtons&gt;<br />
    &lt;/telerik:RibbonBarToggleList&gt;<br />
    &lt;/Items&gt;<br />
    &lt;/telerik:RibbonBarGroup&gt;<br />
    &lt;/telerik:RibbonBarTab&gt;<br />
    &lt;/telerik:RadRibbonBar&gt;</p>
</p>
C#
protected override IRenderer Renderer { get; }

Overrides: RadWebControl.Renderer

C#
public bool RenderInactiveContextualTabGroups { get; set; }

Gets or sets the index of the selected tab.

C#
public int SelectedTabIndex { get; set; }
Property Value:

The zero based index of the selected tab. The default value is -1 (empty Tabs collection).

Use the SelectedTabIndex property to programmatically specify the selected tab in RadRibbonBar.

Example:
cs-api-definition
void Page_Load(object sender, EventArgs e)
{
if (!Page.IsPostBack)
{
var tab1 = new RibbonBarTab(){ Text="GraphicTools" }; // this will be selected tab
RadRibbonBar1.Tabs.Add(tab1);

var tab2 = new RibbonBarTab(){ Text="TextTools" };
RadRibbonBar1.Tabs.Add(tab2);

RadRibbonBar1.SelectedIndex = 1; // will select "TextTools" tab
}
}
C#
protected override bool SupportsRenderingMode { get; }

Overrides: RadWebControl.SupportsRenderingMode

Gets a RibbonBarTabCollection object that contains the tabs of the RibbonBar.

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

A RibbonBarTabCollection that contains the tabs of the RibbonBar. By default the collection is empty (RibbonBar has no tabs).

Use the Tabs property to access the tabs of RadRibbonBar. You can also use the Tabs property to manage the tabs. You can add, remove or modify tabs from the Tabs collection.

Example:
cs-api-definition
RadRibbonBar1.Tabs[0].Text = "Example";
C#
protected override HtmlTextWriterTag TagKey { get; }

Overrides: WebControl.TagKey

C#
[ClientControlProperty]
[ClientPropertyName("_uniqueId")]
public override string UniqueID { get; }

Overrides: Control.UniqueID

Methods

C#
protected override IRenderer CreateControlRenderer()
Returns:

IRenderer

Overrides: RadWebControl.CreateControlRenderer()

C#
protected override void DescribeComponent(IScriptDescriptor descriptor)
Parameters:descriptorIScriptDescriptor

Overrides: RadWebControl.DescribeComponent(IScriptDescriptor)

Searches the RadRibbonBar control 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 RadRibbonBar control 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 RadRibbonBar control 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 RadRibbonBar control for the first RibbonBarTab which Value property is equal to the specified value.

C#
public RibbonBarTab FindTabByValue(string value)
Parameters:valuestring

The Value to search for.

Returns:

RibbonBarTab

A RibbonBarTab whose Value property is equal to the specifed value. If a tab is not found, null (Nothing in Visual Basic) is returned.

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

Gets an XML string representing the state of the control. All child items and their properties are serialized in this string.

C#
public string GetXml()
Returns:

string

A String representing the state of the control - child items, properties etc.

Use the GetXml method to get the XML state of the control. You can cache it and then restore it using the LoadXml(string) method.

C#
protected virtual void GetXml(XmlSerializer serializer, TextWriter output)
Parameters:serializerXmlSerializeroutputTextWriter

Populates the control from the specified XML file.

C#
public void LoadContentFile(string xmlFileName)
Parameters:xmlFileNamestring

The name of the XML file.

Loads the posted content of the list control, if it is different from the last posting.

C#
protected override bool LoadPostData(string postDataKey, NameValueCollection postCollection)
Parameters:postDataKeystring

The key identifier for the control, used to index the postCollection.

postCollectionNameValueCollection

A NameValueCollection that contains value information indexed by control identifiers.

Returns:

bool

true if the posted content is different from the last posting; otherwise, false.

Overrides: RadWebControl.LoadPostData(string, NameValueCollection)

C#
protected override void LoadViewState(object savedState)
Parameters:savedStateobject

Overrides: WebControl.LoadViewState(object)

C#
protected void LoadXml(RadRibbonBar deserialized)
Parameters:deserializedRadRibbonBar

Loads the control from an XML string.

C#
public void LoadXml(string xml)
Parameters:xmlstring

The string representing the XML from which the control will be populated.

Use the LoadXml method to populate the control from an XML string. You can use it along the GetXml() method to implement caching.

Raises the ApplicationMenuItemClick event.

C#
protected virtual void OnApplicationMenuItemClick(RibbonBarApplicationMenuItemClickEventArgs e)
Parameters:eRibbonBarApplicationMenuItemClickEventArgs

The RibbonBarApplicationMenuItemClickEventArgs instance containing the event data.

Raises the ButtonClick event.

C#
protected virtual void OnButtonClick(RibbonBarButtonClickEventArgs e)
Parameters:eRibbonBarButtonClickEventArgs

The RibbonBarButtonClickEventArgs instance containing the event data.

Raises the ButtonToggle event.

C#
protected virtual void OnButtonToggle(RibbonBarButtonToggleEventArgs e)
Parameters:eRibbonBarButtonToggleEventArgs

The RibbonBarButtonToggleEventArgs instance containing the event data.

Raises the ColorPickerColorChanged event.

C#
protected virtual void OnColorPickerColorChanged(RibbonBarColorPickerColorChangedEventArgs e)
Parameters:eRibbonBarColorPickerColorChangedEventArgs

The RibbonBarColorPickerColorChangedEventArgs instance containing the event data.

C#
protected virtual void OnComboBoxSelectedIndexChanged(RibbonBarComboBoxSelectedIndexChangedEventArgs e)
Parameters:eRibbonBarComboBoxSelectedIndexChangedEventArgs

The RibbonBarComboBoxSelectedIndexChangedEventArgs instance containing the event data.

Raises the ComboBoxTextChanged event.

C#
protected virtual void OnComboBoxTextChanged(RibbonBarComboBoxTextChangedEventArgs e)
Parameters:eRibbonBarComboBoxTextChangedEventArgs

The RibbonBarComboBoxTextChangedEventArgs instance containing the event data.

Raises the Command event.

C#
protected virtual void OnCommand(object sender, CommandEventArgs e)
Parameters:senderobject

The IRibbonBarCommandItem instance that triggered the event.

eCommandEventArgs

The CommandEventArgs instance containing the event data.

C#
protected virtual void OnDropDownSelectedIndexChanged(RibbonBarDropDownSelectedIndexChangedEventArgs e)
Parameters:eRibbonBarDropDownSelectedIndexChangedEventArgs

The RibbonBarDropDownSelectedIndexChangedEventArgs instance containing the event data.

Raises the GalleryCommand event.

C#
protected virtual void OnGalleryCommand(RibbonBarGalleryCommandEventArgs e)
Parameters:eRibbonBarGalleryCommandEventArgs

The RibbonBarGalleryCommandEventArgs instance containing the event data.

Raises the LauncherClick event.

C#
protected virtual void OnLauncherClick(RibbonBarLauncherClickEventArgs e)
Parameters:eRibbonBarLauncherClickEventArgs

The RibbonBarLauncherClickEventArgs instance containing the event data.

Raises the MenuItemClick event.

C#
protected virtual void OnMenuItemClick(RibbonBarMenuItemClickEventArgs e)
Parameters:eRibbonBarMenuItemClickEventArgs

The RibbonBarMenuItemClickEventArgs instance containing the event data.

Raises the NumericTextBoxValueChanged event.

C#
protected virtual void OnNumericTextBoxValueChanged(RibbonBarNumericTextBoxValueChangedEventArgs e)
Parameters:eRibbonBarNumericTextBoxValueChangedEventArgs

The RibbonBarNumericTextBoxValueChangedEventArgs instance containing the event data.

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

Overrides: RadWebControl.OnPreRender(EventArgs)

Raises the SelectedTabChange event.

C#
protected virtual void OnSelectedTabChange(RibbonBarSelectedTabChangeEventArgs e)
Parameters:eRibbonBarSelectedTabChangeEventArgs

The RibbonBarSelectedTabChangeEventArgs instance containing the event data.

Raises the SplitButtonClick event.

C#
protected virtual void OnSplitButtonClick(RibbonBarSplitButtonClickEventArgs e)
Parameters:eRibbonBarSplitButtonClickEventArgs

The RibbonBarButtonClickEventArgs instance containing the event data.

Raises the ToggleListToggle event.

C#
protected virtual void OnToggleListToggle(RibbonBarToggleListToggleEventArgs e)
Parameters:eRibbonBarToggleListToggleEventArgs

The RibbonBarToggleListToggleEventArgs instance containing the event data.

C#
[SuppressMessage("Microsoft.Performance", "CA1800:DoNotCastUnnecessarily")]
protected virtual void RaisePostBackEvent(string eventArgument)
Parameters:eventArgumentstring
C#
public void ReadXml(XmlReader reader)
Parameters:readerXmlReader
C#
protected virtual void ReadXmlForContents(XmlReader reader)
Parameters:readerXmlReader
C#
protected override void RenderContents(HtmlTextWriter writer)
Parameters:writerHtmlTextWriter

Overrides: RadWebControl.RenderContents(HtmlTextWriter)

C#
protected override object SaveViewState()
Returns:

object

Overrides: WebControl.SaveViewState()

C#
protected override void TrackViewState()

Overrides: WebControl.TrackViewState()

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

Events

Occurs (server-side) after an item of the ApplicationMenu is clicked.

C#
public event RibbonBarApplicationMenuItemClickEventHandler ApplicationMenuItemClick
Example:
cs-api-definition
protected void RadRibbonBar1_ApplicationMenuItemClick(object sender, RibbonBarApplicationMenuItemClickEventArgs e)
{
string message = string.Format("Application menu item {0} was clicked.", e.Item.Text);

textBox1.Text = message;
}

Occurs (server-side) after a button is clicked.

C#
public event RibbonBarButtonClickEventHandler ButtonClick
Example:
cs-api-definition
protected void RadRibbonBar1_ButtonClick(object sender, RibbonBarButtonClickEventArgs e)
{
string message = string.Format("Button {0} was clicked.", e.Button.Text);
string details = string.Format("Group: {0}, Index: {1}", e.Group.Text, e.Index);

textBox1.Text = string.Format("{0} {1}", message, details);
}

Occurs (server-side) after a toggle button is clicked.

C#
public event RibbonBarButtonToggleEventHandler ButtonToggle
Example:
cs-api-definition
protected void RadRibbonBar1_ButtonToggle(object sender, RibbonBarButtonToggleEventArgs e)
{
string message = string.Format("ToggleButton {0} was toggled.", e.Button.Text);
string details = string.Format("Group: {0}, Index: {1}", e.Group.Text, e.Index);

textBox1.Text = string.Format("{0} {1}", message, details);
}
C#
public event RibbonBarColorPickerColorChangedEventHandler ColorPickerColorChanged

Occurs (server-side) after a ComboBox item is selected.

C#
public event RibbonBarComboBoxSelectedIndexChangedEventHandler ComboBoxSelectedIndexChanged

Occurs (server-side) after the text of the ComboBox is changed.

C#
public event RibbonBarComboBoxTextChangedEventHandler ComboBoxTextChanged

Occurs (server-side) after an item is clicked.

C#
public event CommandEventHandler Command

Occurs (server-side) after a DropDown item is selected.

C#
public event RibbonBarDropDownSelectedIndexChangedEventHandler DropDownSelectedIndexChanged
C#
public event RibbonBarGalleryCommandEventHandler GalleryCommand

Occurs (server-side) after a group launcher is clicked.

C#
public event RibbonBarLauncherClickEventHandler LauncherClick
Example:
cs-api-definition
protected void RadRibbonBar1_LauncherClick(object sender, RibbonBarLauncherClickEventArgs e)
{
string message = string.Format("Launcher of group {0} was clicked.", e.Group.Text);

textBox1.Text = message;
}

Occurs (server-side) after a menu item inside RibbonBarMenu is clicked.

C#
public event RibbonBarMenuItemClickEventHandler MenuItemClick
Example:
cs-api-definition
protected void RadRibbonBar1_MenuItemClick(object sender, RibbonBarMenuItemClickEventArgs e)
{
string message = string.Format("Item {0} was clicked.", e.Item.Text);
string details = string.Format("Group: {0}, Index: {1}", e.Group.Text, e.Index);

textBox1.Text = string.Format("{0} {1}", message, details);
}
C#
public event RibbonBarNumericTextBoxValueChangedEventHandler NumericTextBoxValueChanged

Occurs (server-side) after a non-selected tab is clicked.

C#
public event RibbonBarSelectedTabChangeEventHandler SelectedTabChange
Example:
cs-api-definition
protected void RadRibbonBar1_SelectedTabChange(object sender, RibbonBarSelectedTabChangeEventArgs e)
{
string message = string.Format("Tab {0} was selected.", e.Tab.Text);
string details = string.Format("Previosly selected tab was: {0}", e.PreviouslySelectedTab.Text);

textBox1.Text = string.Format("{0} {1}", message, details);
}

Occurs (server-side) after a split button or button inside of it is clicked.

C#
public event RibbonBarSplitButtonClickEventHandler SplitButtonClick
Example:
cs-api-definition
protected void RadRibbonBar1_SplitButtonClick(object sender, RibbonBarSplitButtonClickEventArgs e)
{
string message = string.Format("Button {0} was clicked.", e.Button.Text);
string details = string.Format("Group: {0}, Index: {1}", e.Group.Text, e.Index);

textBox1.Text = string.Format("{0} {1}", message, details);
}

Occurs (server-side) after a toggle button inside RibbonBarToggleList is clicked.

C#
public event RibbonBarToggleListToggleEventHandler ToggleListToggle
Example:
cs-api-definition
protected void RadRibbonBar1_ToggleListToggle(object sender, RibbonBarToggleListToggleEventArgs e)
{
string message = string.Format("ToggleList's ToggleButton {0} was toggled.", e.ToggleButton.Text);
string details = string.Format("Group: {0}, Index: {1}", e.Group.Text, e.Index);

textBox1.Text = string.Format("{0} {1}", message, details);
}
In this article
DefinitionConstructorsRadRibbonBar()PropertiesApplicationMenuApplicationMenuIDContextualTabGroupsCssClassFormatStringEnableAutoArrangeEnableMinimizingEnableQuickAccessToolbarIDImageRenderingModeKeyboardNavigationSettingsMinimizedOnClientApplicationMenuItemClickedOnClientApplicationMenuItemClickingOnClientButtonClickedOnClientButtonClickingOnClientButtonToggledOnClientButtonTogglingOnClientColorPickerColorChangedOnClientColorPickerColorChangingOnClientComboBoxSelectedIndexChangedOnClientComboBoxSelectedIndexChangingOnClientComboBoxTextChangedOnClientDropDownSelectedIndexChangedOnClientDropDownSelectedIndexChangingOnClientGalleryCommandOnClientGalleryCommandPreviewOnClientGalleryCommandPreviewEndOnClientLauncherClickedOnClientLauncherClickingOnClientLoadOnClientMaximizedOnClientMaximizingOnClientMenuItemClickedOnClientMenuItemClickingOnClientMinimizedOnClientMinimizingOnClientNumericTextBoxValueChangedOnClientNumericTextBoxValueChangingOnClientSelectedTabChangedOnClientSelectedTabChangingOnClientSplitButtonClickedOnClientSplitButtonClickingOnClientToggleListToggledOnClientToggleListTogglingRendererRenderInactiveContextualTabGroupsSelectedTabIndexSupportsRenderingModeTabsTagKeyUniqueIDMethodsCreateControlRenderer()DescribeComponent(IScriptDescriptor)FindButtonByValue(string)FindGroupByValue(string)FindMenuItemByValue(string)FindTabByValue(string)FindToggleButtonByValue(string)GetXml()GetXml(XmlSerializer, TextWriter)LoadContentFile(string)LoadPostData(string, NameValueCollection)LoadViewState(object)LoadXml(RadRibbonBar)LoadXml(string)OnApplicationMenuItemClick(RibbonBarApplicationMenuItemClickEventArgs)OnButtonClick(RibbonBarButtonClickEventArgs)OnButtonToggle(RibbonBarButtonToggleEventArgs)OnColorPickerColorChanged(RibbonBarColorPickerColorChangedEventArgs)OnComboBoxSelectedIndexChanged(RibbonBarComboBoxSelectedIndexChangedEventArgs)OnComboBoxTextChanged(RibbonBarComboBoxTextChangedEventArgs)OnCommand(object, CommandEventArgs)OnDropDownSelectedIndexChanged(RibbonBarDropDownSelectedIndexChangedEventArgs)OnGalleryCommand(RibbonBarGalleryCommandEventArgs)OnLauncherClick(RibbonBarLauncherClickEventArgs)OnMenuItemClick(RibbonBarMenuItemClickEventArgs)OnNumericTextBoxValueChanged(RibbonBarNumericTextBoxValueChangedEventArgs)OnPreRender(EventArgs)OnSelectedTabChange(RibbonBarSelectedTabChangeEventArgs)OnSplitButtonClick(RibbonBarSplitButtonClickEventArgs)OnToggleListToggle(RibbonBarToggleListToggleEventArgs)RaisePostBackEvent(string)ReadXml(XmlReader)ReadXmlForContents(XmlReader)RenderContents(HtmlTextWriter)SaveViewState()TrackViewState()WriteXml(XmlWriter)WriteXmlForContents(XmlWriter)EventsApplicationMenuItemClickButtonClickButtonToggleColorPickerColorChangedComboBoxSelectedIndexChangedComboBoxTextChangedCommandDropDownSelectedIndexChangedGalleryCommandLauncherClickMenuItemClickNumericTextBoxValueChangedSelectedTabChangeSplitButtonClickToggleListToggle
Not finding the help you need?
Contact Support