Interface RibbonButton

Artigo
05/21/2013

Representa um botão em uma fita personalizado.

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 no botão em um menu quando a propriedade de ItemSize de menu é 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 que usa o Microsoft Office identificar este objeto de RibbonControl . (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 de 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 do RibbonComponent. (Herdado de RibbonComponent.)
	OfficeImageId	Obtém ou define a imagem para exibir no botão, se você desejar usar um ícone interno do Microsoft Office.
	Parent	Obtém RibbonComponent que representa o pai deste RibbonComponent. (Herdado de RibbonComponent.)
	Position	Obtém ou define a posição do botão, o botão se está no menu do Microsoft Office.
	Ribbon	Obtém o objeto de nível superior de Ribbon que contém a hierarquia de controle. (Herdado de RibbonComponent.)
	RibbonUI	Infraestrutura. Obtém a instância de IRibbonUI que é fornecida pelo aplicativo do Microsoft Office para o código de extensibilidade de fita. (Herdado de RibbonComponent.)
	ScreenTip	Obtém ou define o texto de tooltip 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 é visível.
	ShowLabel	Obtém ou define um valor que indica se o rótulo para o botão é 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ão associados com esse RibbonComponent. (Herdado de RibbonComponent.)
	Visible	Obtém ou define um valor que indica se este RibbonControl é visível. (Herdado de RibbonControl.)

Superior

Métodos

	Nome	Descrição
	Dispose	Executa tarefas definido pelo aplicativo associadas liberando, liberando ou redefinindo recursos não gerenciados. (Herdado de IDisposable.)
	PerformDynamicLayout	Chama o método de Microsoft.Office.Core.IRibbonUI.InvalidateControl do controle pai se RibbonComponent tem um pai dinâmico, como um menu dinâmico, e layout não está suspenso. (Herdado de RibbonComponent.)
	PerformLayout	Chama Microsoft.Office.Core.IRibbonUI.InvalidateControl se RibbonComponent tem um pai e o layout não está suspenso. (Herdado de RibbonComponent.)
	ResumeLayout()	Inverte o efeito de método de SuspendLayout . (Herdado de RibbonComponent.)
	ResumeLayout(Boolean)	Inverte o efeito de método de SuspendLayout . (Herdado de RibbonComponent.)
	SuspendLayout	Impede que o aplicativo do Microsoft Office atualizar o estado de controles em fita. (Herdado de RibbonComponent.)

Superior

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

Superior

Comentários

O Visual Studio cria uma instância de uma classe que implementa a interface de RibbonButton quando você arrasta um controle de Botão de tabulação Controles de fita do Office de Caixa de Ferramentas no designer de fita.

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 é dinâmico se você definir a propriedade de Dynamic a true.

Algumas propriedades deste controle podem ser definidas apenas antes que a fita é carregada no aplicativo do Office ou antes que o 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 RibbonButton em tempo de execução usando o método de CreateRibbonButton do objeto de RibbonFactory .

Há duas maneiras para acessar o objeto de RibbonFactory :

Usando a propriedade de Factory fita de classe.Utilize esta abordagem de código em sua classe de fita.
Usando o método Globals.Factory.GetRibbonFactory .Utilize esta abordagem de código fora da classe de fita.

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 tem sua propriedade de Dynamic definida como true.	Crie uma instância de uma classe que implementa a interface de RibbonButton usando CreateRibbonButton método da classe de RibbonFactory .Para obter mais informações, consulte Acesso global a objetos em projetos do Office. Adicione a instância à coleção de Items do menu.
Alterar o tamanho do botão.	Definir ControlSize para o valor que você deseja.Por exemplo, para um grande botão, defina a Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge.
Exibir uma imagem no botão.	Existem três maneiras para exibir uma imagem: Use a propriedade Image.Essa propriedade fornece a maioria de controle. Definir OfficeImageId para a identificação de uma imagem interna do Microsoft Office que você deseja exibir como o ícone para o botão. Use a propriedade de ImageName juntamente com o evento de LoadImage .Essa propriedade fornece alguns benefícios de desempenho.
Desativar ou botões oculte seções.	Para desativar um botão, defina Enabled a false. Para ocultar um botão, defina Visible a false.
Executar o código quando um usuário clica no botão.	Adicione código ao manipulador de eventos de Click .

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

Uso

Essa documentação descreve a versão desse tipo que é usada apenas nos projetos do Office direcionados ao .NET Framework 4 e ao .NET Framework 4.5. 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. 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 diversas propriedades do botão, e então adiciona o botão para um menu.Para executar este exemplo de código, primeiro você deve executar as seguintes etapas:

Adicionar um item de Faixa de Opções (Visual Designer) a um projeto criado usando ferramentas de desenvolvimento do Office no Visual Studio.
Adicione um grupo para a guia personalizado.
Adicionar um menu para o grupo.
Defina a propriedade de Dinâmico de menu a true.
Defina a propriedade de ItemSize de menu a 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);

}