Interface RibbonDialogLauncher

Artigo
05/21/2013

Representa um ícone padronizado pequeno 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 é adicionada à barra de ferramentas de acesso rápido.
	ImageName	Obtém ou define um identificador que é usado para atribuir uma imagem a este RibbonDialogLauncher quando é adicionada à 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 para exibir neste RibbonDialogLauncher, se você desejar usar um ícone interno do Microsoft Office.
	Parent	Obtém um objeto de RibbonGroup de que este RibbonDialogLauncher é um membro.
	Ribbon	Obtém OfficeRibbon em que este RibbonDialogLauncher é colocado.
	ScreenTip	Obtém ou o texto de dica de conjuntos que aparece quando o usuário move o ponteiro sobre RibbonDialogLauncher.
	SuperTip	Obtém ou define o texto de várias linhas de dica que aparece quando o usuário move o ponteiro sobre RibbonDialogLauncher.
	Visible	Obtém ou define um valor que indica se este RibbonDialogLauncher é visível.

Superior

Métodos

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

Superior

Comentários

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

Image, ImageName, as propriedades e de OfficeImageId não têm efeito visível quando RibbonDialogLauncher é exibido em um grupo em fita.No entanto, quando um usuário RibbonDialogLauncher adiciona à barra de ferramentas de acesso rápido, essas propriedades controlam o comportamento de imagem que é mostrada.Além disso, a propriedade de Visible não oculta RibbonDialogLauncher quando é exibida na barra de ferramentas de acesso rápido.O usuário pode adicionar RibbonDialogLauncher a barra de ferramentas de acesso rápido através do item de Faixa de Opções (XML) .Para obter mais informações, consulte Visão geral da faixa de opções.

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

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

Há duas maneiras para acessar o objeto de RibbonFactory :

Usando a propriedade de Factory fita de classe.Utilize esta abordagem de código em sua classe de fita.
Usando o método Globals.Factory.GetRibbonFactory .Utilize esta abordagem de código fora da classe de fita.

Algumas propriedades deste controle podem ser definidas apenas antes que a fita é 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
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 Visual Studio Tools for Office visão geral sobre o tempo de execução.

Uso

Essa documentação descreve a versão desse tipo que é usada apenas nos projetos do Office direcionados ao .NET Framework 4 e ao .NET Framework 4.5. 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. 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 RibbonDialogLauncher a um grupo de fita e como iniciar uma caixa de diálogo personalizado que permite que os usuários escolham configurações avançadas quando clique no ícone de RibbonDialogLauncher no canto inferior direito de RibbonGroup.

Para executar este exemplo de código, primeiro você deve executar as seguintes etapas:

Adicionar um item de Faixa de Opções (Visual Designer) a um projeto do Office.
Adicione RibbonDialogLauncher ao grupo padrão Group1 de acordo com Como: adicionar um iniciador de caixa de diálogo a um grupo de faixa de opções.
Se você estiver usando Visual Basic, adicione um novo item de Caixa de Diálogo para o projeto.Se você estiver usando C#, adicione um novo item de Windows Form e transforme-o em uma caixa de diálogo adicionando OK e botões de Cancelar ao formulário e criar manipuladores de eventos para os botões.
Defina a propriedade de (Nome) da caixa de diálogo para advancedSettingsDialog.Você pode personalizar a caixa de diálogo adicionando controles e definindo mais propriedades.
Adicionar o manipulador de eventos de DialogLauncherClick ao seu código.
Coloque o conteúdo do método a seguir no manipulador de eventos de DialogLauncherClick .

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();
}