OfficeRibbon Interface

 

Represents a Microsoft Office Ribbon customization that is created by using the Ribbon Designer in an Office project in Visual Studio.

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

[GuidAttribute("49fbf223-6d24-4c4b-9101-2d5833434328")]
public interface OfficeRibbon : RibbonComponent, IComponent, 
	IDisposable

NameDescription
System_CAPS_pubpropertyContext

Gets the Inspector window, or the Explorer window in Outlook, that is associated with this Ribbon.

System_CAPS_pubpropertyDefaultExtension

Gets the default extension for this OfficeRibbon object.

System_CAPS_pubpropertyExtension

Gets a custom extension for this OfficeRibbon object.

System_CAPS_pubpropertyGlobal

Gets or sets a value that determines whether this OfficeRibbon can be used in multiple contexts simultaneously.

System_CAPS_pubpropertyName

Gets or sets the name of this RibbonComponent.(Inherited from RibbonComponent.)

System_CAPS_pubpropertyOfficeMenu

Gets a RibbonOfficeMenu that represents the Microsoft Office Menu customization.

System_CAPS_pubpropertyParent

Gets a RibbonComponent that represents the parent of this RibbonComponent.(Inherited from RibbonComponent.)

System_CAPS_pubpropertyRibbon

Gets the top-level Ribbon object that contains the control hierarchy.(Inherited from RibbonComponent.)

System_CAPS_pubpropertyRibbonId

Gets the Ribbon ID that was used to create this instance of the OfficeRibbon object.

System_CAPS_pubpropertyRibbonType

Gets a comma-separated list of Ribbon IDs that are associated with this OfficeRibbon instance.

System_CAPS_pubpropertyRibbonUI

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the IRibbonUI instance that is provided by the Microsoft Office application to the Ribbon extensibility code.(Inherited from RibbonComponent.)

System_CAPS_pubpropertySite

(Inherited from IComponent.)

System_CAPS_pubpropertyStartFromScratch

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.

System_CAPS_pubpropertyTabs

Gets a collection of RibbonTab objects in the RibbonOfficeMenu.

System_CAPS_pubpropertyTag

Gets or sets application-specific data that is associated with this RibbonComponent.(Inherited from RibbonComponent.)

NameDescription
System_CAPS_pubmethodDispose()

(Inherited from IDisposable.)

System_CAPS_pubmethodPerformDynamicLayout()

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.)

System_CAPS_pubmethodPerformLayout()

Calls Microsoft.Office.Core.IRibbonUI.InvalidateControl if the RibbonComponent has a parent and layout is not suspended.(Inherited from RibbonComponent.)

System_CAPS_pubmethodResumeLayout()

Reverses the effect of the SuspendLayout method.(Inherited from RibbonComponent.)

System_CAPS_pubmethodResumeLayout(Boolean)

Reverses the effect of the SuspendLayout method.(Inherited from RibbonComponent.)

System_CAPS_pubmethodSuspendLayout()

Prevents the Microsoft Office application from refreshing the state of controls on the Ribbon.(Inherited from RibbonComponent.)

NameDescription
System_CAPS_pubeventClose

Occurs when this OfficeRibbon instance is closing.

System_CAPS_pubeventDisposed

(Inherited from IComponent.)

System_CAPS_pubeventLoad

Occurs when the OfficeRibbon is loaded into the Microsoft Office application.

System_CAPS_pubeventLoadImage

Occurs when the OfficeRibbon loads, if the ImageName property is set for one or more controls.

You typically do not use the OfficeRibbon 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 OfficeRibbon interface the Visual Studio Tools for Office runtime. If you want to work with the OfficeRibbon object directly, use the Base property of the generated Ribbon class.

System_CAPS_noteNote

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 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.

Return to top
Show: