SPRibbon members

Represents a ribbon control on a page.

The SPRibbon type exposes the following members.


  Name Description
Public method SPRibbon Initializes a new SPRibbon class object.



  Name Description
Public property AccessKey (Inherited from WebControl.)
Public property ActiveTabId Gets the Server ribbon tab that was open prior to page postback. (Inherited from Ribbon.)
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. (Inherited from Ribbon.)
Public property ApplyPermissionsToRibbonOnly
Public property AppRelativeTemplateSourceDirectory (Inherited from Control.)
Public property Attributes (Inherited from WebControl.)
Public property AuthenticationRestrictions
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 (Overrides Ribbon.CheckForInitializationReadiness.)
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. (Inherited from Ribbon.)
Public property CommandUIVisible (Overrides Ribbon.CommandUIVisible.)
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 CssFile Gets or sets a .css file to register.
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. (Inherited from Ribbon.)
Public property DataUrl Gets or sets the URL that the Server ribbon will use to retrieve data from the server. (Inherited from Ribbon.)
Public property DataVersion Gets or sets the version of the server data. (Inherited from Ribbon.)
Protected property DesignMode (Inherited from Control.)
Protected property DisabledVisibilityContexts Gets the visibility contexts that have been disabled during page rendering. (Inherited from Ribbon.)
Protected property EmbedJavascriptInHTML Embed all javascript in the output HTML or embed calls to functions in js files. (Inherited from Ribbon.)
Public property Enabled (Inherited from WebControl.)
Protected property EnabledVisibilityContexts Gets the visibility contexts that have been enabled during page rendering. (Inherited from Ribbon.)
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. (Inherited from Ribbon.)
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. (Inherited from Ribbon.)
Protected property HasChildViewState (Inherited from Control.)
Protected property HeaderScalingEnabled Gets or sets whether the Server ribbon has scaling turned on for the tab headers. (Inherited from Ribbon.)
Protected property HeaderScalingScript Gets the header scaling . (Inherited from Ribbon.)
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. (Inherited from Ribbon.)
Protected property InitializationScript (Overrides Ribbon.InitializationScript.)
Protected property InitializationStartScript (Overrides Ribbon.InitializationStartScript.)
Public property InitialTabId Gets or sets the identifier of the tab that is displayed as selected when the Server ribbon is rendered. (Inherited from Ribbon.)
Protected property IsChildControlStateCleared (Inherited from Control.)
Protected property IsCompatibilityMode (Inherited from Ribbon.)
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. (Inherited from Ribbon.)
Public property NamingContainer (Inherited from Control.)
Public property Page (Inherited from Control.)
Public property PageModes
Public property Parent (Inherited from Control.)
Public property PermissionContext
Public property PermissionMode
Public property Permissions
Public property PermissionsString
Public property PlaceholderElementId Gets or sets the element identifier of the Server ribbon control. (Inherited from Ribbon.)
Public property RenderContext
Public property RenderingCompatibility (Inherited from Control.)
Protected property RootBuildClientScript (Overrides Ribbon.RootBuildClientScript.)
Public property ServerRendered Gets or sets a Boolean value that indicates whether this Server ribbon was rendered on the server. (Inherited from Ribbon.)
Public property ServerRenderedScalingIndex Gets or sets the server rendered scaling index. (Inherited from Ribbon.)
Protected property ShortcutKeyBindings Gets or sets the key binding that jumps to the initial tab. (Inherited from Ribbon.)
Public property ShowJewelId Gets or sets the identifier of the Jewel. (Inherited from Ribbon.)
Public property ShowQATId Gets or sets the identifier of the Quick Access Toolbar (QAT). (Inherited from Ribbon.)
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. (Inherited from Ribbon.)
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. (Inherited from Ribbon.)
Public method Dispose (Inherited from Control.)
Public method EnableVisibilityContext Enables the specified visibility context. (Inherited from Ribbon.)
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.)
Public methodStatic member GetCurrent Returns the ribbon that exists on the specified page.
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. (Inherited from Ribbon.)
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 methodStatic member GetWebPartPageComponentId Retrieves an identifier that can represent a page component identifier for the WebPart on a WebPart page.
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. (Inherited from Ribbon.)
Protected method LoadControlState (Inherited from Control.)
Public method LoadPostData Sets the ActiveTabId if it is within the collection. (Inherited from Ribbon.)
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. (Inherited from Ribbon.)
Public method 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.
Public method MakeTabAvailable(String) Adds the specified tab to the list of available tabs based on the specified tab identifier. (Inherited from Ribbon.)
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. (Inherited from Ribbon.)
Public method MakeWikiTabsAvailable Makes the default wiki page tabs available in the ribbon on the current page.
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. (Inherited from Ribbon.)
Public method MergeStyle (Inherited from WebControl.)
Public method NormalizeContextualGroup Assigns default values to tabs contained within this contextual group. (Inherited from Ribbon.)
Protected method OnBubbleEvent (Inherited from Control.)
Protected method OnDataBinding (Inherited from Control.)
Protected method OnInit (Overrides Ribbon.OnInit(EventArgs).)
Protected method OnLoad (Inherited from Control.)
Protected method OnPreRender (Overrides Control.OnPreRender(EventArgs).)
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. (Inherited from Ribbon.)
Public method RegisterDataExtension Registers a data extension for the Server ribbon. (Inherited from Ribbon.)
Protected method RemovedControl (Inherited from Control.)
Protected method Render (Overrides Ribbon.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. (Inherited from Ribbon.)
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. (Inherited from Ribbon.)
Public method TrimById(String, String) Locates a tab by identifier and visibility context and trims it for the current page. (Inherited from Ribbon.)
Protected method WriteInitializationScript Outputs the InitializationScript on the page and starts the initialization. (Inherited from Ribbon.)
Protected method WritePeripheralDiv Outputs the peripheral content sections to the page. (Inherited from Ribbon.)



  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.)



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


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


SPRibbon class

Microsoft.SharePoint.WebControls namespace