RibbonOfficeMenu Interface

Definition

public interface class RibbonOfficeMenu : IDisposable, Microsoft::Office::Tools::Ribbon::RibbonComponent, System::ComponentModel::IComponent

[System.Runtime.InteropServices.Guid("49cea6a9-3670-4ae0-9a36-9305e27f302b")]
public interface RibbonOfficeMenu : IDisposable, Microsoft.Office.Tools.Ribbon.RibbonComponent, System.ComponentModel.IComponent

[<System.Runtime.InteropServices.Guid("49cea6a9-3670-4ae0-9a36-9305e27f302b")>]
type RibbonOfficeMenu = interface
    interface RibbonComponent
    interface IComponent
    interface IDisposable

Public Interface RibbonOfficeMenu
Implements IComponent, IDisposable, RibbonComponent

Attributes

GuidAttribute

Implements

RibbonComponent IComponent IDisposable

Examples

The following example iterates through the custom controls on the Ribbon Office menu and displays their name. To run this code example, you must first perform the following steps:

1. Add a Ribbon (Visual Designer) item to an Office project.

2. Add a button to the Microsoft Office Button.

3. Set the (Name) property of the button to myOfficeMenuButton.

4. Set the PositionType property to AfterOfficeID under the Position property.

5. Set the OfficeID property to FilePrintMenu under the Position property.

private void ListOfficeRibbonCustomControls()
{
    System.Windows.Forms.MessageBox.Show(
        "Listing all Office Menu custom controls...");
    foreach (RibbonComponent control in Globals.Ribbons.Ribbon1.OfficeMenu.Items)
    {
        System.Windows.Forms.MessageBox.Show("Control name: " + control.Name);
    }
}

Private Sub ListOfficeRibbonCustomControls()
    System.Windows.Forms.MessageBox.Show( _
            "Listing all Office Menu custom controls...")
    For Each control As RibbonComponent In Globals.Ribbons.Ribbon1.OfficeMenu.Items
        System.Windows.Forms.MessageBox.Show("Control name: " + control.Name)
    Next
End Sub

Remarks

When you add a Ribbon (Visual Designer) item to your project, Visual Studio automatically assigns a new RibbonOfficeMenu object to the OfficeMenu property of the generated OfficeRibbon interface. Use this object to add new controls to the Microsoft Office Menu at run time, or to access controls that you added to the Microsoft Office Menu.

You can add controls at run time, but only before the Ribbon is loaded. Create an instance of the control, and then add the new control to the Items collection. For more information, see Ribbon Object Model Overview.

Usage

This documentation describes the version of this type that is used in Office projects that target the .NET Framework 4 or later. In projects that target the .NET Framework 3.5, this type might have different members and the code examples provided for this type might not work. For documentation about this type in projects that target the .NET Framework 3.5, see the following reference section in the Visual Studio 2008 documentation: http://go.microsoft.com/fwlink/?LinkId=160658.

Properties

Methods

Applies to