Share via


Elemento Action

Especifica a ação a ser executada quando o usuário seleciona um controle Botão ou Menu .

Válido somente nestes esquemas VersionOverrides:

  • Painel de tarefas 1.0
  • Email 1.0
  • Email 1.1

Para obter mais informações, consulte Substituições de versão no manifesto.

Associado a esses conjuntos de requisitos:

Atributos

Atributo Obrigatório Descrição
xsi:type Sim Tipo de ação a executar

xsi:type

Este atributo especifica o tipo de ação realizada quando o usuário seleciona o botão. Pode ser uma das seguintes:

  • ExecuteFunction
  • ShowTaskpane

Depois que o usuário selecionar um botão que inicia a ação ExecuteFunction , o suplemento sairá após 5 minutos se ele ainda não tiver sido concluído.

Importante

Outlook: o registro de eventosde caixa de correio e item não está disponível quando xsi:type é ExecuteFunction.

Elementos filho

Os elementos filho válidos dependem muito do valor do xsi:type parâmetro.

xsi:type é ExecuteFunction

Elemento Descrição
FunctionName Especifica o nome da função a executar.

FunctionName

Elemento necessário quando xsi:type é ExecuteFunction. Especifica o nome da função a ser executada. A função está contida no arquivo especificado no elemento FunctionFile.

<Action xsi:type="ExecuteFunction">
  <FunctionName>getSubject</FunctionName>
</Action>

xsi:type é ShowTaskpane

Elemento Descrição
SourceLocation Especifica o local do arquivo de origem para essa ação.
 TaskpaneId Especifica a ID do contêiner do painel de tarefas. Não há suporte em suplementos do Outlook.
 Título Especifica o título personalizado do painel de tarefas. Não há suporte em suplementos do Outlook.
 SupportsPinning Especifica se um painel de tarefas tem suporte para fixação, que mantém o painel de tarefas aberto quando o usuário altera a seleção. Com suporte somente no Outlook.
SupportsMultiselect Especifica que um suplemento do Outlook pode ser ativado em várias mensagens selecionadas. Com suporte somente no Outlook.
SupportsNoItemContext Especifica que um suplemento do Outlook pode ser ativado sem o Painel de Leitura habilitado ou uma mensagem selecionada. Com suporte somente em clientes da área de trabalho do Outlook.

SourceLocation

Elemento necessário quando xsi:type é ShowTaskpane. Especifica o local do arquivo de origem para essa ação. O atributo resid não pode ter mais de 32 caracteres e deve ser definido como o valor do atributo id de um <elemento Url> no <elemento Urls> no elemento Resources .

<Action xsi:type="ShowTaskpane">
  <SourceLocation resid="readTaskPaneUrl" />
</Action>

TaskpaneId

Elemento opcional quando xsi:type é ShowTaskpane. Especifica a ID do contêiner do painel de tarefas. Quando você tiver várias ShowTaskpane ações, use um TaskpaneId> diferente< se quiser um painel independente para cada um. Use o mesmo <TaskpaneId> para ações diferentes que compartilham o mesmo painel. Quando os usuários escolherem comandos que compartilham o mesmo <TaskpaneId>, o contêiner do painel permanecerá aberto, mas o conteúdo do painel será substituído pela ação SourceLocationcorrespondente .

Tipo de suplemento: Painel de tarefas

Válido somente nestes esquemas VersionOverrides:

  • Painel de tarefas 1.0

Para obter mais informações, consulte Substituições de versão no manifesto.

Associado a esses conjuntos de requisitos:

Observação

Esse elemento não tem suporte no Outlook.

O exemplo a seguir mostra duas ações que compartilham o mesmo <TaskpaneId>.

<Action xsi:type="ShowTaskpane">
  <TaskpaneId>MyPane</TaskpaneId>
  <SourceLocation resid="aTaskPaneUrl" />
</Action>

<Action xsi:type="ShowTaskpane">
  <TaskpaneId>MyPane</TaskpaneId>
  <SourceLocation resid="anotherTaskPaneUrl" />
</Action>

Os exemplos a seguir mostram duas ações que usam um TaskpaneId> diferente<. Para ver esses exemplos no contexto, consulte Exemplo de Comandos de Suplemento Simples.

<Action xsi:type="ShowTaskpane">
   <TaskpaneId>MyTaskPaneID1</TaskpaneId>
   <SourceLocation resid="Contoso.Taskpane1.Url" />
</Action>

<Action xsi:type="ShowTaskpane">
   <TaskpaneId>MyTaskPaneID2</TaskpaneId>
   <SourceLocation resid="Contoso.Taskpane2.Url" />
</Action>
<bt:Urls>
   <bt:Url id="Contoso.Taskpane1.Url" DefaultValue="https://commandsimple.azurewebsites.net/Taskpane.html" />
   <bt:Url id="Contoso.Taskpane2.Url" DefaultValue="https://commandsimple.azurewebsites.net/Taskpane2.html" />
</bt:Urls>

Título

Elemento opcional quando xsi:type é ShowTaskpane. Especifica o título personalizado do painel de tarefas desta ação.

Tipo de suplemento: Painel de tarefas

Válido somente nestes esquemas VersionOverrides:

  • Painel de tarefas 1.0

Para obter mais informações, consulte Substituições de versão no manifesto.

Associado a esses conjuntos de requisitos:

Observação

Esse elemento filho não tem suporte nos suplementos do Outlook.

O exemplo a seguir mostra uma ação que usa o <elemento Title> . Observe que você não atribui o <Título> a uma cadeia de caracteres diretamente. Em vez disso, você atribui a ele uma ID de recurso (resid), que é definida na <seção Recursos> do manifesto e não pode ter mais de 32 caracteres.

<Action xsi:type="ShowTaskpane">
    <TaskpaneId>Office.AutoShowTaskpaneWithDocument</TaskpaneId>
    <SourceLocation resid="PG.Code.Url" />
    <Title resid="PG.CodeCommand.Title" />
</Action>

 ... Other markup omitted ...
<Resources>
    <bt:Images> ...
    </bt:Images>
    <bt:Urls>
        <bt:Url id="PG.Code.Url" DefaultValue="https://localhost:3000?commands=1" />
    </bt:Urls>
    <bt:ShortStrings>
        <bt:String id="PG.CodeCommand.Title" DefaultValue="Code" />
    </bt:ShortStrings>
 ... Other markup omitted ...
</Resources>

SupportsPinning

Elemento opcional quando xsi:type é ShowTaskpane. Os elementos VersionOverrides contendo devem ter um valor de atributo xsi:type de VersionOverridesV1_1. Inclua esse elemento com um valor true a fim de fornecer suporte para fixação do painel de tarefas. O usuário pode "fixar" o painel de tarefas, fazendo com que ele permaneça aberto quando alterar a seleção. Para saber mais, consulte Implementar um painel de tarefas fixável no Outlook.

Tipo de suplemento: Email

Válido somente nestes esquemas VersionOverrides:

  • Email 1.1

Para obter mais informações, consulte Substituições de versão no manifesto.

Associado a esses conjuntos de requisitos:

Importante

Embora o elemento SupportsPinning tenha sido introduzido no conjunto de requisitos 1.5, atualmente ele só tem suporte para assinantes do Microsoft 365 usando o seguinte:

<Action xsi:type="ShowTaskpane">
  <SourceLocation resid="readTaskPaneUrl" />
  <SupportsPinning>true</SupportsPinning>
</Action>

SupportsMultiselect

Elemento opcional nos suplementos do Outlook quando xsi:type é ShowTaskpane. Inclua um valor de true para permitir que um suplemento ative e execute operações específicas em várias mensagens selecionadas. Como a seleção de várias itens se aplica apenas às mensagens, o valor do atributo xsi:type do elemento ExtensionPoint deve ser definido como MessageReadCommandSurface ou MessageComposeCommandSurface. Para saber mais sobre várias opções de item, consulte Ativar seu suplemento do Outlook em várias mensagens.

Tipo de suplemento: Email

Válido somente nestes esquemas VersionOverrides:

  • Email 1.1

Para obter mais informações, consulte Substituições de versão no manifesto.

Associado a esses conjuntos de requisitos:

<Action xsi:type="ShowTaskpane">
    <SourceLocation resid="readTaskpaneUrl" />
    <SupportsMultiSelect>true</SupportsMultiSelect>
</Action>

SupportsNoItemContext

Elemento opcional nos suplementos do Outlook quando xsi:type é ShowTaskpane. Inclua um valor de true para permitir que um suplemento seja ativado sem o Painel de Leitura habilitado ou uma mensagem selecionada. Se <SupportsNoItemContext> for definido como true, o valor do atributo xsi:type do elemento ExtensionPoint deverá ser definido como MessageReadCommandSurface. Para saber mais, confira Ativar seu suplemento do Outlook sem o Painel de Leitura habilitado ou uma mensagem selecionada.

Tipo de suplemento: Email

Válido somente nestes esquemas VersionOverrides:

  • Email 1.1

Para obter mais informações, consulte Substituições de versão no manifesto.

Associado a esses conjuntos de requisitos:

Observação

Embora Outlook na Web e novo Outlook no Windows (versão prévia) dêem suporte ao conjunto de requisitos da caixa de correio 1.13, um suplemento não será ativado se o Painel de Leitura estiver oculto ou uma mensagem não for selecionada pela primeira vez. Para saber mais, confira Suporte a recursos em Outlook na Web e novo Outlook no Windows (versão prévia).

<Action xsi:type="ShowTaskpane">
    <SourceLocation resid="Taskpane.Url"/>
    <SupportsNoItemContext>true</SupportsNoItemContext>
</Action>