Interface RibbonDialogLauncher

Artigo
08/01/2011

Representa um pequeno ícone padronizado em um grupo que pode ser usado para abrir uma caixa de diálogo.

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

Sintaxe

'Declaração
<GuidAttribute("e143d5e9-e844-4052-9793-2070185d351d")> _
Public Interface RibbonDialogLauncher _
    Inherits IDisposable

[GuidAttribute("e143d5e9-e844-4052-9793-2070185d351d")]
public interface RibbonDialogLauncher : IDisposable

O tipo RibbonDialogLauncher expõe os membros a seguir.

Propriedades

	Nome	Descrição
	Enabled	Obtém ou define um valor que indica se este RibbonDialogLauncher está habilitado.
	Image	Obtém ou define uma imagem que aparece neste RibbonDialogLauncher quando ele é adicionado à barra de ferramentas de acesso rápido.
	ImageName	Obtém ou define um identificador que é usado para atribuir uma imagem ao RibbonDialogLauncher quando ele é adicionado à barra de ferramentas de acesso rápido.
	KeyTip	Obtém ou define o atalho de teclado para este RibbonDialogLauncher.
	OfficeImageId	Obtém ou define a imagem seja exibida nesta RibbonDialogLauncher, se você desejar usar um ícone de Microsoft Office internos.
	Parent	Obtém um RibbonGroup o objeto do qual este RibbonDialogLauncher é um membro.
	Ribbon	Obtém o OfficeRibbon no qual este RibbonDialogLauncher é colocada.
	ScreenTip	Obtém ou define o texto de dica que aparece quando o usuário move o ponteiro sobre o RibbonDialogLauncher.
	SuperTip	Obtém ou define o texto de várias linhas de dica que aparece quando o usuário move o ponteiro sobre o RibbonDialogLauncher.
	Visible	Obtém ou define um valor que indica se este RibbonDialogLauncher está visível.

Início

Métodos

	Nome	Descrição
	Dispose	Executa tarefas de definição de aplicativo associadas liberando, liberando ou redefinindo recursos não gerenciados. (Herdado de IDisposable.)
	ResumeLayout	Reverte o efeito da SuspendLayout método.
	SuspendLayout	Impede que o aplicativo Microsoft Office atualizar o estado dos controles de OfficeRibbon.

Início

Comentários

A RibbonDialogLauncher é exibido no canto inferior direito de um grupo por padrão.

O Image, ImageName, e OfficeImageId Propriedades não têm nenhum efeito visível quando o RibbonDialogLauncher é exibido em um grupo na faixa de opções. No entanto, quando um usuário adiciona um RibbonDialogLauncher na barra de ferramentas de acesso rápido, essas propriedades controlam o comportamento da imagem que é mostrada. Além disso, o Visible propriedade não oculta o RibbonDialogLauncher quando ele é exibido na barra de ferramentas de acesso rápido. O usuário pode adicionar o RibbonDialogLauncher na barra de ferramentas de acesso rápido por meio de Da faixa de opções (XML) item. For more information, see Visão geral da faixa de opções.

O RibbonDialogLauncher se aplica somente a uma RibbonGroup. O RibbonGroup objeto tem um DialogLauncher membro do RibbonDialogLauncher tipo. Para obter informações sobre como adicionar um RibbonDialogLauncher para um RibbonGroup, consulte Como: Adicionar um iniciador de caixa de diálogo a um grupo de faixa de opções.

Você pode criar um RibbonDialogLauncher em tempo de execução usando o CreateRibbonDialogLauncher método de RibbonFactory objeto.

Há duas maneiras para acessar o RibbonFactory objeto:

Usando o Factory propriedade da classe de faixa de opções. Use essa abordagem do código na sua classe de faixa de opções.
Usando o Globals.Factory.GetRibbonFactory método. Use essa abordagem do código fora de sua classe de faixa de opções.

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

Observação
Esta 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.

Usage

Esta documentação descreve a versão deste tipo que é usada em projetos do Office destinados ao .NET Framework 4. Em projetos destinados ao .NET Framework 3.5, este tipo poderá ter membros diferentes, e os exemplos de código fornecidos para o 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 mostra como adicionar um RibbonDialogLauncher a um grupo de faixa de opções e como iniciar uma caixa de diálogo personalizada que permite aos usuários escolher configurações avançadas quando clicam na RibbonDialogLauncher ícone no canto inferior esquerdo do RibbonGroup.

Para executar este exemplo de código, realize as seguintes etapas:

Adicionar um a faixa de opções (Visual Designer) item a um projeto do Office.
Adicionar um RibbonDialogLauncher para o grupo padrão Grupo1 conforme descrito em Como: Adicionar um iniciador de caixa de diálogo a um grupo de faixa de opções.
Se você estiver usando Visual Basic, adicionar um novo caixa de diálogo item ao projeto. Se você estiver usando o C#, adicionar um novo Windows Form item e a transforma em uma caixa de diálogo adicionando OK e Cancelar botões ao formulário e Criando manipuladores de eventos para os botões Clique em eventos.
Definir o (nome) a propriedade da caixa de diálogo para advancedSettingsDialog. Você pode personalizar a caixa de diálogo adicionando controles e configurando mais propriedades.
Adicionar o DialogLauncherClick o manipulador de eventos para o seu código.
Colocar o conteúdo do seguinte método para o DialogLauncherClick manipulador de eventos.

Private Sub Group1_DialogLauncherClick(ByVal sender As Object, ByVal e As Microsoft.Office.Tools.Ribbon.RibbonControlEventArgs) Handles Group1.DialogLauncherClick
    Dim dlg As advancedSettingsDialog = New advancedSettingsDialog()
    dlg.ShowDialog()
End Sub

void group1_DialogLauncherClick(object sender, Microsoft.Office.Tools.Ribbon.RibbonControlEventArgs e)
{
    advancedSettingsDialog dlg = new advancedSettingsDialog();
    dlg.ShowDialog();
}