RibbonToggleButton Interface

Referência

Definição

Namespace:: Microsoft.Office.Tools.Ribbon

Assembly:: Microsoft.Office.Tools.Common.dll

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Representa um controle de botão de alternância em uma Faixa de Opções.

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

[System.Runtime.InteropServices.Guid("fc50977f-187c-4082-ab53-087e81f4ded1")]
public interface RibbonToggleButton : IDisposable, Microsoft.Office.Tools.Ribbon.RibbonControl, System.ComponentModel.IComponent

[<System.Runtime.InteropServices.Guid("fc50977f-187c-4082-ab53-087e81f4ded1")>]
type RibbonToggleButton = interface
    interface RibbonControl
    interface RibbonComponent
    interface IComponent
    interface IDisposable

Public Interface RibbonToggleButton
Implements IComponent, IDisposable, RibbonControl

Atributos: GuidAttribute

Implementações: RibbonComponent RibbonControl IComponent IDisposable

Comentários

Um RibbonToggleButton pode ser usado para mostrar se um item está selecionado.

Você pode criar um RibbonToggleButton em tempo de execução usando o CreateRibbonToggleButton 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.

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

Checked	Obtém ou define um valor que indica se o botão de alternância é pressionado ou não.
ControlSize	Obtém ou define o tamanho do controle RibbonToggleButton .
Description	Obtém ou define o texto exibido neste controle RibbonToggleButton em um menu suspenso.
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 controle.
ImageName	Obtém ou define o nome que você pode usar no manipulador de eventos LoadImage para identificar uma imagem para o controle.
KeyTip	Obtém ou define o atalho de teclado do botão de alternância.
Label	Obtém ou define o texto no botão de alternância.
Name	Obtém ou define o nome deste RibbonComponent. (Herdado de RibbonComponent)
OfficeImageId	Obterá ou definirá a imagem a ser exibida no RibbonToggleButton, se você quiser 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 RibbonToggleButton, se o controle 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 exibido quando o usuário move o ponteiro sobre o botão de alternância.
ShowImage	Obtém ou define um valor que indica se a imagem que está associada ao RibbonToggleButton está visível.
ShowLabel	Obtém ou define um valor que indica se o rótulo para o RibbonToggleButton está visível.
SuperTip	Obtém ou define o texto da dica multilinha exibido quando o usuário move o ponteiro sobre o controle RibbonToggleButton.
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 controle RibbonToggleButton.

Aplica-se a

Compartilhar via