ControlRef 要素

  • [アーティクル]

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

適用対象: SharePoint Foundation 2010

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

GroupTemplate 要素内のコントロールのプレースホルダーを表します。

<ControlRef
  DisplayMode="Small | Medium | Large | Menu | Menu16 | Menu32"
  TemplateAlias="Text"
/>

属性

属性

説明

DisplayMode

オプション。コントロールのレンダリング方法を決定する列挙値。

  • Small。ラベル テキストなしの小さなアイコンとしてレンダリングします。

  • Medium。ラベル テキスト付きの 16 x 16 ピクセルのアイコンとしてレンダリングされます。

  • Large。ラベル テキスト付きの 32 x 32 ピクセルのアイコンとしてレンダリングされます。

  • Menu。テキストのみのメニュー項目としてレンダリングされます。

  • Menu16。16 x 16 ピクセルのアイコンを持つメニュー項目としてレンダリングされます。

  • Menu32。32 x 32 ピクセルのアイコンを持つメニュー項目としてレンダリングされます。

TemplateAlias

オプション。コントロールが自身の TemplateAlias 属性内で参照できる文字列。TemplateAlias 属性は、テンプレートをグループに適用するときにグループ内でコントロールのサイズと位置を調整するために使用されます。同じ GroupTemplate 要素に含まれる 2 つの要素が、同じ TemplateAlias 値を持つことはできません。

子要素

なし

親要素

Row

Strip

出現回数

最小: 0

最大: 制約なし

解説

コントロールは、必ずしもすべての表示モードをサポートするとは限りません。以下の表に、コントロールの各種類でサポートされるモードを示します。

Small

Medium

Large

Menu

Menu16

Menu32

Button

X

X

X

X

X

X

CheckBox

X

X

ColorPicker

X

ComboBox

X

DropDown

X

FlyoutAnchor

X

X

X

X

X

X

GalleryButton

X

X

InsertTable

X

Label

X

X

MenuSection

X

X

MRUSplitButton

X

X

X

Spinner

X

SplitButton

X

X

X

TextBox

X

ToggleButton

X

X

X

例

以下の例は、Group 要素内のコントロールの TemplateAlias 属性と、GroupTemplate 要素内の ControlRef 要素の同じ属性との関係を示す XML フラグメントです。Group 要素には、3 つの Button 要素が含まれています。各要素に TemplateAlias 属性があり、それぞれ値 "row1"、"row2"、"row3" に設定されています。GroupTemplate 要素にも、値 "row1"、"row2"、"row3" に設定された属性を持つ 3 つの ControlRef 要素が含まれています。テンプレートをグループに適用すると、Button 要素の TemplateAlias 属性と ControlRef 要素の TemplateAlias 属性が照合されて、グループ内のコントロールのレイアウトが決まります。

<Group
  Id="Ribbon.CustomTabExample.CustomGroupExample"
  Description="This is a custom group."
  Title="Custom Group"
  Sequence="52"
  Template="Ribbon.Templates.CustomTemplateExample">
  <Controls Id="Ribbon.CustomTabExample.CustomGroupExample.Controls">
    <Button
      Id="Ribbon.CustomTabExample.CustomGroupExample.HelloWorld"
      Command="CustomTabExample.HelloWorldCommand"
      Sequence="15"
      Description="Says hello to the World!"
      LabelText="Hello!"
      TemplateAlias="row1"/>
    <Button
      Id="Ribbon.CustomTabExample.CustomGroupExample.GoodbyeWorld"
      Command="CustomTabExample.GoodbyeWorldCommand"
      Sequence="17"
      Description="Says goodbye to the World!"
      LabelText="Goodbye!"
      TemplateAlias="row2"/>
    <Button
      Id="Ribbon.CustomTabExample.CustomGroupExample.LaterWorld"
      Command="CustomTabExample.LaterWorldCommand"
      Sequence="19"
      Description="Says I will see you later to the World!"
      LabelText="Later!"
      TemplateAlias="row3"/>
  </Controls>
</Group>

<GroupTemplate Id="Ribbon.Templates.CustomTemplateExample">
  <Layout
    Title="OneLargeTwoMedium"
    LayoutTitle="OneLargeTwoMedium">
    <Section Alignment="Top" Type="OneRow">
      <Row>
        <ControlRef DisplayMode="Large" TemplateAlias="row1" />
      </Row>
    </Section>
    <Section Alignment="Top" Type="TwoRow">
      <Row>
        <ControlRef DisplayMode="Medium" TemplateAlias="row2" />
      </Row>
      <Row>
        <ControlRef DisplayMode="Medium" TemplateAlias="row3" />
      </Row>
    </Section>
  </Layout>
</GroupTemplate>