Ribbon element (Server Ribbon)
Applies to: SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013
Contains elements that define the server ribbon user interface.
<Ribbon
Id="Text"
Image32by32GroupPopupDefault="Url"
Image32by32GroupPopupDefaultClass="CSS Selector"
Image32by32GroupPopupDefaultLeft="Negative Integer"
Image32by32GroupPopupDefaultTop="Negative Integer"
ImageDownArrow="Url"
ImageDownArrowClass="CSS Selector"
ImageDownArrowLeft="Negative Integer"
ImageDownArrowTop="Negative Integer"
ImageSideArrow="Url"
ImageSideArrowClass="CSS Selector"
ImageSideArrowLeft="Negative Integer"
ImageSideArrowTop="Negative Integer"
ImageUpArrow="Url"
ImageUpArrowClass="CSS Selector"
ImageUpArrowLeft="Negative Integer"
ImageUpArrowTop="Negative Integer"
RootEventCommand="Text"
TabSwitchCommand="Text"
ScaleCommand="Text"
TextDirection="Text"
ToolTipFooterText="Text"
ToolTipFooterImage16by16="Url"
ToolTipFooterImage16by16Class="CSS Selector"
ToolTipFooterImage16by16Left="Negative Integer"
ToolTipFooterImage16by16Top="Negative Integer"
ToolTipDisabledCommandImage16by16="Url"
ToolTipDisabledCommandImage16by16Class="CSS Selector"
ToolTipDisabledCommandImage16by16Left="Negative Integer"
ToolTipDisabledCommandImage16by16Top="Negative Integer"
ToolTipDisabledCommandDescription="Text"
ToolTipDisabledCommandTitle="Text"
ToolTipDisabledCommandHelpKey="Text"
ToolTipHelpCommand="Text"
ToolTipSelectedItemTitlePrefix="Text"
ShortcutKeyJumpToRibbon_Ctrl="Text"
ShortcutKeyJumpToRibbon_Alt="Text"
ShortcutKeyJumpToRibbon_Shift="Text"
ShortcutKeyJumpToRibbon_AccessKey="Text"
ShortcutKeyJumpToFirstControl_Ctrl="Text"
ShortcutKeyJumpToFirstControl_Alt="Text"
ShortcutKeyJumpToFirstControl_Shift="Text"
ShortcutKeyJumpToFirstControl_AccessKey="Text"
ATContextualTabText="Text"
ATTabPositionText="Text"
NavigationHelpText="Text"
/>
Elements and attributes
The following sections describe attributes, child elements, and parent elements.
Attributes
| Attribute | Description |
|---|---|
| Id |
Required. A string that identifies the element, such as "Ribbon". |
| Image32by32GroupPopupDefault |
Optional. A server-relative URL to a file that contains a 32-by-32-pixel image to use for the pop-up image, such as "/_layouts/1033/images/formatmap32x32.png". |
| Image32by32GroupPopupDefaultClass |
Optional. The name of a CSS class selector to be applied to the pop-up image. |
| Image32by32GroupPopupDefaultLeft |
Optional. A negative integer that represents an offset for the left edge of the image. Use this attribute when the Image32by32GroupPopupDefault attribute points to an image file that contains the images for many icons. The value of the Image32by32GroupPopupDefaultLeft attribute is used to set the CSS left attribute for the inline style of an HTML img tag when the page is created. |
| Image32by32GroupPopupDefaultTop |
Optional. A negative integer that represents an offset for the top edge of the image. Use this attribute when the Image32by32GroupPopupDefault attribute points to an image file that contains the images for many icons. The value of the Image32by32GroupPopupDefaultTop attribute is used to set the CSS top attribute for the inline style of an HTML img tag when the page is created. |
| ImageDownArrow |
Optional. A server-relative URL to a file that contains a 16-by-16-pixel image to use for the down arrow, such as "/_layouts/1033/images/formatmap16x16.png". |
| ImageDownArrowClass |
Optional. The name of a CSS class selector to be applied to the down arrow image. |
| ImageDownArrowLeft |
Optional. A negative integer that represents an offset for the left edge of the image. Use this attribute when the ImageDownArrow attribute points to an image file that contains the images for many icons. The value of the ImageDownArrowLeft attribute is used to set the CSS left attribute for the inline style of an HTML img tag when the page is created. |
| ImageDownArrowTop |
Optional. A negative integer that represents an offset for the top edge of the image. Use this attribute when the ImageDownArrow attribute points to an image file that contains the images for many icons. The value of the ImageDownArrowTop attribute is used to set the CSS top attribute for the inline style of an HTML img tag when the page is created. |
| ImageSideArrow |
Optional. A server-relative URL to a file that contains a 16-by-16-pixel image to use for the side arrow. |
| ImageSideArrowClass |
Optional. The name of a CSS class selector to be applied to the side arrow image. |
| ImageSideArrowLeft |
Optional. A negative integer that represents an offset for the left edge of the image. |
| ImageSideArrowTop |
Optional. A negative integer that represents an offset for the top edge of the image. |
| RootEventCommand |
Optional. The name of the default command to invoke when a ribbon event occurs. |
| TabSwitchCommand |
Optional. The name of the command to invoke when the active ribbon tab is changed. |
| ScaleCommand |
Optional. The name of the command to invoke when the ribbon is scaled. |
| TextDirection |
Optional. A string that specifies the direction in which to draw text, such as "ltr". |
| ToolTipFooterText |
Optional. Text to use in the tooltip footer. |
| ToolTipFooterImage16by16 |
Optional. A server-relative URL to a file that contains a 16-by-16-pixel image to use for the tooltip footer, such as "/_layouts/1033/images/formatmap16x16.png". |
| ToolTipFooterImage16by16Class |
Optional. The name of a CSS class selector to be applied to the image. |
| ToolTipFooterImage16by16Left |
Optional. A negative integer that represents an offset for the left edge of the image. |
| ToolTipFooterImage16by16Top |
Optional. A negative integer that represents an offset for the top edge of the image. |
| ToolTipDisabledCommandImage16by16 |
Optional. A server-relative URL to a file that contains a 16-by-16-pixel image to use in the tooltip when the control is disabled. |
| ToolTipDisabledCommandImage16by16Class |
Optional. The name of a CSS class selector to be applied to the image. |
| ToolTipDisabledCommandImage16by16Left |
Optional. A negative integer that represents an offset for the left edge of the image. |
| ToolTipDisabledCommandImage16by16Top |
Optional. A negative integer that represents an offset for the top edge of the image. |
| ToolTipDisabledCommandDescription |
Optional. Text of the tooltip when the control is disabled. |
| ToolTipDisabledCommandTitle |
Optional. Title of the tooltip when the control is disabled. |
| ToolTipDisabledCommandHelpKey |
Optional. Key that invokes Help when the control is disabled. |
| ToolTipHelpCommand |
Optional. The name of the command that invokes Help when the control is disabled. |
| ToolTipSelectedItemTitlePrefix |
Optional. Prefix for the title of the tooltip for the selected item. |
| ShortcutKeyJumpToRibbon_Ctrl |
Optional. Either "t" or "f", indicating whether the CTRL key should be pressed to set focus to the first ribbon tab. |
| ShortcutKeyJumpToRibbon_Alt |
Optional. Either "t" or "f", indicating whether the ALT key should be pressed to set focus to the first ribbon tab. |
| ShortcutKeyJumpToRibbon_Shift |
Optional. Either "t" or "f", indicating whether the SHIFT key should be pressed to set focus to the first ribbon tab. |
| ShortcutKeyJumpToRibbon_AccessKey |
Optional. A one-character string that specifies the key that should be pressed to set focus to the first ribbon tab. |
| ShortcutKeyJumpToFirstControl_Ctrl |
Optional. Either "t" or "f", indicating whether the CTRL key should be pressed to set focus on the first control. |
| ShortcutKeyJumpToFirstControl_Alt |
Optional. Either "t" or "f", indicating whether the ALT key should be pressed to set focus on the first control. |
| ShortcutKeyJumpToFirstControl_Shift |
Optional. Either "t" or "f", indicating whether the SHIFT key should be pressed to set focus on the first control. |
| ShortcutKeyJumpToFirstControl_AccessKey |
Optional. A one character string that specifies the key that should be pressed to set focus on the first control. |
| ATContextualTabText |
Optional. Hidden text to convey contextual tab information to screen readers, such as " {0} group. Tab {1} of {2}." |
| ATTabPositionText |
Optional. Hidden text to convey tab information to screen readers, such as "Tab {0} of {1}." |
| NavigationHelpText |
Optional. The text of a message that describes how to navigate the ribbon using the keyboard, which is displayed as hidden text for a screen reader. |
Child elements
Parent elements
Occurrences
- Minimum: 0
- Maximum: 1