Interface RibbonMenu

Artigo
05/21/2013

Representa um menu em uma guia de fita ou no menu do Microsoft Office.

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

Sintaxe

'Declaração
<GuidAttribute("59dc7f42-aca2-484a-9622-1ee34a6cfd7d")> _
Public Interface RibbonMenu _
    Inherits RibbonControl, RibbonComponent, IComponent, IDisposable

[GuidAttribute("59dc7f42-aca2-484a-9622-1ee34a6cfd7d")]
public interface RibbonMenu : RibbonControl, 
    RibbonComponent, IComponent, IDisposable

O tipo RibbonMenu expõe os membros a seguir.

Propriedades

	Nome	Descrição
	ControlSize	Obtém ou define o tamanho do menu.
	Description	Obtém ou define o texto que aparece no menu atual.
	Dynamic	Obtém ou define um valor que indica se o menu pode ser alterado em tempo de execução.
	Enabled	Obtém ou define um valor que indica se este RibbonControl está habilitado. (Herdado de RibbonControl.)
	Id	Obtém uma cadeia de caracteres que usa o Microsoft Office identificar este objeto de RibbonControl . (Herdado de RibbonControl.)
	Image	Obtém ou define a imagem que é exibida no menu.
	ImageName	Obtém ou define o nome que você pode usar o manipulador de eventos de LoadImage para identificar uma imagem para o menu.
	Items	Obtém a coleção de controles que estão no menu.
	ItemSize	Obtém ou define o tamanho dos controles no menu.
	KeyTip	Obtém ou define a tecla de acesso do teclado do menu.
	Label	Obtém ou define o texto que é exibido pelo menu.
	Name	Obtém ou define o nome do RibbonComponent. (Herdado de RibbonComponent.)
	OfficeImageId	Obtém ou define a imagem para exibir o menu, se você desejar usar um ícone interno do Microsoft Office.
	Parent	Obtém RibbonComponent que representa o pai deste RibbonComponent. (Herdado de RibbonComponent.)
	Position	Obtém ou define a posição do menu, se o menu está no menu do Microsoft Office.
	Ribbon	Obtém o objeto de nível superior de Ribbon que contém a hierarquia de controle. (Herdado de RibbonComponent.)
	RibbonUI	Infraestrutura. Obtém a instância de IRibbonUI que é fornecida pelo aplicativo do Microsoft Office para o código de extensibilidade de fita. (Herdado de RibbonComponent.)
	ScreenTip	Obtém ou o texto de dica de conjuntos que aparece quando o usuário move o ponteiro sobre o menu.
	ShowImage	Obtém ou define um valor que indica se a imagem que está associada com o menu é visível.
	ShowLabel	Obtém ou define um valor que indica se o rótulo do menu é visível.
	Site	Obtém ou define o ISite associados a IComponent. (Herdado de IComponent.)
	SuperTip	Obtém ou define o texto de várias linhas de dica que aparece quando o usuário move o ponteiro sobre o menu.
	Tag	Obtém ou define os dados específicos do aplicativo que estão associados com esse RibbonComponent. (Herdado de RibbonComponent.)
	Title	Obtém ou define o título que é exibido quando o usuário expandir um menu que é adicionado ao menu do Microsoft Office.
	Visible	Obtém ou define um valor que indica se este RibbonControl é visível. (Herdado de RibbonControl.)

Superior

Métodos

	Nome	Descrição
	Dispose	Executa tarefas definido pelo aplicativo associadas liberando, liberando ou redefinindo recursos não gerenciados. (Herdado de IDisposable.)
	PerformDynamicLayout	Chama o método de Microsoft.Office.Core.IRibbonUI.InvalidateControl do controle pai se RibbonComponent tem um pai dinâmico, como um menu dinâmico, e layout não está suspenso. (Herdado de RibbonComponent.)
	PerformLayout	Chama Microsoft.Office.Core.IRibbonUI.InvalidateControl se RibbonComponent tem um pai e o layout não está suspenso. (Herdado de RibbonComponent.)
	ResumeLayout()	Inverte o efeito de método de SuspendLayout . (Herdado de RibbonComponent.)
	ResumeLayout(Boolean)	Inverte o efeito de método de SuspendLayout . (Herdado de RibbonComponent.)
	SuspendLayout	Impede que o aplicativo do Microsoft Office atualizar o estado de controles em fita. (Herdado de RibbonComponent.)

Superior

Eventos

	Nome	Descrição
	Disposed	Representa o método que manipula o Disposed o evento de um componente. (Herdado de IComponent.)
	ItemsLoading	Ocorre quando os controles ou menus aninhados são carregados no menu atual em tempo de execução.

Superior

Comentários

O Visual Studio cria um objeto de RibbonMenu quando você arrasta um controle de Menu de tabulação Controles de fita do Office de Caixa de Ferramentas no designer de fita.

Você pode criar RibbonMenu em tempo de execução usando o método de CreateRibbonMenu 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.

Tarefas comuns

A tabela a seguir lista os membros que são úteis para tarefas comuns.Todas essas tarefas podem ser realizadas em tempo de design.Algumas dessas tarefas podem ser realizadas em tempo de execução somente antes que a fita é carregada no aplicativo do Office ou antes que o controle é adicionado a um menu dinâmico em tempo de execução.Para obter mais informações, consulte Visão geral do modelo de objeto de faixa de opções.

Tarefa	Membro
Exibir uma imagem no menu.	Use a propriedade de Image ou de ImageName . Você também pode reutilizar as imagens que aparecem nos controles internos de fita.Para fazer isso, defina OfficeImageId para a identificação de uma imagem interna do Microsoft Office que você deseja exibir como o ícone do menu.
Alterar o tamanho do menu.	Defina a propriedade de ControlSize para o valor que você deseja.Por exemplo, para um grande menu, defina a Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge.
Alterar o tamanho dos itens no menu.	Defina a propriedade de ItemSize para o valor que você deseja.Por exemplo, para exibir itens maiores, defina como Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge.
Permitir alterações no menu em tempo de execução (por exemplo, para ativar os controles a serem adicionados em tempo de execução quando o menu).	Defina a propriedade Dynamic como true.
Acessar os controles no menu, adicionar controles ao menu, ou remova os controles de menu.	Use a propriedade Items.
Adicionar um menu para o menu do Microsoft Office, um grupo, ou outro controle que pode conter menus.	Adicione RibbonMenu à propriedade de Items no menu, do grupo, ou controle do Microsoft Office.

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 demonstra como adicionar em tempo de execução e preencher um submenu a um menu existente.

Para um exemplo mais detalhado que atualiza controles em tempo de execução e envolve obter os dados do banco de dados de exemplo AdventureWorks usando consultas integradas linguagem (LINQ), consulte Passo a passo: Atualizar os controles em uma faixa de opções em tempo de execução.

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 um grupo para a guia personalizado.
Adicionar um menu para o grupo.
Defina a propriedade de (Nome) de menu a CustomerMenu.
Defina a propriedade de Rótulo de menu para clientes.
Defina a propriedade de Dinâmico de menu a true.

Isso permite que você adicione em tempo de execução e remover controles no menu após a fita é carregada no aplicativo do Office.

Private Sub PopulateCustomerMenu()
    ' Add two sub-menus to EmployeeMenu and populate each sub-menu
    ' First sub-menu
    Dim subMenu1 As RibbonMenu = Me.Factory.CreateRibbonMenu()
    subMenu1.Dynamic = True
    subMenu1.Label = "A - M"
    subMenu1.Items.Add(Me.Factory.CreateRibbonToggleButton())
    CType(subMenu1.Items.Last(), RibbonToggleButton).Label = "Hall, Don"
    subMenu1.Items.Add(Me.Factory.CreateRibbonToggleButton())
    CType(subMenu1.Items.Last(), RibbonToggleButton).Label = "Valdez, Rachel"
    CustomerMenu.Items.Add(subMenu1)

    ' Second sub-menu
    Dim subMenu2 As RibbonMenu = Me.Factory.CreateRibbonMenu()
    subMenu2.Dynamic = True
    subMenu2.Label = "N - Z"
    subMenu2.Items.Add(Me.Factory.CreateRibbonToggleButton())
    CType(subMenu2.Items.Last(), RibbonToggleButton).Label = "Robinson, Alex"
    CustomerMenu.Items.Add(subMenu2)

End Sub

private void PopulateCustomerMenu()
{
    // Add two sub-menus to EmployeeMenu and populate each sub-menu
    // First sub-menu
    RibbonMenu subMenu1 = this.Factory.CreateRibbonMenu();
    subMenu1.Dynamic = true;
    subMenu1.Label = "A - M";
    subMenu1.Items.Add(this.Factory.CreateRibbonToggleButton());
    ((RibbonToggleButton)subMenu1.Items.Last()).Label = "Hall, Don";
    subMenu1.Items.Add(this.Factory.CreateRibbonToggleButton());
    ((RibbonToggleButton)subMenu1.Items.Last()).Label = "Valdez, Rachel";
    CustomerMenu.Items.Add(subMenu1);

    // Second sub-menu
    RibbonMenu subMenu2 = this.Factory.CreateRibbonMenu();
    subMenu2.Dynamic = true;
    subMenu2.Label = "N - Z";
    subMenu2.Items.Add(this.Factory.CreateRibbonToggleButton());
    ((RibbonToggleButton)subMenu2.Items.Last()).Label = "Robinson, Alex";
    CustomerMenu.Items.Add(subMenu2);
}