Class ShapeObjectCollection

Observable collection of path objects

Inheritance

System.Object

ShapeObjectCollection

Implements

IWordShapeObjectCollection

System.Collections.Generic.IList<ShapeContent>

System.Collections.Generic.ICollection<ShapeContent>

System.Collections.Generic.IEnumerable<ShapeContent>

System.Collections.IEnumerable

IronSoftware.Abstractions.IJsonSerializable

Namespace: IronWord.Models

Assembly: IronWord.dll

Syntax

public class ShapeObjectCollection : ObservableCollection<ShapeContent>, IWordShapeObjectCollection

Holding the inline shapes that belong together in a Word document runs through ShapeObjectCollection. It gathers a group of ShapeContent items, the figures embedded in the document's content, into one observable list a developer can build up, iterate, and serialize. It is the container a developer works through when several shapes are managed as a set rather than one at a time.

Because it derives from ObservableCollection<ShapeContent>, the collection notifies on change and supports the usual list operations inherited from that base, so a developer adds, indexes, and enumerates shapes through the standard collection surface. A developer either starts an empty collection or seeds one from an existing IList<ShapeContent> passed to the constructor, which fits the collection into the shape-building flow alongside the runs and content that carry those shapes.

Construct a ShapeObjectCollection with its parameterless constructor or from an IList<ShapeContent>, then add and iterate ShapeContent items using the inherited list operations. Items exposes the underlying list and IsReadOnly reports whether the collection can be modified, while ToJson serializes the whole set to JSON for storage or transport. Treat it as a typed, observable group of inline shapes: build the set, enumerate it to read each ShapeContent, and serialize when the collection needs to be persisted.

The add image how-to covers placing visual content, and the document element tutorial shows how shapes fit the document model.

Constructors

ShapeObjectCollection()

Create a new empty path object collection

Declaration

public ShapeObjectCollection()

ShapeObjectCollection(IList<ShapeContent>)

Declaration

public ShapeObjectCollection(IList<ShapeContent> items)

Parameters

Type	Name	Description
System.Collections.Generic.IList<ShapeContent>	items

Properties

IsReadOnly

Declaration

public bool IsReadOnly { get; }

Property Value

Type	Description
System.Boolean

Items

Declaration

public IList<ShapeContent> Items { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<ShapeContent>

Methods

ToJson()

Declaration

public string ToJson()

Returns

Type	Description
System.String

Implements

IWordShapeObjectCollection

System.Collections.Generic.IList<>

System.Collections.Generic.ICollection<>

System.Collections.Generic.IEnumerable<>

System.Collections.IEnumerable

IronSoftware.Abstractions.IJsonSerializable