RibbonCollectionBase Class

Definition

Namespace:

Microsoft.Office.Tools.Ribbon

Assembly:

Microsoft.Office.Tools.Common.v4.0.Utilities.dll

Provides access to the IRibbonExtension objects in a Ribbon customization.

C#

public abstract class RibbonCollectionBase : Microsoft.Office.Tools.IExtension, System.Collections.Generic.ICollection<Microsoft.Office.Tools.Ribbon.IRibbonExtension>, System.Collections.Generic.IEnumerable<Microsoft.Office.Tools.Ribbon.IRibbonExtension>, System.Collections.Generic.IList<Microsoft.Office.Tools.Ribbon.IRibbonExtension>

Inheritance

Object

RibbonCollectionBase

Implements

IExtension ICollection<IRibbonExtension> ICollection<T> IEnumerable<IRibbonExtension> IEnumerable<T> IList<IRibbonExtension> IEnumerable

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

Constructors

RibbonCollectionBase(RibbonFactory)

Properties

Base	Gets a IList<T> of IRibbonExtension objects in the RibbonCollectionBase.

Methods

GetRibbon(Type)

GetRibbon<TRibbon>()

GetRibbonContextCollection(Object, Type)

GetRibbonContextCollection<TRibbonCollection>(Object)

Explicit Interface Implementations

ICollection<IRibbonExtension>.Add(IRibbonExtension)

ICollection<IRibbonExtension>.Clear()

ICollection<IRibbonExtension>.Contains(IRibbonExtension)

ICollection<IRibbonExtension>.CopyTo(IRibbonExtension[], Int32)

ICollection<IRibbonExtension>.Count

ICollection<IRibbonExtension>.IsReadOnly

ICollection<IRibbonExtension>.Remove(IRibbonExtension)

IEnumerable.GetEnumerator()

IEnumerable<IRibbonExtension>.GetEnumerator()

IExtension.ExtensionBase

IList<IRibbonExtension>.IndexOf(IRibbonExtension)

IList<IRibbonExtension>.Insert(Int32, IRibbonExtension)

IList<IRibbonExtension>.Item[Int32]

IList<IRibbonExtension>.RemoveAt(Int32)

Applies to