RibbonCheckBox Interface

Definição

Namespace:

Microsoft.Office.Tools.Ribbon

Assembly:

Microsoft.Office.Tools.Common.dll

Representa um controle de caixa de seleção em uma faixa de opções.

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

[System.Runtime.InteropServices.Guid("2119eecb-0ee2-4a64-8b87-b76bd1fa395e")]
public interface RibbonCheckBox : IDisposable, Microsoft.Office.Tools.Ribbon.RibbonControl, System.ComponentModel.IComponent

[<System.Runtime.InteropServices.Guid("2119eecb-0ee2-4a64-8b87-b76bd1fa395e")>]
type RibbonCheckBox = interface
    interface RibbonControl
    interface RibbonComponent
    interface IComponent
    interface IDisposable

Public Interface RibbonCheckBox
Implements IComponent, IDisposable, RibbonControl

Atributos

GuidAttribute

Implementações

RibbonComponent RibbonControl IComponent IDisposable

Comentários

Você pode criar uma instância desse controle em tempo de execução e adicioná-la 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 RibbonCheckBox em tempo de execução usando o CreateRibbonCheckBox 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 RibbonCheckBox está marcado.
Description	Obtém ou define uma descrição para este RibbonCheckBox que aparece quando sua propriedade de controle pai ItemSize está definida como 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)
KeyTip	Obtém ou define o atalho de teclado para este RibbonCheckBox.
Label	Obtém ou define o texto exibido neste RibbonCheckBox.
Name	Obtém ou define o nome deste RibbonComponent. (Herdado de RibbonComponent)
Parent	Obtém um RibbonComponent que representa o pai deste RibbonComponent. (Herdado de RibbonComponent)
Position	Obterá ou definirá a posição da caixa de seleção, se ela 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 RibbonCheckBox.
SuperTip	Obtém ou define o texto da dica multilinha que é exibido quando o usuário move o ponteiro sobre o RibbonCheckBox.
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 um usuário clica na caixa de seleção.