RibbonCollectionBase Class

Provides access to the IRibbonExtension objects in a Ribbon customization.

Inheritance Hierarchy

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)

Syntax

'Declaration
Public MustInherit Class RibbonCollectionBase _
    Implements IList(Of IRibbonExtension), ICollection(Of IRibbonExtension),  _
    IEnumerable(Of IRibbonExtension), IEnumerable, IExtension
public abstract class RibbonCollectionBase : IList<IRibbonExtension>, 
    ICollection<IRibbonExtension>, IEnumerable<IRibbonExtension>, IEnumerable, 
    IExtension

The RibbonCollectionBase type exposes the following members.

Constructors

  Name Description
Public method RibbonCollectionBase Infrastructure.

Top

Properties

  Name Description
Public property Base Gets a IList<T> of IRibbonExtension objects in the RibbonCollectionBase.

Top

Methods

  Name Description
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetRibbon(Type) Infrastructure.
Public method GetRibbon<TRibbon>() Infrastructure.
Public method GetRibbonContextCollection(Object, Type) Infrastructure.
Public method GetRibbonContextCollection<TRibbonCollection>(Object) Infrastructure.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method ICollection<IRibbonExtension>.Add Infrastructure.
Explicit interface implemetationPrivate method ICollection<IRibbonExtension>.Clear Infrastructure.
Explicit interface implemetationPrivate method ICollection<IRibbonExtension>.Contains Infrastructure.
Explicit interface implemetationPrivate method ICollection<IRibbonExtension>.CopyTo Infrastructure.
Explicit interface implemetationPrivate property ICollection<IRibbonExtension>.Count Infrastructure.
Explicit interface implemetationPrivate method IEnumerable<IRibbonExtension>.GetEnumerator Infrastructure.
Explicit interface implemetationPrivate method IEnumerable.GetEnumerator Infrastructure.
Explicit interface implemetationPrivate method IList<IRibbonExtension>.IndexOf Infrastructure.
Explicit interface implemetationPrivate method IList<IRibbonExtension>.Insert Infrastructure.
Explicit interface implemetationPrivate property ICollection<IRibbonExtension>.IsReadOnly Infrastructure.
Explicit interface implemetationPrivate property IList<IRibbonExtension>.Item Infrastructure.
Explicit interface implemetationPrivate method ICollection<IRibbonExtension>.Remove Infrastructure.
Explicit interface implemetationPrivate method IList<IRibbonExtension>.RemoveAt Infrastructure.
Explicit interface implemetationPrivate property IExtension.ExtensionBase Infrastructure.

Top

Remarks

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.

Thread Safety

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

See Also

Reference

Microsoft.Office.Tools.Ribbon Namespace