Export (0) Print
Expand All

RibbonCollectionBase Class

Provides access to the IRibbonExtension objects in a Ribbon customization.

System.Object
  Microsoft.Office.Tools.Ribbon.RibbonCollectionBase

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

public abstract class RibbonCollectionBase : IList<IRibbonExtension>, 
	ICollection<IRibbonExtension>, IEnumerable<IRibbonExtension>, IEnumerable, 
	IExtension

The RibbonCollectionBase type exposes the following members.

  NameDescription
Public methodRibbonCollectionBaseInfrastructure.
Top

  NameDescription
Public propertyBaseGets a IList<T> of IRibbonExtension objects in the RibbonCollectionBase.
Top

  NameDescription
Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetRibbon(Type)Infrastructure.
Public methodGetRibbon<TRibbon>()Infrastructure.
Public methodGetRibbonContextCollection(Object, Type)Infrastructure.
Public methodGetRibbonContextCollection<TRibbonCollection>(Object)Infrastructure.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

This collection contains all of the Ribbons that are associated with your Office customization. To access the RibbonCollectionBase object in an Office project, use the Globals.Ribbons property. For more information, see Global Access to Objects in Office Projects.

This collection can contain either all IRibbonExtension objects of any type in a Ribbon customization, or only those IRibbonExtension objects for a particular message class or Microsoft Office application.

Usage

This type is used only in Office projects that target the .NET Framework 4 and the .NET Framework 4.5. The assembly that defines this type is not part of the Visual Studio Tools for Office runtime. You must deploy this assembly with your solution. For more information, see Assemblies in the Visual Studio Tools for Office Runtime.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft