Edit

ToggleButton element (Server Ribbon)

  • Article

Applies to: SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013

Defines a button that is used to switch states.

<ToggleButton
  Alt="Text"
  Command="Text "
  CommandValueId="Text"
  Description="Text"
  Id="Text"
  LabelCss="CSS Class Selector"
  LabelText="Text"
  Image32by32="Url"
  Image32by32Class="CSS Class Selector"
  Image32by32Left="Negative Integer"
  Image32by32Top="Negative Integer"
  Image16by16="Url"
  Image16by16Class="CSS Class Selector"
  Image16by16Left="Negative Integer"
  Image16by16Top="Negative Integer"
  MenuItemId="Text"
  QueryCommand="Text"
  Sequence="Integer"
  TemplateAlias="Text"
  ToolTipImage32by32="Url"
  ToolTipImage32by32Class="CSS Selector"
  ToolTipImage32by32Left="Negative Integer"
  ToolTipImage32by32Top="Negative Integer"
  ToolTipTitle="Text"
  ToolTipDescription="Text"
  ToolTipHelpKeyWord="Text"
  ToolTipShortcutKey="Text"
/>

Elements and attributes

The following sections describe attributes, child elements, and parent elements.

Attributes

Attribute Description
Alt
Optional. Alternative text that is used for the control.
Command
Optional. The name of the command to execute when the control is selected. If the control is in a CommandUIDefinition element, the value of the Command attribute of the control should be the same as the value of the Command attribute of a corresponding CommandUIHandler element.
CommandValueId
Optional. A string that is sent with the command event when the button is selected.
Description
Optional. A string that describes the button.
Id
Required. A string that identifies the control, such as "Ribbon.Library.ViewFormat.Standard".
LabelCss
Optional. The name of a CSS class selector to be applied to the control's label.
LabelText
Optional. Text to label the control.
Image32by32
Optional. A server-relative URL to a file that contains a 32-by-32-pixel image to be used as an icon, such as "/_layouts/1033/images/formatmap32x32.png".
Image32by32Class
Optional. The name of a CSS class selector to be applied to the image.
Image32by32Left
Optional. A negative integer that represents an offset for the left edge of the image. Use this attribute when the Image32by32 attribute points to an image file that contains images for many icons.
The value of the Image32by32Left attribute is used to set the CSS left attribute for the inline style of an HTML img tag. For example, setting the Image32by32Left attribute to " -160" and the Image32by32Top attribute to " -448" results in an inline style that is similar to the one in the following HTML markup:
HTML<img src="/_layouts/1033/images/formatmap32x32.png" style="position: absolute;left: -160px;top: -448px;" />
Image32by32Top
Optional. A negative integer that represents an offset for the top edge of the image. Use this attribute when the Image32by32 attribute points to an image file that contains the images for many icons. The value of the Image32by32Top attribute is used to set the CSS top attribute for the inline style of an HTML img tag.
Image16by16
Optional. A server-relative URL to a file that contains a 16-by-16-pixel image to be used as an icon, such as "/_layouts/1033/images/formatmap16x16.png".
Image16by16Class
Optional. The name of a CSS class selector to be applied to the image.
Image16by16Left
Optional. A negative integer that represents an offset for the left edge of the image. Use this attribute when the Image16by16 attribute points to an image file that contains images for many icons. The value of the Image16by16Left attribute is used to set the CSS left attribute for the inline style of an HTML img tag.
Image16by16Top
Optional. A negative integer that represents an offset for the top edge of the image. Use this attribute when the Image16by16 attribute points to an image file that contains images for many icons. The value of the Image16by16Top attribute is used to set the CSS top attribute for the inline style of an HTML img tag.
MenuItemId
Optional. A string that identifies the menu item where the button is located.
QueryCommand
Optional. The name of the command to execute when polling for state information.
Sequence
Optional. An integer that specifies the order of placement among sibling XML nodes.
TemplateAlias
Optional. A string that matches the value of the TemplateAlias attribute for a ControlRef element, an OverflowArea element, or an OverflowSection element in a GroupTemplate element. The TemplateAlias attribute is used to size and position controls within a group when a template is applied to the group.
ToolTipImage32by32
Optional. A server-relative URL to a file that contains a 32-by-32-pixel image to be used in the tooltip, such as "/_layouts/1033/images/formatmap32x32.png".
ToolTipImage32by32Class
Optional. The name of a CSS class selector to be applied to the tooltip image.
ToolTipImage32by32Left
Optional. A negative integer that represents an offset for the left edge of the image. Use this attribute when the ToolTipImage32by32 attribute points to an image file that contains images for many icons. The value of the ToolTipImage32by32Left attribute is used to set the CSS left attribute for the inline style of an HTML img tag when the page is created.
ToolTipImage32by32Top
Optional. A negative integer that represents an offset for the top edge of the image. Use this attribute when the ToolTipImage32by32 attribute points to an image file that contains the images for many icons. The value of the ToolTipImage32by32Top attribute is used to set the CSS top attribute for the inline style of an HTML img tag when the page is created.
ToolTipTitle
Optional. The text that appears as the title of the tooltip.
ToolTipDescription
Optional. The text that displays in the body of the tooltip.
ToolTipHelpKeyWord
Optional. The keyword that is used by context-sensitive Help.
ToolTipShortcutKey
Optional. The text to display for the shortcut key in the tooltip. For example, if the shortcut key for the control is Alt+J, the value for this attribute is "Alt+J". The tooltip displays the text for the shortcut key in parentheses after the tooltip title: "(Alt+J)".

Child elements

None

Parent elements

Occurrences

  • Minimum: 0
  • Maximum: unbounded