RibbonButton Interface

Definição

Namespace:

Microsoft.Office.Tools.Ribbon

Assembly:

Microsoft.Office.Tools.Common.dll

Representa um botão em uma Faixa de Opções personalizada.

public interface class RibbonButton : IDisposable, Microsoft::Office::Tools::Ribbon::RibbonControl, System::ComponentModel::IComponent

[System.Runtime.InteropServices.Guid("b57e6217-33f2-46bf-9625-c313526de60c")]
public interface RibbonButton : IDisposable, Microsoft.Office.Tools.Ribbon.RibbonControl, System.ComponentModel.IComponent

[<System.Runtime.InteropServices.Guid("b57e6217-33f2-46bf-9625-c313526de60c")>]
type RibbonButton = interface
    interface RibbonControl
    interface RibbonComponent
    interface IComponent
    interface IDisposable

Public Interface RibbonButton
Implements IComponent, IDisposable, RibbonControl

Atributos

GuidAttribute

Implementações

RibbonComponent RibbonControl IComponent IDisposable

Exemplos

O exemplo a seguir cria um novo botão, define várias propriedades do botão e adiciona o botão a um menu. Para executar esse exemplo de código, você deve primeiro executar as seguintes etapas:

1. Adicione um item Faixa de Opções (Visual Designer) a um projeto criado usando ferramentas de desenvolvimento do Office no Visual Studio.

2. Adicione um grupo à guia personalizada.

3. Adicione um menu ao grupo.

4. Defina a propriedade Dynamic do menu como true.

5. Defina a propriedade ItemSize do menu como RibbonControlSizeLarge.

private void AddButtonsToMenu()
{
    RibbonButton tempButton = this.Factory.CreateRibbonButton();
    tempButton.Label = "Button 1";
    tempButton.ControlSize =
        Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge;
    tempButton.Description = "My Ribbon Button";
    tempButton.ShowImage = true;
    tempButton.ShowImage = true;
    tempButton.Image = Properties.Resources.Image1;
    tempButton.Image = Properties.Resources.Image2;
    tempButton.KeyTip = "A1";
    menu1.Items.Add(tempButton);

}

Private Sub AddButtonsToMenu()
    Dim tempButton = Me.Factory.CreateRibbonButton()
    tempButton.Label = "Button 1"
    tempButton.ControlSize = _
        Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge
    tempButton.Description = "My Ribbon Button"
    tempButton.ShowImage = True
    tempButton.ShowImage = True
    tempButton.Image = My.Resources.Image1
    tempButton.Image = My.Resources.Image2
    tempButton.KeyTip = "A1"
    menu1.Items.Add(tempButton)
End Sub

Comentários

O Visual Studio cria uma instância de uma classe que implementa a RibbonButton interface quando você arrasta um controle Button da guia Controles da Faixa de Opções do Office da Caixa de Ferramentas para a faixa de opções Designer.

Você também pode criar uma instância desse controle em tempo de execução e adicioná-lo a um menu dinâmico. Um menu será dinâmico se você definir sua Dynamic propriedade como true.

Algumas propriedades desse controle só podem ser definidas antes que a Faixa de Opções seja carregada no aplicativo do Office ou antes que o controle seja adicionado a um menu dinâmico em tempo de execução. Para obter informações sobre como definir essas propriedades, consulte Visão geral do modelo de objeto da faixa de opções.

Você pode criar um RibbonButton em tempo de execução usando o CreateRibbonButton método do RibbonFactory objeto .

Existem duas maneiras de acessar o objeto RibbonFactory:

• Usando a propriedade Factory da classe Ribbon. Use essa abordagem no código na classe Ribbon.

• Usando o método Globals.Factory.GetRibbonFactory. Use essa abordagem no código fora da classe Ribbon.

Tarefas comuns

A tabela a seguir lista os membros que são úteis para tarefas comuns.

Tarefa	Membro
Em tempo de execução, adicione um botão a um menu que tenha sua Dynamic propriedade definida como true.	Cria uma instância de uma classe que implementa a interface RibbonButtonCreateRibbonButton. método da RibbonFactory classe . Para obter mais informações, consulte Acesso global a objetos em projetos do Office. Adicione a instância à coleção do Items menu.
Altere o tamanho do botão.	O ControlSize valor que você deseja testar Por exemplo, para um botão grande, defina-o Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLargecomo .
Exibir uma imagem no botão.	Há três maneiras de exibir uma imagem: – Use a Image propriedade . Essa propriedade fornece o maior controle. - Defina OfficeImageId como a ID de uma imagem interna do Microsoft Office que você deseja exibir como o ícone do botão. – Use a ImageName propriedade junto com o LoadImage evento . Essa propriedade oferece alguns benefícios de desempenho.
Desabilitar ou ocultar botões.	Para desabilitar um botão, defina como Enabledfalse. Para ocultar um botão, defina como Visiblefalse.
Execute o código quando um usuário clicar no botão.	Adicione código ao Click manipulador de eventos.

Observação

Essa interface é implementada pelo Visual Studio Tools for Office Runtime. Ela não se destina a ser implementada em seu código. Para obter mais informações, consulte Visão geral do Visual Studio Tools para Office Runtime.

Uso

Essa documentação descreve a versão desse tipo que é usada nos projetos do Office direcionados ao .NET Framework 4 ou posterior. Em projetos direcionados ao .NET Framework 3.5, esse tipo pode ter membros diferentes e os exemplos de código fornecidos para este tipo talvez não funcionem. Conheça a documentação sobre este tipo em projetos direcionados ao .NET Framework 3.5 na seguinte seção de referência na documentação do Visual Studio 2008: http://go.microsoft.com/fwlink/?LinkId=160658.

Propriedades

ControlSize	Obtém ou define o tamanho do botão.
Description	Obtém ou define o texto que aparece nesse botão em um menu quando a ItemSize propriedade do menu é definida como Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge.
Enabled	Obtém ou define um valor que indica se o RibbonControl está habilitado. (Herdado de RibbonControl)
Id	Obtém uma cadeia de caracteres que o Microsoft Office usa para identificar esse RibbonControl objeto. (Herdado de RibbonControl)
Image	Obtém ou define a imagem que é exibida no botão.
ImageName	Obtém ou define o nome que você pode usar para identificar o botão no manipulador de eventos LoadImage.
KeyTip	Obtém ou define o atalho de teclado do botão.
Label	Obtém ou define o texto que é exibido no botão.
Name	Obtém ou define o nome deste RibbonComponent. (Herdado de RibbonComponent)
OfficeImageId	Obtém ou define a imagem a ser exibida no botão, caso você queira usar um ícone interno do Microsoft Office.
Parent	Obtém um RibbonComponent que representa o pai deste RibbonComponent. (Herdado de RibbonComponent)
Position	Obterá ou definirá a posição do botão se o botão estiver no Menu do Microsoft Office.
Ribbon	Obtém o objeto Ribbon de nível superior que contém a hierarquia de controle. (Herdado de RibbonComponent)
RibbonUI	Obtém a instância IRibbonUI fornecida pelo aplicativo do Microsoft Office para o código de extensibilidade da Faixa de Opções. (Herdado de RibbonComponent)
ScreenTip	Obtém ou define o texto da dica de ferramenta exibido quando o usuário move o ponteiro sobre o botão.
ShowImage	Obtém ou define um valor que indica se a imagem que está associada ao botão estará visível.
ShowLabel	Obtém ou define um valor que indica se o rótulo do botão está visível.
SuperTip	Obtém ou define o texto da dica multilinha exibido quando o usuário move o ponteiro sobre o botão.
Tag	Obtém ou define dados específicos do aplicativo associados a este RibbonComponent. (Herdado de RibbonComponent)
Visible	Obtém ou define um valor que indica se o RibbonControl está visível. (Herdado de RibbonControl)

Métodos

PerformDynamicLayout()	Chamará o método Microsoft.Office.Core.IRibbonUI.InvalidateControl do controle pai se o RibbonComponent tiver um pai dinâmico, como um menu dinâmico, e o layout não for suspenso. (Herdado de RibbonComponent)
PerformLayout()	Chamará Microsoft.Office.Core.IRibbonUI.InvalidateControl se o RibbonComponent tiver um pai e o layout não estiver suspenso. (Herdado de RibbonComponent)
ResumeLayout()	Inverte o efeito do método SuspendLayout(). (Herdado de RibbonComponent)
ResumeLayout(Boolean)	Inverte o efeito do método SuspendLayout(). (Herdado de RibbonComponent)
SuspendLayout()	Impede que o aplicativo Microsoft Office atualize o estado dos controles na Faixa de Opções. (Herdado de RibbonComponent)

Eventos

Click

Ocorre quando o usuário clica no botão.