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.

Constructors

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

Top

Properties

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

Top

Methods

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

Top

Events

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

Top

Explicit interface implementations

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

Top

See also

Reference

Ribbon class

Microsoft.Web.CommandUI namespace