Interface RibbonMenu

Artigo
08/01/2011

Representa um menu em uma guia da faixa de opções ou no Menu de 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 modificado 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 Microsoft Office usa para identificar esse RibbonControl objeto. (Herdado de RibbonControl.)
	Image	Obtém ou define a imagem é exibida no menu.
	ImageName	Obtém ou define o nome que você pode usar o LoadImage o manipulador de eventos 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 menu.
	Label	Obtém ou define o texto que é exibido pelo menu.
	Name	Obtém ou define o nome deste RibbonComponent. (Herdado de RibbonComponent.)
	OfficeImageId	Obtém ou define a imagem seja exibida no menu, se você quiser usar um ícone de Microsoft Office interno.
	Parent	Obtém um RibbonComponent que representa o pai RibbonComponent. (Herdado de RibbonComponent.)
	Position	Obtém ou define a posição do menu, se o menu estiver no Menu de Microsoft Office.
	Ribbon	Obtém um nível superior Ribbon objeto que contém a hierarquia de controle. (Herdado de RibbonComponent.)
	RibbonUI	Infraestrutura. Obtém o IRibbonUI instância que é fornecida pelo aplicativo de Microsoft Office para o código de extensibilidade da faixa de opções. (Herdado de RibbonComponent.)
	ScreenTip	Obtém ou define o texto de dica 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 está visível.
	ShowLabel	Obtém ou define um valor que indica se o rótulo para o menu está 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á associados esta RibbonComponent. (Herdado de RibbonComponent.)
	Title	Obtém ou define o título que é exibido quando o usuário expande um menu que é adicionado ao Menu de Microsoft Office.
	Visible	Obtém ou define um valor que indica se este RibbonControl está visível. (Herdado de RibbonControl.)

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.)
	PerformDynamicLayout	Chamadas a Microsoft.Office.Core.IRibbonUI.InvalidateControl método do pai de controle se o RibbonComponent tem um pai dinâmico, como, por exemplo, um menu dinâmico, e o layout não for suspensa. (Herdado de RibbonComponent.)
	PerformLayout	Chamadas Microsoft.Office.Core.IRibbonUI.InvalidateControl se a RibbonComponent tem um pai e o layout não for suspensa. (Herdado de RibbonComponent.)
	ResumeLayout()	Reverte o efeito da SuspendLayout método. (Herdado de RibbonComponent.)
	ResumeLayout(Boolean)	Reverte o efeito da SuspendLayout método. (Herdado de RibbonComponent.)
	SuspendLayout	Impede que o aplicativo Microsoft Office o estado dos controles da faixa de opções de atualização. (Herdado de RibbonComponent.)

Início

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.

Início

Comentários

Visual Studio cria um RibbonMenu objeto quando você arrasta um Menu de controle da Controles de faixa de opções do Office guia da Toolbox para o Designer de faixa de opções.

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

Tarefas comuns

A tabela a seguir lista os membros que são úteis para tarefas comuns. Todas essas tarefas podem ser executadas em tempo de design. Algumas dessas tarefas podem ser executadas em tempo de execução antes da faixa de opções é carregada em um aplicativo do Office ou antes do controle é adicionado a um menu dinâmico em tempo de execução. For more information, see Visão geral do modelo de objeto de faixa de opções.

Task	Member
Exiba uma imagem no menu.	Use o Image ou ImageName propriedade. Também é possível reutilizar as imagens que aparecem em controles internos da faixa de opções. Para fazer isso, defina OfficeImageId para a identificação de uma imagem de Microsoft Office interna que você deseja exibir como um ícone para o menu.
Altere o tamanho do menu.	Definir o ControlSize propriedade para o valor que desejar. Por exemplo, para um vasto menu, defina-a Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge.
Altere o tamanho dos itens no menu.	Definir o ItemSize propriedade para o valor que desejar. Por exemplo, para exibir itens maiores, defini-la com Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge.
Habilite alterações para o menu em tempo de execução (por exemplo, para ativar os controles a serem adicionados ao menu em tempo de execução).	Set the Dynamic property to true.
Acessar os controles no menu, adicionar controles para o menu ou remover controles do menu.	Use o Items propriedade.
Adicione um menu no menu de Microsoft Office, um grupo, ou para um outro controle que pode conter menus.	Adicionar um RibbonMenu para o Items a propriedade do Menu de Microsoft Office, grupo ou controle.

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

Para obter um exemplo mais rico que atualiza controles em tempo de execução e envolve a obtenção de dados do banco de dados de exemplo AdventureWorks usando integrada consultas (LINQ), consulte Demonstra Passo a passo: A atualização de controles em uma faixa de opções em tempo de execução.

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.
Adicione um grupo à guia personalizada.
Adicione um menu para o grupo.
Definir o (nome) a propriedade do menu para CustomerMenu.
Definir o rótulo a propriedade do menu para os clientes.
Definir o dinâmico a propriedade do menu para true.

Isso lhe permite adicionar e remover os controles no menu em tempo de execução após a faixa de opções é 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);
}