RibbonEditBox Interface

Definição

Namespace:

Microsoft.Office.Tools.Ribbon

Assembly:

Microsoft.Office.Tools.Common.dll

Representa uma caixa de edição em uma Faixa de Opções.

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

[System.Runtime.InteropServices.Guid("14396b39-63c4-4fc2-92fe-cbccdbe5f306")]
public interface RibbonEditBox : IDisposable, Microsoft.Office.Tools.Ribbon.RibbonControl, System.ComponentModel.IComponent

[<System.Runtime.InteropServices.Guid("14396b39-63c4-4fc2-92fe-cbccdbe5f306")>]
type RibbonEditBox = interface
    interface RibbonControl
    interface RibbonComponent
    interface IComponent
    interface IDisposable

Public Interface RibbonEditBox
Implements IComponent, IDisposable, RibbonControl

Atributos

GuidAttribute

Implementações

RibbonComponent RibbonControl IComponent IDisposable

Comentários

O RibbonEditBox controle exibe uma caixa rotulada na qual os usuários podem digitar e editar texto.

O Visual Studio cria um RibbonEditBox objeto quando você arrasta um controle EditBox da guia Controles da Faixa de Opções do Office da Caixa de Ferramentas para a faixa de opções Designer.

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

Algumas propriedades desse controle só podem ser definidas antes que a Faixa de Opções seja carregada no aplicativo do Office. Para obter informações sobre como definir essas propriedades, consulte Visão geral do modelo de objeto da faixa de opções.

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

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 na caixa de edição.
ImageName	Obtém ou define o nome que você pode usar para identificar a imagem no manipulador de eventos LoadImage.
KeyTip	Obtém ou define o atalho de teclado para este RibbonEditBox.
Label	Obtém ou define o texto exibido neste RibbonEditBox.
MaxLength	Obtém ou define um valor que indica o número máximo de caracteres permitido por entrada neste RibbonEditBox.
Name	Obtém ou define o nome deste RibbonComponent. (Herdado de RibbonComponent)
OfficeImageId	Obtém ou define a imagem a ser exibida no botão, caso você queira usar um ícone interno do Microsoft Office.
Parent	Obtém um RibbonComponent que representa o pai deste RibbonComponent. (Herdado de RibbonComponent)
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 RibbonEditBox.
ShowImage	Obtém ou define um valor que indica se a imagem que está associada ao RibbonEditBox está visível.
ShowLabel	Obtém ou define um valor que indica se o rótulo para esse RibbonEditBox está visível.
SizeString	Obtém ou define uma cadeia de caracteres que determina o tamanho do RibbonEditBox.
SuperTip	Obtém ou define o texto da dica multilinha que é exibido quando o usuário move o ponteiro sobre o RibbonEditBox.
Tag	Obtém ou define dados específicos do aplicativo associados a este RibbonComponent. (Herdado de RibbonComponent)
Text	Obtém ou define o texto que aparece no RibbonEditBox quando a caixa de edição aparece pela primeira vez.
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

TextChanged

Ocorre quando um usuário altera o texto no RibbonEditBox.