CheckBox 要素 (サーバーリボン)

[アーティクル]
04/08/2023

適用対象: SharePoint 2016 |SharePoint Foundation 2013 |SharePoint Online |SharePoint Server 2013

チェックボックスコントロールを定義します。

<CheckBox
     Alt="Text"
     Command="Text"
     Id="Text"
     LabelText="Text"
     MenuItemId="Text"
     QueryCommand="Text"
     Sequence="Integer"
     TemplateAlias="Text"
     ToolTipImage32by32="Url"
     ToolTipImage32by32Class="CSS Class Selector"
     ToolTipImage32by32Left="Negative Integer"
     ToolTipImage32by32Top="Negative Integer"
     ToolTipTitle="Text"
     ToolTipDescription="Text"
     ToolTipHelpKeyWord="Text"
     ToolTipShortcutKey="Text"
/>

要素と属性

以下のセクションで、属性、子要素、親要素について説明します。

属性

属性	説明
Alt	オプション。チェックボックスで使用する代替テキスト。
コマンド	オプション。コントロールが選択されたときに実行するコマンドの名前。コントロールが CommandUIDefinition 要素内にある場合、コントロールの Command 属性の値は、対応する CommandUIHandler 要素の Command 属性の値と同じである必要があります。
Id	必須です。コントロールを識別します。値には、GUID の文字列または "Ribbon.Library.Share.NewRibbonCheckBox" のような一意の用語を指定できます。
LabelText	オプション。コントロールのラベルに指定するテキスト。
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
最大: 制約なし

例

次の例は、CheckBox 要素を含むコントロールのグループを定義する XML フラグメントです。

<Group
  Id="Ribbon.Image.Image.Size"
  Sequence="50"
  Command="ImageSizeGroup"
  Description=""
  Title="$Resources:core,GrpSize;"
  Image32by32Popup="/_layouts/$Resources:core,Language;/images/formatmap32x32.png" Image32by32PopupTop="-128" Image32by32PopupLeft="0"
  Template="Ribbon.Templates.Flexible2"
>
  <Controls Id="Ribbon.Image.Image.Size.Controls">
    <Label
      Id="Ribbon.Image.Image.Size.HorizontalSizeLabel"
      LabelText="$Resources:core,LabelHorizSize;"
      Command="ImageHorizontalLabel"
      ForId="Ribbon.Image.Image.Size.HorizontalSize"
      Image16by16="/_layouts/$Resources:core,Language;/images/formatmap16x16.png" Image16by16Top="-80" Image16by16Left="-16"
      TemplateAlias="o1"
      Sequence="10"
    />
    <Spinner
       Id="Ribbon.Image.Image.Size.HorizontalSize"
       DefaultUnit="pixel"
       DefaultValue="10"
       AltUpArrow="$Resources:core,cui_spnUpAlt;"
       AltDownArrow="$Resources:core,cui_spnDownAlt;"
       AccelerationInterval="125"
       MultiplierInterval="2000"
       ImeEnabled="false"
       Command="ImageWidth"
       QueryCommand="QueryImageWidth"
       ToolTipTitle="$Resources:core,LabelHorizSize;"
       ToolTipDescription="$Resources:core,cui_stt_ButSizeMenuHorizontalSizeTooltip;"
       TemplateAlias="o2"
      Sequence="20"
    >
      <Unit
          Name="pixel"
          MinimumValue="1"
          MaximumValue="2000"
          DecimalDigits="0"
          Interval="5"
        >
        <UnitAbbreviation Value="px" />
      </Unit>
      <Unit
          Name="percent"
          MinimumValue="1"
          MaximumValue="100"
          DecimalDigits="0"
          Interval="1"
        >
        <UnitAbbreviation Value="%" />
      </Unit>
    </Spinner>
    <Label
      Id="Ribbon.Image.Image.Size.VertSizeLabel"
      LabelText="$Resources:core,LabelVertSize;"
      Command="ImageVerticalLabel"
      ForId="Ribbon.Image.Image.Size.VerticalSize"
      Image16by16="/_layouts/$Resources:core,Language;/images/formatmap16x16.png" Image16by16Top="-208" Image16by16Left="-224"
      TemplateAlias="o1"
      Sequence="30"
    />
    <Spinner
      Id="Ribbon.Image.Image.Size.VerticalSize"
      DefaultUnit="pixel"
      DefaultValue="10"
      AltUpArrow="$Resources:core,cui_spnUpAlt;"
      AltDownArrow="$Resources:core,cui_spnDownAlt;"
      AccelerationInterval="125"
      MultiplierInterval="2000"
      Command="ImageHeight"
      ImeEnabled="false"
      QueryCommand="QueryImageHeight"
      ToolTipTitle="$Resources:core,LabelVertSize;"
      ToolTipDescription="$Resources:core,cui_stt_ButSizeMenuVerticalSizeTooltip;"
      TemplateAlias="o2"
      Sequence="40"
    >
      <Unit
          Name="pixel"
          MinimumValue="1"
          MaximumValue="2000"
          DecimalDigits="0"
          Interval="5"
        >
        <UnitAbbreviation Value="px" />
      </Unit>
      <Unit
          Name="percent"
          MinimumValue="1"
          MaximumValue="100"
          DecimalDigits="0"
          Interval="1"
        >
        <UnitAbbreviation Value="%" />
      </Unit>
    </Spinner>
    <CheckBox
      Id="Ribbon.Image.Image.Size.LockAspect"
      Command="ImageLockRatio"
      QueryCommand="QueryImageLockRatio"
      LabelText="$Resources:core,LabelLockAspect;"
      Alt="$Resources:core,ButLockAspectAlt;"
      TemplateAlias="o2"
      Sequence="50"
    />
  </Controls>
</Group>

CheckBox 要素 (サーバー リボン)

要素と属性

属性

子要素

親要素

Occurrences

例

その他のリソース

CheckBox 要素 (サーバーリボン)