Elemento CheckBox (Faixa de Opções do Servidor)
Aplica-se a: SharePoint 2016 | SharePoint Foundation 2013 | | do SharePoint Online SharePoint Server 2013
Define um controle de caixa de seleção.
<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"
/>
Elementos e atributos
As seções a seguir descrevem os atributos, os elementos filhos e os elementos pai.
Atributos
Atributo | Descrição |
---|---|
Alt |
Opcional. Texto alternativo que é usado para a caixa de seleção. |
Comando |
Opcional. O nome do comando a ser executado quando o controle for selecionado. Se o controle estiver em um elemento CommandUIDefinition , o valor do atributo Command do controle deverá ser o mesmo que o valor do atributo Command de um elemento CommandUIHandler correspondente. |
Id |
Obrigatório. Identifica o controle. O valor pode ser uma representação de cadeia de caracteres de um GUID ou um termo exclusivo, como "Ribbon.Library.Share.NewRibbonCheckBox". |
Labeltext |
Opcional. O texto para rotular o controle. |
MenuItemId |
Opcional. Uma cadeia de caracteres que identifica o item de menu em que o botão está localizado. |
QueryCommand |
Opcional. O nome do comando a ser executado ao sondar informações de estado. |
Sequence |
Opcional. Um inteiro que especifica a ordem de posicionamento entre nós XML irmãos. |
TemplateAlias |
Opcional. Uma cadeia de caracteres que corresponde ao valor do atributo TemplateAlias para um elemento ControlRef , um elemento OverflowArea ou um elemento OverflowSection em um elemento GroupTemplate . O atributo TemplateAlias é usado para controles de tamanho e posição em um grupo quando um modelo é aplicado ao grupo. |
ToolTipImage32by32 |
Opcional. Uma URL relativa ao servidor a um arquivo que contém uma imagem de 32 por 32 pixels a ser usada na dica de ferramenta, como "/_layouts/1033/images/formatmap32x32.png". |
ToolTipImage32by32Class |
Opcional. O nome de um seletor de classe CSS a ser aplicado à imagem da dica de ferramenta. |
ToolTipImage32by32Left |
Opcional. Um inteiro negativo que representa um deslocamento para a borda esquerda da imagem. Use esse atributo quando o atributo ToolTipImage32by32 apontar para um arquivo de imagem que contém imagens para muitos ícones. O valor do atributo ToolTipImage32by32Left é usado para definir o atributo esquerdo CSS para o estilo embutido de uma marca img HTML. |
ToolTipImage32by32Top |
Opcional. Um inteiro negativo que representa um deslocamento para a borda superior da imagem. Use esse atributo quando o atributo ToolTipImage32by32 apontar para um arquivo de imagem que contém as imagens para muitos ícones. O valor do atributo ToolTipImage32by32Top é usado para definir o atributo superior CSS para o estilo embutido de uma marca img HTML. |
Tooltiptitle |
Opcional. O texto que aparece como o título da dica de ferramenta. |
ToolTipDescription |
Opcional. O texto que aparece no corpo da dica de ferramenta. |
ToolTipHelpKeyWord |
Opcional. A palavra-chave usada pela Ajuda sensível ao contexto. |
ToolTipShortcutKey |
Opcional. O texto a ser exibido para a chave de atalho na dica de ferramenta. Por exemplo, se a chave de atalho para o controle for Alt+J, o valor desse atributo será "Alt+J". A dica de ferramenta exibirá o texto da chave de atalho em parênteses após o título da dica de ferramenta: "(Alt+J)". |
Elementos filho
Nenhum
Elementos pai
- CommandUIDefinition
- Controles (Grupo)
Occurrences
- Mínimo: 0
- Máximo: desvinculado
Exemplo
O exemplo a seguir é um fragmento XML que define um grupo de controles que inclui um elemento CheckBox .
<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>