ToggleButton 要素 (サーバー リボン)ToggleButton element (Server Ribbon)

に適用されます: SharePoint 2016 |SharePoint Foundation 2013 |SharePoint オンライン |SharePoint Server 2013Applies 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 キーを押しAlt
オプション。コントロールで使用される代替のテキスト。Optional. Alternative text that is used for the control.
CommandCommand
省略可能。Optional. コントロールが選択されたときに実行するコマンドの名前。The name of the command to execute when the control is selected. CommandUIDefinition要素内のコントロールの場合は、コントロールの [コマンド] 属性の値は対応するCommandUIHandler要素の [コマンド] 属性の値と同じにします。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.
CommandValueIdCommandValueId
省略可能。Optional. ボタンが選択されているときにコマンド イベントと共に送信される文字列です。A string that is sent with the command event when the button is selected.
説明Description
オプション。ボタンについて説明する文字列。Optional. A string that describes the button.
IdId
必須。コントロールを識別する文字列 ("Ribbon.Library.ViewFormat.Standard" など)。Required. A string that identifies the control, such as "Ribbon.Library.ViewFormat.Standard".
LabelCssLabelCss
オプション。コントロールのラベルに適用される CSS クラス セレクターの名前。Optional. The name of a CSS class selector to be applied to the control's label.
LabelTextLabelText
オプション。コントロールのラベルに指定するテキスト。Optional. Text to label the control.
Image32by32Image32by32
省略可能。Optional. 次のように、アイコンとして使用するのには 32 × 32 ピクセルのイメージを含むファイルへの相対 URL"/_layouts/1033/images/formatmap32x32.png"です。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".
Image32by32ClassImage32by32Class
オプション。画像に適用される CSS クラス セレクターの名前。Optional. The name of a CSS class selector to be applied to the image.
Image32by32LeftImage32by32Left
省略可能。Optional. イメージの左端までのオフセットを表す負の整数です。A negative integer that represents an offset for the left edge of the image. Image32by32属性は、多くのアイコンのイメージを含むイメージ ファイルをポイントしたときは、この属性を使用します。Use this attribute when the Image32by32 attribute points to an image file that contains images for many icons.
インライン スタイルは、HTML のimgタグの CSS のleft属性を設定するのにはImage32by32Left属性の値を使用します。The value of the Image32by32Left attribute is used to set the CSS left attribute for the inline style of an HTML img tag. たとえば、設定する「-160」にImage32by32Left属性とImage32by32Top属性「-448」、次の HTML マークアップを次のようなインライン スタイルの。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;" />
Image32by32TopImage32by32Top
省略可能。Optional. イメージの上端の座標のオフセットを表す負の整数です。A negative integer that represents an offset for the top edge of the image. Image32by32属性は、多くのアイコンの画像が含まれるイメージ ファイルをポイントしたときは、この属性を使用します。Use this attribute when the Image32by32 attribute points to an image file that contains the images for many icons. HTML のimgタグのインライン スタイルの CSSの属性を設定するのにはImage32by32Top属性の値を使用します。The value of the Image32by32Top attribute is used to set the CSS top attribute for the inline style of an HTML img tag.
Image16by16Image16by16
省略可能。Optional. 次のように、アイコンとして使用する 16 x 16 ピクセル画像を含むファイルへの相対 URL"/_layouts/1033/images/formatmap16x16.png"です。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".
Image16by16ClassImage16by16Class
オプション。画像に適用される CSS クラス セレクターの名前。Optional. The name of a CSS class selector to be applied to the image.
Image16by16LeftImage16by16Left
省略可能。Optional. イメージの左端までのオフセットを表す負の整数です。A negative integer that represents an offset for the left edge of the image. Image16by16属性は、多くのアイコンのイメージを含むイメージ ファイルをポイントしたときは、この属性を使用します。Use this attribute when the Image16by16 attribute points to an image file that contains images for many icons. インライン スタイルは、HTML のimgタグの CSS のleft属性を設定するのにはImage16by16Left属性の値を使用します。The value of the Image16by16Left attribute is used to set the CSS left attribute for the inline style of an HTML img tag.
Image16by16TopImage16by16Top
省略可能。Optional. イメージの上端の座標のオフセットを表す負の整数です。A negative integer that represents an offset for the top edge of the image. Image16by16属性は、多くのアイコンのイメージを含むイメージ ファイルをポイントしたときは、この属性を使用します。Use this attribute when the Image16by16 attribute points to an image file that contains images for many icons. HTML のimgタグのインライン スタイルの CSSの属性を設定するのにはImage16by16Top属性の値を使用します。The value of the Image16by16Top attribute is used to set the CSS top attribute for the inline style of an HTML img tag.
MenuItemIdMenuItemId
オプション。ボタンが配置されている場所のメニュー項目を識別する文字列。Optional. A string that identifies the menu item where the button is located.
QueryCommandQueryCommand
オプション。状態情報をポーリングするときに実行するコマンドの名前。Optional. The name of the command to execute when polling for state information.
SequenceSequence
オプション。兄弟 XML ノード間の配置順序を指定する整数。Optional. An integer that specifies the order of placement among sibling XML nodes.
TemplateAliasTemplateAlias
省略可能。Optional. ControlRef要素、 OverflowAreaの要素、またはため要素内のOverflowSection要素のTemplateAlias属性の値に一致する文字列です。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. TemplateAlias属性は、サイズを使用し、テンプレートと、グループ内での位置のコントロールがグループに適用します。The TemplateAlias attribute is used to size and position controls within a group when a template is applied to the group.
ToolTipImage32by32ToolTipImage32by32
省略可能。Optional. 次のように、ツール ヒントに使用する 32 × 32 ピクセルのイメージを含むファイルへの相対 URL"/_layouts/1033/images/formatmap32x32.png"です。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".
ToolTipImage32by32ClassToolTipImage32by32Class
オプション。ツールヒントの画像に適用される CSS クラス セレクターの名前。Optional. The name of a CSS class selector to be applied to the tooltip image.
ToolTipImage32by32LeftToolTipImage32by32Left
省略可能。Optional. イメージの左端までのオフセットを表す負の整数です。A negative integer that represents an offset for the left edge of the image. ToolTipImage32by32属性は、多くのアイコンのイメージを含むイメージ ファイルをポイントしたときは、この属性を使用します。Use this attribute when the ToolTipImage32by32 attribute points to an image file that contains images for many icons. ToolTipImage32by32Left属性の値を使用して、ページの作成時に HTML のimgタグのインライン スタイルの CSS のleft属性を設定します。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.
ToolTipImage32by32TopToolTipImage32by32Top
省略可能。Optional. イメージの上端の座標のオフセットを表す負の整数です。A negative integer that represents an offset for the top edge of the image. ToolTipImage32by32属性は、多くのアイコンの画像が含まれるイメージ ファイルをポイントしたときは、この属性を使用します。Use this attribute when the ToolTipImage32by32 attribute points to an image file that contains the images for many icons. ToolTipImage32by32Top属性の値を使用して、ページの作成時に HTML のimgタグのインライン スタイルの CSSの属性を設定します。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.
ToolTipTitleToolTipTitle
オプション。ツールヒントのタイトルとして表示するテキスト。Optional. The text that appears as the title of the tooltip.
ToolTipDescriptionToolTipDescription
オプション。ツールヒントの本文に表示するテキスト。Optional. The text that displays in the body of the tooltip.
ToolTipHelpKeyWordToolTipHelpKeyWord
オプション。コンテキスト ヘルプで使用するキーワード。Optional. The keyword that is used by context-sensitive Help.
ToolTipShortcutKeyToolTipShortcutKey
省略可能。Optional. ツール ヒントにショートカット キーを表示するテキストです。The text to display for the shortcut key in the tooltip. コントロールのショートカット キーが alt キーを押しながら J の場合は、この属性の値は「Alt + J」です。For example, if the shortcut key for the control is Alt+J, the value for this attribute is "Alt+J". ツールヒントでは、かっこで囲まれたショートカット キーのテキストを表示ツールチップのタイトルの後:"(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

  • 最小: 0Minimum: 0
  • 最大: 制約なしMaximum: unbounded