RibbonDialogLauncher Interface

Definição

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

[System.Runtime.InteropServices.Guid("e143d5e9-e844-4052-9793-2070185d351d")]
public interface RibbonDialogLauncher : IDisposable
Atributos
Implementações

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 que os usuários escolham configurações avançadas ao clicarem no RibbonDialogLauncher ícone no canto inferior direito do RibbonGroup .

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

  1. Adicione um item da faixa de Ribbon (designer visual) a um projeto do Office.

  2. Adicione um RibbonDialogLauncher ao grupo padrão Group1 conforme descrito em como adicionar um iniciador de caixa de diálogo a um grupo de faixa de faixas.

  3. Se você estiver usando Visual Basic, adicione um novo item de diálogo ao projeto. Se você estiver usando C#, adicione um novo item de formulário do Windows e transforme-o em uma caixa de diálogo adicionando os botões OK e Cancelar ao formulário e criando manipuladores de eventos para os eventos de clique dos botões.

  4. Defina a propriedade (Name) da caixa de diálogo como advancedSettingsDialog . Você pode personalizar a caixa de diálogo adicionando controles e configurando mais propriedades.

  5. Adicione o DialogLauncherClick manipulador de eventos ao seu código.

  6. Coloque o conteúdo do método a seguir no DialogLauncherClick manipulador de eventos.

void group1_DialogLauncherClick(object sender, Microsoft.Office.Tools.Ribbon.RibbonControlEventArgs e)
{
    advancedSettingsDialog dlg = new advancedSettingsDialog();
    dlg.ShowDialog();
}
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

Comentários

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

As Image ImageName Propriedades, e OfficeImageId não têm efeito visível quando o RibbonDialogLauncher é exibido em um grupo na faixa de faixas. No entanto, quando um usuário adiciona um RibbonDialogLauncher à barra de ferramentas de acesso rápido, essas propriedades controlam o comportamento da imagem mostrada. Além disso, a Visible propriedade não oculta a RibbonDialogLauncher quando ela é exibida na barra de ferramentas de acesso rápido. O usuário pode adicionar o RibbonDialogLauncher à barra de ferramentas de acesso rápido por meio do item da faixa de modo (XML) . Para obter mais informações, consulte visão geral da faixade visualização.

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

Você pode criar um RibbonDialogLauncher em tempo de execução usando o CreateRibbonDialogLauncher 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 podem ser definidas somente antes que a faixa de faixas seja carregada no aplicativo do Office. Para obter informações sobre como definir essas propriedades, consulte visão geral do modelo de objeto da faixade opção.

Observação

Essa interface é implementada pelo Visual Studio Tools para 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 RibbonDialogLauncher está habilitado.

Image

Obtém ou define uma imagem que aparece nesse 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 é adicionado à Barra de Ferramentas de Acesso Rápido.

KeyTip

Obtém ou define o atalho de teclado para este RibbonDialogLauncher.

OfficeImageId

Obterá ou definirá a imagem a ser exibida nesse RibbonDialogLauncher, se você quiser usar um ícone interno do Microsoft Office.

Parent

Obtém um objeto RibbonGroup do qual este RibbonDialogLauncher é um membro.

Ribbon

Obtém o OfficeRibbon no qual esse RibbonDialogLauncher é colocado.

ScreenTip

Obtém ou define o texto da dica exibido quando o usuário move o ponteiro sobre o RibbonDialogLauncher.

SuperTip

Obtém ou define o texto da dica multilinha que é exibido quando o usuário move o ponteiro sobre o RibbonDialogLauncher.

Visible

Obtém ou define um valor que indica se o RibbonDialogLauncher está visível.

Métodos

ResumeLayout()

Inverte o efeito do método SuspendLayout().

SuspendLayout()

Impede que o aplicativo Microsoft Office atualize o estado dos controles na OfficeRibbon.

Aplica-se a