Faixa de opções XML

Artigo
02/25/2013

O item de fita (XML) permite que você personalize uma fita usando XML.Use o item de fita (XML) se você deseja personalizar a fita de uma maneira que não é suportada pelo item de fita (designer visual.)Para uma comparação de que você pode fazer com cada item, consulte Visão geral da faixa de opções.

Aplicável a: As informações neste tópico se aplicam a projetos de nível de documento e projetos de nível de aplicativo para os seguintes aplicativos: Excel 2013 e Excel 2010; InfoPath 2013 e InfoPath 2010; Outlook 2013 e Outlook 2010; PowerPoint 2013 e PowerPoint 2010; Project 2013 e Project 2010; Visio 2013 e Visio 2010; Word 2013 e Word 2010. Para obter mais informações, consulte Recursos disponíveis pelo aplicativo do Office e o tipo de projeto.

Adicionando um item de fita (XML) a um projeto

Você pode adicionar um item de fita (XML) a qualquer projeto do Office da caixa de diálogo de Adicionar novo item .O Visual Studio adiciona automaticamente os seguintes arquivos para seu projeto:

Um arquivo XML e fita.Esse arquivo define a interface de usuário (UI) de fita.Use esse arquivo para adicionar elementos de interface de usuário como guias, grupos, e controles.Para obter detalhes, consulte Referência de arquivo XML e fita posteriormente em este tópico.
Um arquivo de código de fita.Este arquivo contém a classe de fita.Esta classe possui o nome que você especificou para o item de fita (XML) na caixa de diálogo de Adicionar novo item .Os aplicativos do Microsoft Office usam uma instância da classe para carregar a fita personalizado.Para obter detalhes, consulte Referência de classes de fita posteriormente em este tópico.

Por padrão, esses arquivos adicione um grupo personalizado para a guia de Suplementos em fita.

Exibindo a fita personalizado em um aplicativo do Microsoft Office

Após adicionar um item de fita (XML) ao seu projeto, você deve adicionar o código a ThisAddin, a ThisWorkbook, ou classe de ThisDocument que substitui o método de CreateRibbonExtensibilityObject e retorna a classe XML de fita para o aplicativo do Office.

O exemplo de código substitui o método de CreateRibbonExtensibilityObject e retorna uma fita MyRibbon XML chamado classe.

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 personalizado de fita

Você pode responder às ações do usuário, como clicar um botão em fita, criando métodos de retorno de chamada.Os métodos de retorno de chamada são semelhantes a eventos em controles dos formulários do windows, mas são identificados por um atributo em XML do elemento de interface do usuário.Você escreve métodos na classe de fita, e chamadas de um controle o método que tem o mesmo nome que o valor do atributo.Por exemplo, você pode criar um método callback que é chamado quando um usuário clica em um botão em fita.Duas etapas são necessárias para criar um método callback:

Atribuir um atributo a um controle no arquivo XML e fita que identifica um método callback no seu código.
Defina o método de retorno de chamada na classe de fita.

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

Para uma explicação passo a passo que demonstra como automatizar um aplicativo de fita, considere Passo a passo: Criando uma guia personalizada usando o XML da faixa de opções.

Métodos callback de atribuição a controles

Para atribuir um método de retorno de chamada para um controle no arquivo XML e fita, adicione um atributo que especifica o tipo do método de retorno e o nome do método.Por exemplo, o seguinte elemento define um botão de alternância que tem um método callback OnToggleButton1chamado de onAction .

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

onAction é chamado quando o usuário executar a tarefa de chave associada com um controle específico.Por exemplo, o método de retorno de onAction de um botão de alternância é chamado quando o usuário clica no botão.

O método que você especificar no atributo pode ter qualquer nome.Em o entanto, ele deve corresponder ao nome do método que você define no arquivo de código de fita.

Há muitos tipos diferentes de métodos callback que você pode atribuir aos controles de fita.Para obter uma lista completa dos métodos callback disponíveis para cada controle, consulte o artigo técnico Personalizando as interfaces de usuário de fita do Office (2007) para os desenvolvedores (parte 3 de 3).

Definindo métodos callback

Defina os métodos callback na classe de fita no arquivo de código de fita.Um método callback diversos requisitos:

Deve ser declarado como público.
O nome deve corresponder ao nome de um método callback que você atribuiu a um controle no arquivo XML e fita.
A assinatura deve coincidir com a assinatura de um tipo de método de retorno que está disponível para o controle associado de fita.

Para obter uma lista completa das assinaturas de método callback para controles de fita, consulte o artigo técnico Personalizando as interfaces de usuário de fita do Office (2007) para os desenvolvedores (parte 3 de 3).Visual Studio não fornece suporte IntelliSense para os métodos callback que você cria no arquivo de código de fita.Se você criar um método callback que não corresponde a uma assinatura válida, o código irá compilar nada, mas ocorrerá quando o usuário clica no controle.

Todos os métodos callback têm um parâmetro de Microsoft.Office.Core.IRibbonControl que representa o controle que chamou o método.você pode usar este parâmetro para reutilizar o mesmo método de retorno de chamada para vários controles.O exemplo de código a seguir demonstra um método callback de onAction que executa as tarefas diferentes dependendo do controle que 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 e fita

Você pode definir sua fita personalizado adicionando elementos e atributos XML para o arquivo de fita.Por padrão, o arquivo XML e fita contém XML a seguir.

<?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 e fita.

Elemento	Descrição
customUI	Representa a fita personalizado no projeto do suplemento.
ribbon	representa a fita.
tabs	Representa um conjunto de guias de fita.
tab	Representa um único guia de fita.
group	Representa um grupo de controles na guia de fita.

Esses elementos têm atributos que especificam a aparência e o comportamento de fita personalizado.A tabela a seguir descreve os atributos padrões no arquivo XML e fita.

Atributo	elemento pai	Descrição
onLoad	customUI	Identifica um método que é chamado quando o aplicativo for carregado. a fita
idMso	tab	Identifica uma guia interno para exibir em fita.
id	group	identifica o grupo.
label	group	Especifica o texto que aparece no grupo.

Elementos e atributos padrões no arquivo XML e fita são um subconjunto pequeno de elementos e atributos que estão disponíveis.Para obter uma lista completa de elementos e atributos disponíveis, consulte o artigo técnico Personalizando as interfaces de usuário de fita do Office (2007) para os desenvolvedores (parte 2 de 3).

Referência de classes de fita

O Visual Studio gera a classe de fita no arquivo de código de fita.Adicione os métodos de retorno de chamada para controles em fita a essa classe.Essa classe implementa a interface de Microsoft.Office.Core.IRibbonExtensibility .

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

Método	Descrição
GetCustomUI	Retorna o conteúdo do arquivo XML e fita.Os aplicativos do Microsoft Office chama esse método para obter uma cadeia de caracteres de XML que define a interface do usuário de seu fita personalizado.este método implementa o método de IRibbonExtensibility.GetCustomUI . Observação GetCustomUI deve ser implementado para retornar somente o conteúdo do arquivo XML; de fita não deve ser usado para inicializar o suplemento.em particular, você não deve tentar exibir caixas de diálogo ou outras janelas em sua implementação de GetCustomUI .Caso contrário, a fita personalizado pode não se comportar corretamente.Se você precisa executar o código que inicializa o suplemento, adicione código ao manipulador de eventos de ThisAddIn_Startup .
OnLoad	Atribui o parâmetro de Microsoft.Office.Core.IRibbonControl para o campo de ribbon .Os aplicativos do Microsoft Office chamar este método quando carregam a fita personalizado.Você pode usar este campo para atualizar dinamicamente a fita personalizado.Para obter mais informações, consulte o artigo técnico Personalizando as interfaces de usuário de fita do Office (2007) para os desenvolvedores (parte 1 de 3).
GetResourceText	Chamado pelo método de GetCustomUI para obter o conteúdo do arquivo XML e fita.

Consulte também

Tarefas

Passo a passo: Criando uma guia personalizada usando o XML da faixa de opções

Outros recursos

Visão geral da faixa de opções

Personalização de interface do usuário do Office

Partilhar via