Button 要素

  • [アーティクル]

最終更新日: 2015年3月9日

適用対象: SharePoint Foundation 2010

この記事の内容
属性
子要素
親要素
出現回数

プッシュ ボタン コントロールを定義します。

<Button
     Alt="Text"
     Command="Text"
     CommandType="General | OptionSelect | IgnoredByMenu"
     CommandValueId="Text"
     Description="Text"
     Id="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"
     LabelCss="Text"
     LabelText="Text"
     MenuItemId="Text"
     Sequence="Integer"
     TemplateAlias="Text"
     ToolTipImage32by32="Url"
     ToolTipImage32by32Class="Text"
     ToolTipImage32by32Left="Negative Integer"
     ToolTipImage32by32Top="Negative Integer"
     ToolTipTitle="Text"
     ToolTipDescription="Text"
     ToolTipHelpKeyWord="Text"
     ToolTipShortcutKey="Text"
/>

属性

属性

説明

Alt

オプション。ボタンの代替テキスト。

Command

オプション。コントロールがクリックされたときに実行するコマンドの名前。コントロールが CommandUIDefinition 要素内にある場合、コントロールの Command 属性の値は、対応する CommandUIHandler 要素の Command 属性の値と同じである必要があります。

CommandType

オプション。コマンドの種類を指定する列挙値。

  • General。特定の種類のコマンドではありません。

  • OptionSelection。ユーザーがオプション グループ内の 1 つのオプションを選択するときに生成されるコマンド。

  • IgnoredByMenu。クリックされても、メニューを閉じないコントロールで使用されるコマンド。

CommandValueId

オプション。ボタンがクリックされると、コマンド イベントで送信される文字列。

Description

オプション。ボタンについて説明する文字列。説明は、ボタンがメニュー内にあり、Menu32 表示モードでレンダリングされる場合だけ表示されます。

Id

必須。コントロールを識別する文字列 ("Ribbon.Library.Share.NewRibbonButton" など)。

Image32by32

オプション。アイコンとして使用する 32 x 32 ピクセルの画像を含むファイルのサーバー相対 URL ("/_layouts/1033/images/formatmap32x32.png" など)。

Image32by32Class

オプション。画像に適用される CSS クラス セレクターの名前。

Image32by32Left

オプション。画像の左端のオフセットを表す負の整数。Image32by32 属性が、多くのアイコンの画像を含む画像ファイルを指定している場合に、この属性を使用します。

Image32by32Left 属性の値は、HTML img タグのインライン スタイルの CSS left 属性を設定するために使用します。たとえば、Image32by32Left 属性を "-160" に設定し、Image32by32Top 属性を "-448" に設定すると、インライン スタイルは、次の HTML マークアップ内のインライン スタイルのようになります。

<img src="/_layouts/1033/images/formatmap32x32.png" style="position: absolute;left: -160px;top: -448px;" />

Image32by32Top

オプション。画像の上端のオフセットを表す負の整数。Image32by32 属性が、多くのアイコン画像を含む画像ファイルを指している場合に、この属性を使用します。Image32by32Top 属性の値は、HTML img タグのインライン スタイルの CSS top 属性を設定するために使用します。

Image16by16

オプション。アイコンとして使用する 16 x 16 ピクセルの画像を含むファイルのサーバー相対 URL ("/_layouts/1033/images/formatmap16x16.png" など)。

Image16by16Class

オプション。画像に適用される CSS クラス セレクターの名前。

Image16by16Left

オプション。画像の左端のオフセットを表す負の整数。Image16by16 属性が、多くのアイコン画像を含む画像ファイルを指している場合に、この属性を使用します。Image16by16Left 属性の値は、HTML img タグのインライン スタイルの CSS left 属性を設定するために使用します。

Image16by16Top

オプション。画像の上端のオフセットを表す負の整数。Image16by16 属性が、多くのアイコンの画像を含む画像ファイルを指定している場合に、この属性を使用します。Image16by16Top 属性の値は、HTML img タグのインライン スタイルの CSS top 属性を設定するために使用します。

LabelCss

オプション。コントロールのラベルに適用される CSS クラス セレクターの名前。

LabelText

オプション。コントロールのラベルに指定するテキスト。

MenuItemId

オプション。ボタンが配置されている場所のメニュー項目を識別する文字列。

Sequence

オプション。兄弟 XML ノード間の配置順序を指定する整数。

TemplateAlias

オプション。GroupTemplate 要素内の ControlRef 要素、OverflowArea 要素、または OverflowSection 要素の TemplateAlias 属性の値に一致する文字列。TemplateAlias 属性は、テンプレートをグループに適用するときにグループ内でコントロールのサイズと位置を調整するために使用されます。

ToolTipImage32by32

オプション。ツールヒントで使用する 32 x 32 ピクセルの画像を含むファイルのサーバー相対 URL ("/_layouts/1033/images/formatmap32x32.png" など)。

ToolTipImage32by32Class

オプション。画像に適用される CSS クラス セレクターの名前。

ToolTipImage32by32Left

オプション。画像の左端のオフセットを表す負の整数。ToolTipImage32by32 属性が、多くのアイコンの画像を含む画像ファイルを指定している場合に、この属性を使用します。ToolTipImage32by32Left 属性の値は、ページが作成されるときに CSS left 属性を設定するために使用します。

ToolTipImage32by32Top

オプション。画像の上端のオフセットを表す負の整数。ToolTipImage32by32 属性が、多くのアイコンの画像を含む画像ファイルを指定している場合に、この属性を使用します。ToolTipImage32by32Top 属性の値は、ページが作成されるときに CSS top 属性を設定するために使用します。

ToolTipTitle

オプション。ツールヒントのタイトルとして表示するテキスト。

ToolTipDescription

オプション。ツールヒントの本文に表示するテキスト。

ToolTipHelpKeyWord

オプション。コンテキスト ヘルプで使用するキーワード。

ToolTipShortcutKey

オプション。ツールヒントに表示するショートカット キーのテキスト。たとえば、コントロールのショートカット キーが ALT + J の場合、この属性の値は "ALT + J" になります。ツールヒントでは、このショートカット キーのテキストがツールヒント タイトルの後にかっこに囲まれて表示されます。例: "(ALT + J)"。

子要素

なし

親要素

CommandUIDefinition

Controls (Group)

Controls (MenuSection)

出現回数

最小: 0

最大: 制約なし

例

以下の例では、Server リボンにボタン コントロールを追加する方法を示します。この例では、リボンで、組み込みの [新しいドキュメント]、[新しいフォルダー]、および [ドキュメントのアップロード] コントロールと同じグループに [ヘルプ] ボタンを追加します。

<?xml version="1.0" encoding="utf-8"?>
<Elements xmlns="https://schemas.microsoft.com/sharepoint/">
  <CustomAction
    Id="NewUIRibbonControl"
    RegistrationType="List"
    RegistrationId="101"
    Location="CommandUI.Ribbon">
    <CommandUIExtension>
      <CommandUIDefinitions>
        <CommandUIDefinition
           Location="Ribbon.Documents.New.Controls._children">
          <Button
             Id="NewUIRibbonControl.ShowHelp"
             Alt="Help"
             Sequence="1981"
             Command="ShowHelp"
             Image32by32="/_layouts/images/newui/dochelp.png"
             LabelText="Help"
             TemplateAlias="o1"/>
        </CommandUIDefinition>
      </CommandUIDefinitions>
      <CommandUIHandlers>
        <CommandUIHandler
         Command="ShowHelp"
         CommandAction="javascript:window.open('https://msdn.microsoft.com/en-us/library/ee539395%28office.14%29.aspx');" />
      </CommandUIHandlers>
    </CommandUIExtension>
  </CustomAction>
</Elements>

関連項目

タスク

[チュートリアル] ボタンを Server リボンに追加する