Share via

Ribbon members

Renders the Server ribbon on a page.
Do not use types or members of the Microsoft.Web.CommandUI namespace for development within a SharePoint environment, but instead use SPRibbon and related types in the Microsoft.SharePoint.WebControls namespace. For information about customizing the ribbon in SharePoint Foundation see The Ribbon in SharePoint Foundation.

The Ribbon type exposes the following members.


  Name Description
Public method Ribbon Initializes a new instance of the Ribbon class.



  Name Description
Public property AccessKey (Inherited from WebControl.)
Public property ActiveTabId Gets the Server ribbon tab that was open prior to page postback.
Protected property Adapter (Inherited from Control.)
Public property AlwaysShowTabTitleTooltips Determines whether tab title tooltips should be shown always or only when the tab title is scaled down to the point that the title is illegible.
Public property AppRelativeTemplateSourceDirectory (Inherited from Control.)
Public property Attributes (Inherited from WebControl.)
Public property BackColor (Inherited from WebControl.)
Public property BindingContainer (Inherited from Control.)
Public property BorderColor (Inherited from WebControl.)
Public property BorderStyle (Inherited from WebControl.)
Public property BorderWidth (Inherited from WebControl.)
Public property CheckForInitializationReadiness Gets or sets the value that specifies if the Server ribbon waits to allow tabs to be opened.
Protected property ChildControlsCreated (Inherited from Control.)
Public property ClientID (Inherited from Control.)
Public property ClientIDMode (Inherited from Control.)
Protected property ClientIDSeparator (Inherited from Control.)
Protected property CommandUIDefinitions This object, member, or enumeration is deprecated and is not intended to be used in your code.
Public property CommandUIVisible Gets or sets a value that indicates whether the Server ribbon is visible.
Protected property Context (Inherited from Control.)
Public property Controls (Inherited from Control.)
Public property ControlStyle (Inherited from WebControl.)
Public property ControlStyleCreated (Inherited from WebControl.)
Public property CssClass (Inherited from WebControl.)
Public property DataItemContainer (Inherited from Control.)
Public property DataKeysContainer (Inherited from Control.)
Protected property DataSource Gets or sets the data source for the Server ribbon.
Public property DataUrl Gets or sets the URL that the Server ribbon will use to retrieve data from the server.
Public property DataVersion Gets or sets the version of the server data.
Protected property DesignMode (Inherited from Control.)
Protected property DisabledVisibilityContexts Gets the visibility contexts that have been disabled during page rendering.
Protected property EmbedJavascriptInHTML Embed all javascript in the output HTML or embed calls to functions in js files.
Public property Enabled (Inherited from WebControl.)
Protected property EnabledVisibilityContexts Gets the visibility contexts that have been enabled during page rendering.
Public property EnableTheming (Inherited from WebControl.)
Public property EnableViewState (Inherited from Control.)
Protected property Events (Inherited from Control.)
Public property FixedPositioningEnabled Gets or sets whether the Server ribbon uses a fixed position.
Public property Font (Inherited from WebControl.)
Public property ForeColor (Inherited from WebControl.)
Public property HasAttributes (Inherited from WebControl.)
Public property HasAvailableTabs Gets whether there are tabs available on the Server ribbon or not.
Protected property HasChildViewState (Inherited from Control.)
Protected property HeaderScalingEnabled Gets or sets whether the Server ribbon has scaling turned on for the tab headers.
Protected property HeaderScalingScript Gets the header scaling .
Public property Height (Inherited from WebControl.)
Public property ID (Inherited from Control.)
Protected property IdSeparator (Inherited from Control.)
Public property IncludeHeaderScalingScript Gets or sets if the HeaderScalingScript is included in the page.
Protected property InitializationScript Gets the script that is used for initializing the Server ribbon when it is minimized.
Protected property InitializationStartScript Gets the script that is used to start Server ribbon initialization and attach a server-rendered ribbon.
Public property InitialTabId Gets or sets the identifier of the tab that is displayed as selected when the Server ribbon is rendered.
Protected property IsChildControlStateCleared (Inherited from Control.)
Protected property IsCompatibilityMode
Protected property IsEnabled (Inherited from WebControl.)
Protected property IsTrackingViewState (Inherited from Control.)
Protected property IsViewStateEnabled (Inherited from Control.)
Protected property LoadViewStateByID (Inherited from Control.)
Public property Minimized Gets or sets whether the Server ribbon is minimized or not.
Public property NamingContainer (Inherited from Control.)
Public property Page (Inherited from Control.)
Public property Parent (Inherited from Control.)
Public property PlaceholderElementId Gets or sets the element identifier of the Server ribbon control.
Public property RenderingCompatibility (Inherited from Control.)
Protected property RootBuildClientScript Gets an string that builds the root of the Server ribbon.
Public property ServerRendered Gets or sets a Boolean value that indicates whether this Server ribbon was rendered on the server.
Public property ServerRenderedScalingIndex Gets or sets the server rendered scaling index.
Protected property ShortcutKeyBindings Gets or sets the key binding that jumps to the initial tab.
Public property ShowJewelId Gets or sets the identifier of the Jewel.
Public property ShowQATId Gets or sets the identifier of the Quick Access Toolbar (QAT).
Public property Site (Inherited from Control.)
Public property SkinID (Inherited from WebControl.)
Public property Style (Inherited from WebControl.)
Public property SupportsDisabledAttribute (Inherited from WebControl.)
Public property TabIndex (Inherited from WebControl.)
Protected property TagKey (Inherited from WebControl.)
Protected property TagName (Inherited from WebControl.)
Public property TemplateControl (Inherited from Control.)
Public property TemplateSourceDirectory (Inherited from Control.)
Public property ToolTip (Inherited from WebControl.)
Public property UniqueID (Inherited from Control.)
Protected property ValidateServerRendering This object, member, or enumeration is deprecated and is not intended to be used in your code.
Protected property ViewState (Inherited from Control.)
Protected property ViewStateIgnoresCase (Inherited from Control.)
Public property ViewStateMode (Inherited from Control.)
Public property Visible (Inherited from Control.)
Public property Width (Inherited from WebControl.)



  Name Description
Protected method AddAttributesToRender (Inherited from WebControl.)
Protected method AddedControl (Inherited from Control.)
Protected method AddParsedSubObject (Inherited from Control.)
Public method ApplyStyle (Inherited from WebControl.)
Public method ApplyStyleSheetSkin (Inherited from Control.)
Protected method BuildProfileTree (Inherited from Control.)
Protected method ClearCachedClientID (Inherited from Control.)
Protected method ClearChildControlState (Inherited from Control.)
Protected method ClearChildState (Inherited from Control.)
Protected method ClearChildViewState (Inherited from Control.)
Protected method ClearEffectiveClientIDMode (Inherited from Control.)
Public method CopyBaseAttributes (Inherited from WebControl.)
Protected method CreateChildControls (Inherited from Control.)
Protected method CreateControlCollection (Inherited from Control.)
Protected method CreateControlStyle (Inherited from WebControl.)
Public method DataBind() (Inherited from Control.)
Protected method DataBind(Boolean) (Inherited from Control.)
Protected method DataBindChildren (Inherited from Control.)
Public method DisableVisibilityContext Disables the specified visibility context.
Public method Dispose (Inherited from Control.)
Public method EnableVisibilityContext Enables the specified visibility context.
Protected method EnsureChildControls (Inherited from Control.)
Protected method EnsureID (Inherited from Control.)
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method FindControl(String) (Inherited from Control.)
Protected method FindControl(String, Int32) (Inherited from Control.)
Public method Focus (Inherited from Control.)
Protected method GetDesignModeState (Inherited from Control.)
Public method GetHashCode (Inherited from Object.)
Protected method GetPeripheralDataForSection Returns the data that is contained within a peripheral content section.
Public method GetRouteUrl(Object) (Inherited from Control.)
Public method GetRouteUrl(RouteValueDictionary) (Inherited from Control.)
Public method GetRouteUrl(String, Object) (Inherited from Control.)
Public method GetRouteUrl(String, RouteValueDictionary) (Inherited from Control.)
Public method GetType (Inherited from Object.)
Public method GetUniqueIDRelativeTo (Inherited from Control.)
Public method HasControls (Inherited from Control.)
Protected method HasEvents (Inherited from Control.)
Protected method IsLiteralContent (Inherited from Control.)
Public method IsTabAvailable Specifies whether a tab is available or not.
Protected method LoadControlState (Inherited from Control.)
Public method LoadPostData Sets the ActiveTabId if it is within the collection.
Protected method LoadViewState (Inherited from WebControl.)
Public method MakeContextualGroupInitiallyVisible Makes the contextual group that the tab belongs to visible with the same visibility context as the tab was initialized with.
Public method MakeTabAvailable(String) Adds the specified tab to the list of available tabs based on the specified tab identifier.
Public method MakeTabAvailable(String, String) Adds the specified tab to the list of available tabs based on the specified tab identifier and the visibility context.
Protected method MapPathSecure (Inherited from Control.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method MergeDataExtensionsIntoDataSourceResult Merges the Server ribbon customizations with the results of the query against the data source.
Public method MergeStyle (Inherited from WebControl.)
Public method NormalizeContextualGroup Assigns default values to tabs contained within this contextual group.
Protected method OnBubbleEvent (Inherited from Control.)
Protected method OnDataBinding (Inherited from Control.)
Protected method OnInit Raises the Init() event. (Overrides Control.OnInit(EventArgs).)
Protected method OnLoad (Inherited from Control.)
Protected method OnPreRender (Inherited from Control.)
Protected method OnUnload (Inherited from Control.)
Protected method OpenFile (Inherited from Control.)
Protected method RaiseBubbleEvent (Inherited from Control.)
Public method RaisePostDataChangedEvent Handles the RaisePostDataChangedEvent() method.
Public method RegisterDataExtension Registers a data extension for the Server ribbon.
Protected method RemovedControl (Inherited from Control.)
Protected method Render Renders the Server ribbon in HTML to the current page. (Overrides WebControl.Render(HtmlTextWriter).)
Public method RenderBeginTag (Inherited from WebControl.)
Protected method RenderChildren (Inherited from Control.)
Protected method RenderContents (Inherited from WebControl.)
Public method RenderControl(HtmlTextWriter) (Inherited from Control.)
Protected method RenderControl(HtmlTextWriter, ControlAdapter) (Inherited from Control.)
Public method RenderEndTag (Inherited from WebControl.)
Protected method ResolveAdapter (Inherited from Control.)
Public method ResolveClientUrl (Inherited from Control.)
Public method ResolveUrl (Inherited from Control.)
Protected method SaveControlState (Inherited from Control.)
Protected method SaveViewState (Inherited from WebControl.)
Protected method SetDesignModeState (Inherited from Control.)
Public method SetInitialTabId An update method that sets the identifier of the tab that will be selected when the page is rendered.
Public method SetRenderMethodDelegate (Inherited from Control.)
Public method ToString (Inherited from Object.)
Protected method TrackViewState (Inherited from WebControl.)
Public method TrimById(String) Locates a tab by its string identifier and trims it for the current page.
Public method TrimById(String, String) Locates a tab by identifier and visibility context and trims it for the current page.
Protected method WriteInitializationScript Outputs the InitializationScript on the page and starts the initialization.
Protected method WritePeripheralDiv Outputs the peripheral content sections to the page.



  Name Description
Public event DataBinding (Inherited from Control.)
Public event Disposed (Inherited from Control.)
Public event Init (Inherited from Control.)
Public event Load (Inherited from Control.)
Public event PreRender (Inherited from Control.)
Public event Unload (Inherited from Control.)


Explicit interface implementations

  Name Description
Explicit interface implemetationPrivate method IParserAccessor.AddParsedSubObject (Inherited from Control.)
Explicit interface implemetationPrivate property IControlBuilderAccessor.ControlBuilder (Inherited from Control.)
Explicit interface implemetationPrivate property IDataBindingsAccessor.DataBindings (Inherited from Control.)
Explicit interface implemetationPrivate property IExpressionsAccessor.Expressions (Inherited from Control.)
Explicit interface implemetationPrivate method IAttributeAccessor.GetAttribute (Inherited from WebControl.)
Explicit interface implemetationPrivate method IControlDesignerAccessor.GetDesignModeState (Inherited from Control.)
Explicit interface implemetationPrivate property IDataBindingsAccessor.HasDataBindings (Inherited from Control.)
Explicit interface implemetationPrivate property IExpressionsAccessor.HasExpressions (Inherited from Control.)
Explicit interface implemetationPrivate method IAttributeAccessor.SetAttribute (Inherited from WebControl.)
Explicit interface implemetationPrivate method IControlDesignerAccessor.SetDesignModeState (Inherited from Control.)
Explicit interface implemetationPrivate method IControlDesignerAccessor.SetOwnerControl (Inherited from Control.)
Explicit interface implemetationPrivate property IControlDesignerAccessor.UserData (Inherited from Control.)


See also


Ribbon class

Microsoft.Web.CommandUI namespace