Elemento ControlRef (Server Ribbon)

Artigo
04/08/2023

Aplica-se a: SharePoint 2016 | SharePoint Foundation 2013 | | do SharePoint Online SharePoint Server 2013

Representa um espaço reservado para um controle em um elemento GroupTemplate .

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

Elementos e atributos

As seções a seguir descrevem os atributos, os elementos filhos e os elementos pai.

Atributos

Atributo	Descrição
DisplayMode	Opcional. Um valor de enumeração que determina como um controle é renderizado: - Pequeno. Renderiza como um ícone pequeno sem texto de rótulo. - Médio. Renderiza como um ícone de 16 por 16 pixels com texto de rótulo. - Grande. Renderiza como um ícone de 32 por 32 pixels com texto de rótulo. - Menu. Renderiza como um item de menu somente texto. - Menu16. Renderiza como um item de menu com um ícone de 16 por 16 pixels. - Menu32. Renderiza como um item de menu com um ícone de 32 por 32 pixels.
TemplateAlias	Opcional. Uma cadeia de caracteres que um controle pode referenciar em seu próprio atributo TemplateAlias . O atributo TemplateAlias é usado para dimensionar e posicionar controles em um grupo quando um modelo é aplicado ao grupo. Nenhum elemento contido pelo mesmo elemento GroupTemplate deve ter o mesmo valor TemplateAlias .

Atributo

Descrição

DisplayMode

Opcional. Um valor de enumeração que determina como um controle é renderizado:

- Pequeno. Renderiza como um ícone pequeno sem texto de rótulo.
- Médio. Renderiza como um ícone de 16 por 16 pixels com texto de rótulo.
- Grande. Renderiza como um ícone de 32 por 32 pixels com texto de rótulo.
- Menu. Renderiza como um item de menu somente texto.
- Menu16. Renderiza como um item de menu com um ícone de 16 por 16 pixels.
- Menu32. Renderiza como um item de menu com um ícone de 32 por 32 pixels.

TemplateAlias

Opcional. Uma cadeia de caracteres que um controle pode referenciar em seu próprio atributo TemplateAlias . O atributo TemplateAlias é usado para dimensionar e posicionar controles em um grupo quando um modelo é aplicado ao grupo. Nenhum elemento contido pelo mesmo elemento GroupTemplate deve ter o mesmo valor TemplateAlias .

Elementos filho

Nenhum

Elementos pai

Linha
Tira

Occurrences

Mínimo: 0
Máximo: desvinculado

Comentários

Os controles não necessariamente dão suporte a todos os modos de exibição. A tabela a seguir lista os modos compatíveis com cada tipo de controle.

Control	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
Controle giratório		X
Splitbutton	X	X	X
TextBox		X
Togglebutton	X	X	X

Exemplo

O exemplo a seguir é um fragmento XML que mostra a relação entre o atributo TemplateAlias para controles em um elemento Group e o mesmo atributo para elementos ControlRef em um elemento GroupTemplate .

Observe que o elemento Group contém três elementos Button , cada um com um atributo TemplateAlias definido como um valor de "row1", "row2"ou "row3".

O elemento GroupTemplate também contém três elementos ControlRef que têm atributos definidos como um valor de "row1", "row2"ou "row3".

Quando o modelo é aplicado ao grupo, o layout dos controles no grupo é determinado correspondendo ao atributo TemplateAlias de um elemento Button ao atributo TemplateAlias de um elemento ControlRef .

<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>

Compartilhar via