Interface RibbonButton

Artigo
08/01/2011

Representa um botão em uma faixa de opções personalizada.

Namespace: Microsoft.Office.Tools.Ribbon
Assembly: Microsoft.Office.Tools.Common (em Microsoft.Office.Tools.Common.dll)

Sintaxe

'Declaração
<GuidAttribute("b57e6217-33f2-46bf-9625-c313526de60c")> _
Public Interface RibbonButton _
    Inherits RibbonControl, RibbonComponent, IComponent, IDisposable

[GuidAttribute("b57e6217-33f2-46bf-9625-c313526de60c")]
public interface RibbonButton : RibbonControl, 
    RibbonComponent, IComponent, IDisposable

O tipo RibbonButton expõe os membros a seguir.

Propriedades

	Nome	Descrição
	ControlSize	Obtém ou define o tamanho do botão.
	Description	Obtém ou define o texto que aparece neste botão em um menu quando o ItemSize do menu for definida como Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge.
	Enabled	Obtém ou define um valor que indica se este RibbonControl está habilitado. (Herdado de RibbonControl.)
	Id	Obtém uma cadeia de caracteres 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 LoadImage manipulador de eventos.
	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 para exibir no botão, se você quiser usar um ícone de Microsoft Office interno.
	Parent	Obtém um RibbonComponent que representa o pai RibbonComponent. (Herdado de RibbonComponent.)
	Position	Obtém ou define a posição do botão, se o botão estiver no Menu de Microsoft Office.
	Ribbon	Obtém um nível superior Ribbon objeto que contém a hierarquia de controle. (Herdado de RibbonComponent.)
	RibbonUI	Infraestrutura. Obtém o IRibbonUI instância que é fornecida pelo aplicativo de Microsoft Office para o código de extensibilidade da faixa de opções. (Herdado de RibbonComponent.)
	ScreenTip	Obtém ou define o texto de dica de ferramenta que aparece 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 com o botão está visível.
	ShowLabel	Obtém ou define um valor que indica se o rótulo do botão está visível.
	Site	Obtém ou define o ISite associados a IComponent. (Herdado de IComponent.)
	SuperTip	Obtém ou define o texto de várias linhas de dica que aparece quando o usuário move o ponteiro sobre o botão.
	Tag	Obtém ou define os dados específicos do aplicativo que está associados esta RibbonComponent. (Herdado de RibbonComponent.)
	Visible	Obtém ou define um valor que indica se este RibbonControl está visível. (Herdado de RibbonControl.)

Início

Métodos

	Nome	Descrição
	Dispose	Executa tarefas de definição de aplicativo associadas liberando, liberando ou redefinindo recursos não gerenciados. (Herdado de IDisposable.)
	PerformDynamicLayout	Chamadas a Microsoft.Office.Core.IRibbonUI.InvalidateControl método do pai de controle se o RibbonComponent tem um pai dinâmico, como, por exemplo, um menu dinâmico, e o layout não for suspensa. (Herdado de RibbonComponent.)
	PerformLayout	Chamadas Microsoft.Office.Core.IRibbonUI.InvalidateControl se a RibbonComponent tem um pai e o layout não for suspensa. (Herdado de RibbonComponent.)
	ResumeLayout()	Reverte o efeito da SuspendLayout método. (Herdado de RibbonComponent.)
	ResumeLayout(Boolean)	Reverte o efeito da SuspendLayout método. (Herdado de RibbonComponent.)
	SuspendLayout	Impede que o aplicativo Microsoft Office o estado dos controles da faixa de opções de atualização. (Herdado de RibbonComponent.)

Início

Eventos

	Nome	Descrição
	Click	Ocorre quando o usuário clica no botão.
	Disposed	Representa o método que manipula o Disposed o evento de um componente. (Herdado de IComponent.)

Início

Comentários

Visual Studio cria uma instância de uma classe que implementa o RibbonButton interface quando você arrasta um botão de controle da Controles de faixa de opções do Office guia da Toolbox para o Designer de faixa de opções.

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

Algumas propriedades desse controle podem ser definidas antes da faixa de opções é carregada em um aplicativo do Office ou antes do controle é 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 de faixa de opções.

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

Há duas maneiras para acessar o RibbonFactory objeto:

Usando o Factory propriedade da classe de faixa de opções. Use essa abordagem do código na sua classe de faixa de opções.
Usando o Globals.Factory.GetRibbonFactory método. Use essa abordagem do código fora de sua classe de faixa de opções.

Tarefas comuns

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

Task	Member
Em tempo de execução, adicione um botão para um menu que tem seu Dynamic propriedade é definida como true.	Criar uma instância de uma classe que implementa o RibbonButton interface usando o CreateRibbonButton método de RibbonFactory classe. For more information, see Acesso global a objetos em projetos do Office. Adicionar a instância para o menu Items coleção.
Altere o tamanho do botão.	Definir ControlSize o valor que desejar. Por exemplo, para um grande botão, defina-a Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge.
Exiba uma imagem do botão.	Há três maneiras de exibir uma imagem: Use o Image propriedade. Esta propriedade dá maior controle. Definir OfficeImageId para a identificação de uma imagem de Microsoft Office interna que você deseja exibir como um ícone para o botão. Use o ImageName propriedade juntamente com o LoadImage de evento. Essa propriedade oferece alguns benefícios de desempenho.
Desativar ou ocultar os botões.	Para desativar um botão, defina Enabled para false. Para ocultar um botão, defina Visible para false.
Execute código quando um usuário clica no botão.	Adicione código para o Click manipulador de eventos.

Observação
Esta 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 Visual Studio Tools for Office visão geral sobre o tempo de execução.

Usage

Esta documentação descreve a versão deste tipo que é usada em projetos do Office destinados ao .NET Framework 4. Em projetos destinados ao .NET Framework 3.5, este tipo poderá ter membros diferentes, e os exemplos de código fornecidos para o tipo talvez não funcionem. Para obter documentação sobre este tipo em projetos destinados ao .NET Framework 3.5, consulte a seguinte seção de referência na documentação do Visual Studio 2008: https://go.microsoft.com/fwlink/?LinkId=160658.

Exemplos

O exemplo a seguir cria um novo botão, define várias propriedades do botão e, em seguida, adiciona o botão a um menu. Para executar este exemplo de código, realize as seguintes etapas:

Adicionar um a faixa de opções (Visual Designer) item a um projeto criado usando ferramentas de desenvolvimento do Office em Visual Studio.
Adicione um grupo à guia personalizada.
Adicione um menu para o grupo.
Definir o dinâmico a propriedade do menu para true.
Definir o ItemSize a propriedade do menu para RibbonControlSizeLarge.

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

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);

}