Represents a Microsoft Office Ribbon customization that is created by using the Ribbon Designer in an Office project in Visual Studio.
Assemblies: Microsoft.Office.Tools.Common.v4.0.Utilities (in Microsoft.Office.Tools.Common.v4.0.Utilities.dll)
Microsoft.Office.Tools.Common (in Microsoft.Office.Tools.Common.dll)
Thetype exposes the following members.
|Context||Gets the Inspector window, or the Explorer window in Outlook, that is associated with this Ribbon.|
|DefaultExtension||Gets the default extension for this object.|
|Extension||Gets a custom extension for this object.|
|Global||Gets or sets a value that determines whether this can be used in multiple contexts simultaneously.|
|Name||Gets or sets the name of this RibbonComponent. (Inherited from RibbonComponent.)|
|OfficeMenu||Gets a RibbonOfficeMenu that represents the Microsoft Office Menu customization.|
|Parent||Gets a RibbonComponent that represents the parent of this RibbonComponent. (Inherited from RibbonComponent.)|
|Ribbon||Gets the top-level Ribbon object that contains the control hierarchy. (Inherited from RibbonComponent.)|
|RibbonId||Gets the Ribbon ID that was used to create this instance of the object.|
|RibbonType||Gets a comma-separated list of Ribbon IDs that are associated with this instance.|
|RibbonUI||Infrastructure. Gets the IRibbonUI instance that is provided by the Microsoft Office application to the Ribbon extensibility code. (Inherited from RibbonComponent.)|
|Site||Gets or sets the ISite associated with the IComponent. (Inherited from IComponent.)|
|StartFromScratch||Gets or sets a value that indicates whether to hide all built-in tabs on the Ribbon and most commands on the Microsoft Office Menu and display only the customizations that are defined in this Ribbon item.|
|Tabs||Gets a collection of RibbonTab objects in the RibbonOfficeMenu.|
|Tag||Gets or sets application-specific data that is associated with this RibbonComponent. (Inherited from RibbonComponent.)|
|Dispose||Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.)|
|PerformDynamicLayout||Calls the Microsoft.Office.Core.IRibbonUI.InvalidateControl method of the parent control if the RibbonComponent has a dynamic parent, such as a dynamic menu, and layout is not suspended. (Inherited from RibbonComponent.)|
|PerformLayout||Calls Microsoft.Office.Core.IRibbonUI.InvalidateControl if the RibbonComponent has a parent and layout is not suspended. (Inherited from RibbonComponent.)|
|ResumeLayout()||Reverses the effect of the SuspendLayout method. (Inherited from RibbonComponent.)|
|ResumeLayout(Boolean)||Reverses the effect of the SuspendLayout method. (Inherited from RibbonComponent.)|
|SuspendLayout||Prevents the Microsoft Office application from refreshing the state of controls on the Ribbon. (Inherited from RibbonComponent.)|
|Close||Occurs when this instance is closing.|
|Disposed||Represents the method that handles the Disposed event of a component. (Inherited from IComponent.)|
|Load||Occurs when the is loaded into the Microsoft Office application.|
|LoadImage||Occurs when the loads, if the ImageName property is set for one or more controls.|
You typically do not use the interface directly. Instead, use the Ribbon class that Visual Studio generates when you add a new Ribbon (Visual Designer) item to your project. You can accomplish most tasks related to the Ribbon by using events and properties in the generated Ribbon class.
The generated Ribbon class inherits from the RibbonBase class. This base class redirects all calls to its members to an internal implementation of the interface the Visual Studio Tools for Office runtime. If you want to work with the object directly, use the Base property of the generated Ribbon class.
This interface is implemented by the Visual Studio Tools for Office runtime. It is not intended to be implemented in your code. For more information, see Visual Studio Tools for Office Runtime Overview.
This documentation describes the version of this type that is used in Office projects that target the .NET Framework 4 and the .NET Framework 4.5. 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.