RibbonButton Classe (sistema de 2007)

Artigo
08/25/2010

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

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

Sintaxe

<ToolboxBitmapAttribute(GetType(RibbonButton), "RibbonButton.bmp")> _
Public NotInheritable Class RibbonButton _
    Inherits RibbonControl

Dim instance As RibbonButton

[ToolboxBitmapAttribute(typeof(RibbonButton), "RibbonButton.bmp")]
public sealed class RibbonButton : RibbonControl

Comentários

Visual Studio Tools for Office cria uma instância das RibbonButton classe quando você arrasta um Botão controle o Controles da faixa de opções de escritório Guia de do Caixa de ferramentas para o Designer de faixa de opções.

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

Algumas propriedades deste controle podem ser conjunto apenas antes que a faixa de opções é carregada no aplicativo do Office ou antes do controle é adicionado a um menu dinâmico em time 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.

Tarefas comuns

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

Tarefa	Membro
Em time de execução, adicionar um botão a um menu com o seu Dynamic conjunto de propriedades como verdadeira.	Criar uma instância do RibbonButton classe usando o RibbonButton construtor. Adicionar a instância do menu Items coleção.
Altere o dimensionar do botão.	conjunto ControlSize para o valor desejado. Por exemplo, para um botão grande conjunto-o para Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge.
Exiba uma imagem no botão.	Há três maneiras de exibir uma imagem: Use o Image propriedade. Esta propriedade dá maior controle. conjunto OfficeImageId sistema autônomo a ID de uma imagem interna do Microsoft Office que você deseja exibir sistema autônomo ícone do botão. Use o ImageName propriedade juntamente com o LoadImage evento. Essa propriedade oferece alguns benefícios de desempenho.
desabilitar ou ocultar botões.	Para desabilitar um botão conjunto Enabled para false. Para ocultar um botão, defina Visible para false.
Executar código quando um usuário clica no botão.	Adicione código para o Click manipulador de eventos.

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 Faixa de opções (Visual Designer) item to a Visual Studio Tools for Office projeto.
Adicione um agrupar à guia personalizada.
Adicione um menu ao agrupar.
conjunto o Dinâmico propriedade do menu para true.
conjunto o ItemSize propriedade do menu para RibbonControlSizeLarge.

PrivateSub AddButtonsToMenu()
    Dim tempButton AsNew RibbonButton()
    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)
EndSub

privatevoid AddButtonsToMenu()
{
    RibbonButton tempButton = new RibbonButton();
    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);

}

Hierarquia de herança

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      Microsoft.Office.Tools.Ribbon.RibbonComponent
        Microsoft.Office.Tools.Ribbon.RibbonControl
          Microsoft.Office.Tools.Ribbon.RibbonButton

Acesso thread-safe

Quaisquer membros static (Shared no Visual Basic) públicos deste tipo são thread-safe. Não há garantia de que qualquer membro de instância seja thread-safe.