XML da Faixa de Opções

Se aplica a
As informações contidas neste tópico se aplicam apenas às especificado Ferramentas do Visual Studio para o Office projetos e as versões do Microsoft Office. Tipo de Projeto Projetos de nível de documento Projetos de nível de aplicativo Versão do Microsoft Office O Excel 2007 Word 2007 Outlook 2007 PowerPoint 2007 For more information, see Recursos disponíveis pelo aplicativo e o tipo de projeto.

O item da Faixa de Opções (XML) permite que você personalizar uma Faixa de Opções usando XML.Use o item de Faixa de Opções (XML) se você desejar personalizar a Faixa de Opções de uma forma que não há suporte para o item de Faixa de Opções (Visual Designer).Para uma comparação do que você pode fazer com cada item, consulte Visão geral da Faixa de Opções.

Adicionar um item da Faixa de Opções (XML) a um projeto

Você pode adicionar um item de da Faixa de Opções (XML) a qualquer projeto de Ferramentas do Visual Studio para o Office do Adicionar Novo Item caixa de diálogo.Ferramentas do Visual Studio para o Office automaticamente adiciona os seguintes arquivos ao seu projeto:

• Um arquivo XML da Faixa de Opções.Este arquivo define a interface de usuário da Faixa de Opções.Use esse arquivo para adicionar elementos de interface do usuário, como guias, grupos e controles.Para obter detalhes, consulte referência de arquivo XML da Faixa de Opções neste tópico.

• Um arquivo de código da Faixa de Opções.Este arquivo contém a Faixa de Opções de classe .Essa classe tem o nome que você especificou para o item de da Faixa de Opções (XML) no Adicionar Novo Item caixa de diálogo.Aplicativos do Microsoft Office usam uma instância dessa classe para carregar a Faixa de Opções Personalizar.Para obter detalhes, consulte referência de classes da Faixa de Opções neste tópico.

Por padrão, esses arquivos adicionar um AAgruparar Personalizar à guia Add-ins na Faixa de Opções.

Exibir a Faixa de Opções Personalizar em um aplicativo do Microsoft Office

Depois de adicionar um item de da Faixa de Opções (XML) ao seu projeto, você deve adicionar código para o ThisAddin, ThisWorkbookou Classe de de ThisDocument que substitui o método CreateRibbonExtensibilityObject e retorna a classe de XML da Faixa de Opções ao aplicativo do Office.

O exemplo de código a seguir substitui o método CreateRibbonExtensibilityObject e retorna uma classe de XML da Faixa de Opções chamada Ribbon1.

Protected Overrides Function CreateRibbonExtensibilityObject() As  _
Microsoft.Office.Core.IRibbonExtensibility
    Return New MyRibbon()
End Function

protected override Microsoft.Office.Core.IRibbonExtensibility CreateRibbonExtensibilityObject()
{
    return new MyRibbon();
}

Definindo o comportamento da Faixa de Opções Personalizar

Você pode responder às ações do usuário, tais como clicar em um botão na Faixa de Opções, com a criação de métodos de retorno de chamada .Métodos de retorno de chamada se parecer com eventos em controles Windows Forms, mas eles são identificados por um atributo no XML do elemento da interface do usuário.Você Gravar métodos na classe da Faixa de Opções e um Controlarar chama o método que tem o mesmo nome que o valor do atributo.Por exemplo, você pode criar um método de retorno de chamada que é chamado quando um usuário clica em um botão na Faixa de Opções.Duas etapas são necessárias para criar um método de retorno de chamada:

• Atribuir um atributo a um Controlarar no arquivo XML da Faixa de Opções que identifica um método de retorno de chamada em seu código.

• Definir o método de retorno de chamada na classe da Faixa de Opções.

Observação:
O Outlook 2007 requer uma etapa adicional.Para obter mais informações, consulte Personalizando uma faixa de opções para Outlook.

Para um explicação passo a passo que demonstra como automatizar um aplicativo da faixa de opções, consulte Demonstra Passo a passo: Criando um guia Personalizar com o XML da Faixa de Opções.

Atribuição de métodos de retorno de chamada a controles

Para atribuir um método de retorno de chamada a um Controlarar no arquivo XML da Faixa de Opções, Adicionar um atributo que especifica o tipo do método de retorno de chamada e o nome do método.Por exemplo, o elemento a seguir define um botão de Alternar que tem um método de retorno de chamada onAction chamado OnToggleButton1.

<toggleButton id="toggleButton1" onAction="OnToggleButton1" />

onAction é chamado quando o usuário executa a tarefa principal associada a um Controlarar específico.Por exemplo, o método de retorno de chamada onAction de um botão de Alternar é chamado quando o usuário clica no botão.

O método que você especifique no atributo pode ter qualquer nome.No entanto, ele deve corresponder ao nome do método que você Definir no arquivo de código da Faixa de Opções.

Há muitos tipos diferentes de métodos de retorno de chamada que você pode atribuir a controles da Faixa de Opções.Para um Concluir lista de retorno de chamada métodos disponíveis para cada Controlare, consulte o artigo técnico Customizing the Office (2007) Faixa de Opções User Interface para desenvolvedores (Parte 3 de 3).

Definir métodos de retorno de chamada

Definirm os métodos de retorno de chamada na classe da Faixa de Opções no arquivo de código da Faixa de Opções.Um método de retorno de chamada possui diversos requisitos:

• Ele deve ser declarado como público.

• Seu nome deve corresponder ao nome de um método de retorno de chamada que você atribuiu a um Controlarar no arquivo XML da Faixa de Opções.

• Sua assinatura deve corresponder a assinatura de um tipo de método de retorno de chamada que está disponível para o Controlarar da Faixa de Opções associado.

Para um Concluir lista de retorno de chamada assinaturas de método para controles da Faixa de opções, consulte o artigo técnico Customizing the Office (2007) Ribbon User Interface para desenvolvedores (Parte 3 de 3).Ferramentas do Visual Studio para o Office não oferece suporte a IntelliSense para métodos de retorno de chamada que você criar no arquivo de código da Faixa de Opções.Se você criar um método de retorno de chamada que não coincide com uma assinatura válida, o código será Compilar, mas nada ocorrerá quando o usuário clica no Controlarar.

Todos os métodos de retorno de chamada têm um parâmetro Microsoft.Office.Core.IRibbonControl que representa o Controlarar que chamou o método.Você pode usar esse parâmetro para reutilizar o mesmo método de retorno de chamada para Múltiplo controles.O exemplo de código a seguir demonstra um método de retorno de chamada onAction que realiza tarefas diferentes, dependendo de qual Controlarar o usuário clica.

Public Sub OnActionCallback(ByVal control As Office.IRibbonControl, _
    ByVal isPressed As Boolean)

    If (control.Id = "checkBox1") Then
        MessageBox.Show("You clicked " + control.Id)
    Else
        MessageBox.Show("You clicked a different control.")
    End If

End Sub

public void OnActionCallback(Office.IRibbonControl control, bool isPressed)
{
    if (control.Id == "checkBox1")
    {
        MessageBox.Show("You clicked " + control.Id);
    }
    else
    {
        MessageBox.Show("You clicked a different control.");
    }
}

Referência de arquivo XML da Faixa de Opções

Você pode definir sua Faixa de Opções Personalizar, adicionando elementos e atributos para o arquivo XML da Faixa de Opções.Por padrão, o arquivo XML da Faixa de opções contém o seguinte XML.

<?xml version="1.0" encoding="UTF-8"?>
<customUI xmlns="https://schemas.microsoft.com/office/2006/01/customui" onLoad="OnLoad">
  <ribbon>
    <tabs>
      <tab idMso="TabAddIns">
        <group id="MyGroup"
               label="My Group">
        </group>
      </tab>
    </tabs>
  </ribbon>
</customUI>

A tabela a seguir descreve os elementos padrão no arquivo XML da Faixa de Opções.

Elemento	Descrição
customUI	Representa Faixa de Opções de Opções Personalizar no Adicionar no projeto.
ribbon	Representa a Faixa de Opções.
tabs	Representa um conjunto de guias da Faixa de Opções.
tab	Representa uma guia Simples Faixa de Opções.
group	Representa um AAgruparar de controles na guia da Faixa de Opções.

Esses elementos têm atributos que especificam a aparência e o comportamento da Faixa de Opções Personalizar.A tabela a seguir descreve os atributos padrão no arquivo XML da Faixa de Opções.

Atributo	Elemento pai	Descrição
onLoad	customUI	Identifica um método que é chamado quando o aplicativo carrega a Faixa de Opções.
idMso	tab	Identifica uma guia interna para exibir na Faixa de Opções.
id	group	Identifica o AAgruparar.
label	group	Especifica o texto que aparece no AAgruparar.

Os elementos de padrão e os atributos no arquivo XML da Faixa de Opções são um pequeno subconjunto dos elementos e atributos que estão disponíveis.Para um Concluir lista das disponíveis elementos e atributos, consulte o artigo técnico Customizing the Office (2007) Faixa de Opções User Interface para desenvolvedores (parte 2 de 3).

Referência de classes da Faixa de Opções

Ferramentas do Visual Studio para o Office gera a classe da Faixa de Opções no arquivo de código da Faixa de Opções.Adicionar Os métodos de retorno de chamada para controles da Faixa de Opções para esta classe.Essa classe implementa a interface de Microsoft.Office.Core.IRibbonExtensibility.

A tabela a seguir descreve os métodos padrão dessa classe.

Método	Descrição
GetCustomUI	Retorna o conteúdo do arquivo XML da Faixa de Opções.Aplicativos do Microsoft Office chamar esse método para obter uma Cadeia de Caracteres XML que define a interface do usuário do seu Faixa de Opções Personalizar. Observação: GetCustomUI devem ser implementadas apenas para retornar o conteúdo do arquivo XML da Faixa de Opções; Ele não deve ser usado para inicializar o Adicionar-in.Em particular, você não deve tentar exibir caixas de Caixa de diálogo ou Outro janelas na sua implementação GetCustomUI.Caso contrário, a Faixa de Opções Personalizar pode não se comportar corretamente.Se você precisar executar o código que inicializa o Adicionar-in, adicione o código ao manipulador de eventos ThisAddIn_Startup.
OnLoad	Atribui o parâmetro Microsoft.Office.Core.IRibbonControl ao campo ribbon.Aplicativos do Microsoft Office chamam esse método quando eles Carregar a Faixa de Opções Personalizar.Você pode usar este campo para atualizar dinamicamente a Faixa de Opções Personalizar.Para obter mais informações, consulte o artigo técnico Customizing the Office (2007) Faixa de Opções User Interface para Developers (Part 1 of 3).
GetResourceText	Chamado pelo método GetCustomUI para obter o conteúdo do arquivo XML da Faixa de Opções.

Consulte também

Tarefas

Demonstra Passo a passo: Criando um guia Personalizar com o XML da Faixa de Opções

Conceitos

Visão geral da Faixa de Opções

Personalização de IU do Office