ToggleButton 要素 (サーバー リボン)
適用対象: SharePoint 2016 |SharePoint Foundation 2013 |SharePoint Online |SharePoint Server 2013
状態を切り替えるときに使用するボタンを定義します。
<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"
/>
要素と属性
以下のセクションで、属性、子要素、親要素について説明します。
属性
属性 | 説明 |
---|---|
Alt |
オプション。 コントロールで使用される代替のテキスト。 |
コマンド |
オプション。 コントロールが選択されたときに実行するコマンドの名前。 コントロールが CommandUIDefinition 要素内にある場合、コントロールの Command 属性の値は、対応する CommandUIHandler 要素の Command 属性の値と同じである必要があります。 |
CommandValueId |
オプション。 ボタンが選択されたときにコマンド イベントと共に送信される文字列。 |
説明 |
オプション。 ボタンについて説明する文字列。 |
Id |
必須です。 コントロールを識別する文字列 ("Ribbon.Library.ViewFormat.Standard" など)。 |
LabelCs |
オプション。 コントロールのラベルに適用される CSS クラス セレクターの名前。 |
LabelText |
オプション。 コントロールのラベルに指定するテキスト。 |
Image32by32 |
オプション。 "/_layouts/1033/images/formatmap32x32.png" などのアイコンとして使用される 32 x 32 ピクセルのイメージを含むファイルへのサーバー相対 URL。 |
Image32by32Class |
オプション。 画像に適用される CSS クラス セレクターの名前。 |
Image32by32Left |
オプション。 画像の左端のオフセットを表す負の整数。 Image32by32 属性が、多くのアイコンの画像を含む画像ファイルを指定している場合に、この属性を使用します。 Image32by32Left 属性の値は、HTML img タグのインライン スタイルの CSS left 属性を設定するときに使用します。 たとえば、 Image32by32Left 属性を "-160" に設定し、 Image32by32Top 属性を "-448" に設定すると、次の HTML マークアップのインライン スタイルに似たインライン スタイルになります。 HTML<img src="/_layouts/1033/images/formatmap32x32.png" style="position: absolute;left: -160px;top: -448px;" /> |
Image32by32Top |
オプション。 画像の上端のオフセットを表す負の整数。 Image32by32 属性が、多くのアイコン画像を含む画像ファイルを指している場合に、この属性を使用します。 Image32by32Top 属性の値は、HTML img タグのインライン スタイルの CSS top 属性を設定するために使用します。 |
Image16by16 |
オプション。 "/_layouts/1033/images/formatmap16x16.png" などのアイコンとして使用される 16 x 16 ピクセルのイメージを含むファイルへのサーバー相対 URL。 |
Image16by16Class |
オプション。 画像に適用される CSS クラス セレクターの名前。 |
Image16by16Left |
オプション。 画像の左端のオフセットを表す負の整数。 Image16by16 属性が、多くのアイコンの画像を含む画像ファイルを指定している場合に、この属性を使用します。 Image16by16Left 属性の値は、HTML img タグのインライン スタイルの CSS left 属性を設定するために使用します。 |
Image16by16Top |
オプション。 画像の上端のオフセットを表す負の整数。 Image16by16 属性が、多くのアイコンの画像を含む画像ファイルを指定している場合に、この属性を使用します。 Image16by16Top 属性の値は、HTML img タグのインライン スタイルの CSS top 属性を設定するために使用します。 |
MenuItemId |
オプション。 ボタンが配置されている場所のメニュー項目を識別する文字列。 |
QueryCommand |
オプション。 状態情報をポーリングするときに実行するコマンドの名前。 |
Sequence |
オプション。 兄弟 XML ノード間の配置順序を指定する整数。 |
TemplateAlias |
オプション。 GroupTemplate 要素内の ControlRef 要素、OverflowArea 要素、または OverflowSection 要素の TemplateAlias 属性の値に一致する文字列。 TemplateAlias 属性は、テンプレートをグループに適用するときにグループ内でコントロールのサイズと位置を調整するために使用されます。 |
ToolTipImage32by32 |
オプション。 "/_layouts/1033/images/formatmap32x32.png" など、ツールヒントで使用される 32 x 32 ピクセルのイメージを含むファイルへのサーバー相対 URL。 |
ToolTipImage32by32Class |
オプション。 ツールヒントの画像に適用される CSS クラス セレクターの名前。 |
ToolTipImage32by32Left |
オプション。 画像の左端のオフセットを表す負の整数。 ToolTipImage32by32 属性が、多くのアイコンの画像を含む画像ファイルを指定している場合に、この属性を使用します。 ToolTipImage32by32Left 属性の値は、ページが作成されたとき、HTML img タグのインライン スタイルの CSS left 属性を設定するために使用します。 |
ToolTipImage32by32Top |
オプション。 画像の上端のオフセットを表す負の整数。 ToolTipImage32by32 属性が、多くのアイコンの画像を含む画像ファイルを指定している場合に、この属性を使用します。 ToolTipImage32by32Top 属性の値は、ページが作成されたとき、HTML img タグのインライン スタイルのための CSS top 属性を設定するために使用します。 |
ToolTipTitle |
オプション。 ツールヒントのタイトルとして表示するテキスト。 |
ToolTipDescription |
オプション。 ツールヒントの本文に表示するテキスト。 |
ToolTipHelpKeyWord |
オプション。 コンテキスト ヘルプで使用するキーワード。 |
ToolTipShortcutKey |
オプション。 ヒントのショートカット キーに表示するテキスト。 たとえば、コントロールのショートカット キーが Alt + J の場合、この属性の値は "Alt + J" になります。 ヒントのタイトル "(Alt + J)" の後に、ショートカット キーのテキストがかっこで囲まれて表示されます。 |
子要素
None
親要素
- CommandUIDefinition
- Controls (Group)
Occurrences
- 最小: 0
- 最大: 制約なし