SPRibbon members

Represents a ribbon control on a page.

The SPRibbon type exposes the following members.

Constructors

	Name	Description
	SPRibbon	Initializes a new SPRibbon class object.

Top

Properties

	Name	Description
	AccessKey	(Inherited from WebControl.)
	ActiveTabId	Gets the Server ribbon tab that was open prior to page postback. (Inherited from Ribbon.)
	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. (Inherited from Ribbon.)
	ApplyPermissionsToRibbonOnly
	AppRelativeTemplateSourceDirectory	(Inherited from Control.)
	Attributes	(Inherited from WebControl.)
	AuthenticationRestrictions
	BackColor	(Inherited from WebControl.)
	BindingContainer	(Inherited from Control.)
	BorderColor	(Inherited from WebControl.)
	BorderStyle	(Inherited from WebControl.)
	BorderWidth	(Inherited from WebControl.)
	CheckForInitializationReadiness	(Overrides Ribbon.CheckForInitializationReadiness.)
	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. (Inherited from Ribbon.)
	CommandUIVisible	(Overrides Ribbon.CommandUIVisible.)
	Context	(Inherited from Control.)
	Controls	(Inherited from Control.)
	ControlStyle	(Inherited from WebControl.)
	ControlStyleCreated	(Inherited from WebControl.)
	CssClass	(Inherited from WebControl.)
	CssFile	Gets or sets a .css file to register.
	DataItemContainer	(Inherited from Control.)
	DataKeysContainer	(Inherited from Control.)
	DataSource	Gets or sets the data source for the Server ribbon. (Inherited from Ribbon.)
	DataUrl	Gets or sets the URL that the Server ribbon will use to retrieve data from the server. (Inherited from Ribbon.)
	DataVersion	Gets or sets the version of the server data. (Inherited from Ribbon.)
	DesignMode	(Inherited from Control.)
	DisabledVisibilityContexts	Gets the visibility contexts that have been disabled during page rendering. (Inherited from Ribbon.)
	EmbedJavascriptInHTML	Embed all javascript in the output HTML or embed calls to functions in js files. (Inherited from Ribbon.)
	Enabled	(Inherited from WebControl.)
	EnabledVisibilityContexts	Gets the visibility contexts that have been enabled during page rendering. (Inherited from Ribbon.)
	EnableTheming	(Inherited from WebControl.)
	EnableViewState	(Inherited from Control.)
	Events	(Inherited from Control.)
	FixedPositioningEnabled	Gets or sets whether the Server ribbon uses a fixed position. (Inherited from Ribbon.)
	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. (Inherited from Ribbon.)
	HasChildViewState	(Inherited from Control.)
	HeaderScalingEnabled	Gets or sets whether the Server ribbon has scaling turned on for the tab headers. (Inherited from Ribbon.)
	HeaderScalingScript	Gets the header scaling . (Inherited from Ribbon.)
	Height	(Inherited from WebControl.)
	ID	(Inherited from Control.)
	IdSeparator	(Inherited from Control.)
	IncludeHeaderScalingScript	Gets or sets if the HeaderScalingScript is included in the page. (Inherited from Ribbon.)
	InitializationScript	(Overrides Ribbon.InitializationScript.)
	InitializationStartScript	(Overrides Ribbon.InitializationStartScript.)
	InitialTabId	Gets or sets the identifier of the tab that is displayed as selected when the Server ribbon is rendered. (Inherited from Ribbon.)
	IsChildControlStateCleared	(Inherited from Control.)
	IsCompatibilityMode	(Inherited from Ribbon.)
	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. (Inherited from Ribbon.)
	NamingContainer	(Inherited from Control.)
	Page	(Inherited from Control.)
	PageModes
	Parent	(Inherited from Control.)
	PermissionContext
	PermissionMode
	Permissions
	PermissionsString
	PlaceholderElementId	Gets or sets the element identifier of the Server ribbon control. (Inherited from Ribbon.)
	RenderContext
	RenderingCompatibility	(Inherited from Control.)
	RootBuildClientScript	(Overrides Ribbon.RootBuildClientScript.)
	ServerRendered	Gets or sets a Boolean value that indicates whether this Server ribbon was rendered on the server. (Inherited from Ribbon.)
	ServerRenderedScalingIndex	Gets or sets the server rendered scaling index. (Inherited from Ribbon.)
	ShortcutKeyBindings	Gets or sets the key binding that jumps to the initial tab. (Inherited from Ribbon.)
	ShowJewelId	Gets or sets the identifier of the Jewel. (Inherited from Ribbon.)
	ShowQATId	Gets or sets the identifier of the Quick Access Toolbar (QAT). (Inherited from Ribbon.)
	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. (Inherited from Ribbon.)
	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. (Inherited from Ribbon.)
	Dispose	(Inherited from Control.)
	EnableVisibilityContext	Enables the specified visibility context. (Inherited from Ribbon.)
	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.)
	GetCurrent	Returns the ribbon that exists on the specified page.
	GetDesignModeState	(Inherited from Control.)
	GetHashCode	(Inherited from Object.)
	GetPeripheralDataForSection	Returns the data that is contained within a peripheral content section. (Inherited from Ribbon.)
	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.)
	GetWebPartPageComponentId	Retrieves an identifier that can represent a page component identifier for the WebPart on a WebPart page.
	HasControls	(Inherited from Control.)
	HasEvents	(Inherited from Control.)
	IsLiteralContent	(Inherited from Control.)
	IsTabAvailable	Specifies whether a tab is available or not. (Inherited from Ribbon.)
	LoadControlState	(Inherited from Control.)
	LoadPostData	Sets the ActiveTabId if it is within the collection. (Inherited from Ribbon.)
	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. (Inherited from Ribbon.)
	MakeRTEContextualTabsAvailable	Causes the ribbon tabs that are used by the in-page Rich Text Editor (RTE) to be made available on the page that is being rendered, so that they can be shown on the page.
	MakeTabAvailable(String)	Adds the specified tab to the list of available tabs based on the specified tab identifier. (Inherited from Ribbon.)
	MakeTabAvailable(String, String)	Adds the specified tab to the list of available tabs based on the specified tab identifier and the visibility context. (Inherited from Ribbon.)
	MakeWikiTabsAvailable	Makes the default wiki page tabs available in the ribbon on the current page.
	MapPathSecure	(Inherited from Control.)
	MemberwiseClone	(Inherited from Object.)
	MergeDataExtensionsIntoDataSourceResult	Merges the Server ribbon customizations with the results of the query against the data source. (Inherited from Ribbon.)
	MergeStyle	(Inherited from WebControl.)
	NormalizeContextualGroup	Assigns default values to tabs contained within this contextual group. (Inherited from Ribbon.)
	OnBubbleEvent	(Inherited from Control.)
	OnDataBinding	(Inherited from Control.)
	OnInit	(Overrides Ribbon.OnInit(EventArgs).)
	OnLoad	(Inherited from Control.)
	OnPreRender	(Overrides Control.OnPreRender(EventArgs).)
	OnUnload	(Inherited from Control.)
	OpenFile	(Inherited from Control.)
	RaiseBubbleEvent	(Inherited from Control.)
	RaisePostDataChangedEvent	Handles the RaisePostDataChangedEvent() method. (Inherited from Ribbon.)
	RegisterDataExtension	Registers a data extension for the Server ribbon. (Inherited from Ribbon.)
	RemovedControl	(Inherited from Control.)
	Render	(Overrides Ribbon.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. (Inherited from Ribbon.)
	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. (Inherited from Ribbon.)
	TrimById(String, String)	Locates a tab by identifier and visibility context and trims it for the current page. (Inherited from Ribbon.)
	WriteInitializationScript	Outputs the InitializationScript on the page and starts the initialization. (Inherited from Ribbon.)
	WritePeripheralDiv	Outputs the peripheral content sections to the page. (Inherited from Ribbon.)

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

Fields

	Name	Description
	AccessRequestsContextualGroupCommand
	AccessRequestsContextualGroupId
	AccessRequestsEditTabId
	BlogListsTabId	Represents a Web Part option tab.
	CalendarContextualGroupCommand
	CalendarContextualGroupId
	CalendarEventTabId
	CalendarTabId
	CategoriesTabId
	CommentsTabId
	CustomCommandsId
	DiscussionBoardVisibilityContext
	DiscussionModerationTabId
	DocLibListFormRibbonTabId
	DocumentContextualGroupCommand
	DocumentContextualGroupId
	DocumentTabId
	EditFormVisibilityContext
	EditingToolsContextualGroupId
	EditTabId
	ExtensibilityVisibilityContext
	FormatTextTabId
	FullPageVisibilityContext
	GeneralVisibilityContext
	ImageContextualGroupId
	ImageImageTabId
	LibraryContextualGroupCommand
	LibraryContextualGroupId
	LibraryPermissionsButtonId
	LibraryTabId
	LinkContextualGroupId
	LinkLinkTabId
	ListAndLibraryVisibilityContext
	ListContextualGroupCommand
	ListContextualGroupId
	ListFormRibbonDispTabId
	ListFormRibbonTabId
	ListItemContextualGroupCommand
	ListItemContextualGroupId
	ListItemTabId
	ListTabId
	NonEventsListVisiblityContext
	NonLinksListVisibilityContext
	NonSpecialFormVisibilityContext
	PageInsertTabId
	PageStateVisibilityContext
	PermissionContextualGroupCommand
	PermissionContextualGroupId
	PermissionsTabId
	PermissionVisibilityContext
	PostFormRibbonTabId
	PostsTabId
	PublishTabId
	ReadTabId
	RTEVisibilityContext
	SolutionTabId
	SpecialFormVisibilityContext
	TableContextualGroupId
	TableDesignTabId
	TableLayoutTabId
	TabPersistenceVisibilityContext
	TasksContextualGroupCommand
	TasksContextualGroupId
	TasksListTabId
	TasksTabId
	TestTabId
	TimecardTabId
	TimelineTabId
	VirtualListVisibilityContext
	WebApplicationManagementTabId
	WebPartContextualGroupCommand
	WebPartContextualGroupId	Web part option contextual group
	WebPartInsertContextualGroupCommand
	WebPartInsertContextualGroupId
	WebPartInsertRelatedListTabId
	WebPartInsertTabId
	WebPartPageTabId
	WebPartPageVisibilityContext	Specifies the page visibility context.
	WebPartTabId
	WikiEditTabId
	WikiInsertTabId
	WikiPageTabId
	WikiPageVisibilityContext

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

SPRibbon class

Microsoft.SharePoint.WebControls namespace