Compartir a través de

Elemento Control del tipo Button

  • Artículo

Define un botón que ejecuta una acción o inicia un panel de tareas.

Nota:

En este artículo se da por hecho que está familiarizado con el artículo de referencia básica control , que contiene información importante sobre los atributos del elemento.

Un botón realiza una sola acción cuando el usuario lo selecciona. Puede ejecutar una función o mostrar un panel de tareas. Cada control de botón debe tener un id valor de atributo único entre todos los <elementos Control> del manifiesto.

Importante

Los controles de tipo "Botón" se omiten en las plataformas móviles. Para admitir plataformas móviles, también debe tener un control de tipo "MobileButton" para cada control de tipo "Button".

Elementos secundarios

Elemento Obligatorio Descripción
Label Sí El texto del botón.
Supertip Sí La sugerencia del botón.

Importante: Las supertips solo se admiten en clientes de escritorio de Office.
Icon Sí Una imagen del botón.
Action Sí Especifica la acción que se va a llevar a cabo. Solo puede haber un <elemento secundario Action> de un <elemento Control> .
Enabled No Especifica si el control está habilitado cuando se inicia el complemento.
OverriddenByRibbonApi No Especifica si el botón debe aparecer en las combinaciones de aplicaciones y plataformas que admiten pestañas contextuales personalizadas. Si se usa, debe ser el primer elemento secundario.

Etiqueta

Especifica el texto del botón por medio de su único atributo, resid, que no puede tener más de 32 caracteres y debe establecerse en el valor del atributo id de un <elemento String> en el <elemento secundario ShortStrings> del elemento Resources .

Tipo de complemento: Panel de tareas, Correo

Solo es válido en estos esquemas VersionOverrides:

  • Panel de tareas 1.0
  • Correo 1.0
  • Correo 1.1

Para obtener más información, vea Invalidaciones de versión en el manifiesto de solo complemento.

Asociado a estos conjuntos de requisitos:

  • AddinCommands 1.1 cuando el elemento primario< VersionOverrides> es de tipo Panel de tareas 1.0.
  • Buzón 1.3 cuando el elemento primario< VersionOverrides> es de tipo Mail 1.0.
  • Buzón 1.5 cuando el elemento primario< VersionOverrides> es de tipo Mail 1.1.

Ejemplos

En el ejemplo siguiente, el botón ejecuta una función. También está configurado para deshabilitarse cuando se inicia el complemento. Se puede habilitar mediante programación. Para más información, consulte Habilitar y deshabilitar comandos de complementos.

<Control xsi:type="Button" id="Contoso.msgReadFunctionButton">
  <OverriddenByRibbonApi>true</OverriddenByRibbonApi>
  <Label resid="funcReadButtonLabel" />
  <Supertip>
    <Title resid="funcReadSuperTipTitle" />
    <Description resid="funcReadSuperTipDescription" />
  </Supertip>
  <Icon>
    <bt:Image size="16" resid="blue-icon-16" />
    <bt:Image size="32" resid="blue-icon-32" />
    <bt:Image size="80" resid="blue-icon-80" />
  </Icon>
  <Action xsi:type="ExecuteFunction">
    <FunctionName>getSubject</FunctionName>
  </Action>
  <Enabled>false</Enabled>
</Control>

En el ejemplo siguiente, el botón muestra un panel de tareas.

<Control xsi:type="Button" id="Contoso.msgReadOpenPaneButton">
  <Label resid="paneReadButtonLabel" />
  <Supertip>
    <Title resid="paneReadSuperTipTitle" />
    <Description resid="paneReadSuperTipDescription" />
  </Supertip>
  <Icon>
    <bt:Image size="16" resid="green-icon-16" />
    <bt:Image size="32" resid="green-icon-32" />
    <bt:Image size="80" resid="green-icon-80" />
  </Icon>
  <Action xsi:type="ShowTaskpane">
    <SourceLocation resid="readTaskPaneUrl" />
  </Action>
</Control>