Web-Extension Collection Classes

Web-Extension Collection Classes

This guide shows how the four web-extension collection classes in Aspose.Words FOSS for .NET — TaskPaneCollection, WebExtensionBindingCollection, WebExtensionPropertyCollection, and WebExtensionReferenceCollection — share a single collection contract through the abstract BaseWebExtensionCollection base class. For what task panes, bindings, and web extension properties actually represent, see the Web Extensions guide; this page covers only the container API they all share.

BaseWebExtensionCollection: One Contract, Four Collections

BaseWebExtensionCollection is the base class for TaskPaneCollection, WebExtensionBindingCollection, WebExtensionPropertyCollection, and WebExtensionReferenceCollection. It implements IEnumerable<T> and defines every member these four concrete collections expose — none of the four subclasses declares additional methods or properties of its own beyond what the base class provides.

Adding, Removing, and Counting Items

Add(item) adds the specified item to the collection. Clear() removes all elements. Remove(index) removes the item at the specified index — it takes a positional index, not an item reference, so removing a specific item means first locating its index. Count reports the number of elements currently in the collection.

Enumerating a Collection

GetEnumerator() returns an enumerator that can iterate through the collection, so any BaseWebExtensionCollection-derived collection supports a foreach loop over its items without type-specific iteration code.

Tips and Best Practices

• Because all four collections share the same base contract, code written against BaseWebExtensionCollection’s Add, Clear, Remove, Count, and GetEnumerator members works uniformly across TaskPaneCollection, WebExtensionBindingCollection, WebExtensionPropertyCollection, and WebExtensionReferenceCollection.
• Remove(index) takes a positional index — if you only have the item itself, enumerate the collection to find its index first, or track the index at insertion time.
• Read Count before iterating, or foreach over the collection directly with GetEnumerator() rather than indexing manually, since the base contract does not expose a positional getter.
• Call Clear() when you need to reset a collection rather than repeatedly calling Remove in a loop.

Common Issues

FAQ

Why do the four web-extension collections behave the same way?

They all derive from the same abstract base class, BaseWebExtensionCollection, which defines Add, Clear, Remove, Count, and GetEnumerator — none of the four subclasses adds its own members.

How do I remove a specific item from one of these collections?

Call Remove(index) with the item’s positional index — locate the index by enumerating the collection first if you only have the item reference.

Can I iterate any of these four collections the same way?

Yes — all four implement IEnumerable<T> through BaseWebExtensionCollection, so GetEnumerator() / foreach works identically across them.

Where do I learn what a WebExtensionBinding or TaskPane item actually represents?

See the Web Extensions guide — this page covers only the shared collection container behavior, not the domain objects the collections hold.

API Reference Summary

See Also

• Aspose.Words — Enterprise Documentation