Class ImageObjectCollection

Observable collection of image objects

Inheritance

System.Object

ImageObjectCollection

Implements

IWordImageObjectCollection

System.Collections.Generic.IList<ImageContent>

System.Collections.Generic.ICollection<ImageContent>

System.Collections.Generic.IEnumerable<ImageContent>

System.Collections.IEnumerable

IronSoftware.Abstractions.IJsonSerializable

Namespace: IronWord.Models

Assembly: IronWord.dll

Syntax

public class ImageObjectCollection : ObservableCollection<ImageContent>, IWordImageObjectCollection

Every image pulled out of a Word document arrives grouped in an ImageObjectCollection, so you work with the whole set in one pass rather than chasing individual pictures. The collection holds ImageContent entries and behaves as an observable list, which means changes to it are tracked as you add or remove members.

You rarely construct one directly. It is the shape ExtractImages hands back when you read pictures from a document, body, or table cell, and you iterate it to inspect or re-save each ImageContent. Because it derives from ObservableCollection<ImageContent>, the usual list operations (indexing, foreach, Count) all apply. Items exposes the backing entries, IsReadOnly reports whether the collection can be modified, and ToJson serializes the set when you need a portable record of the images. Pair it with ImageContent for per-image detail and with the document extraction call that produces it.

foreach (ImageContent image in document.ExtractImages())
    image.SaveAs("logo.png");

The extract images how-to walks through pulling pictures from a document, and the add image example shows the matching write path.

Constructors

ImageObjectCollection()

Create a new empty image object collection

Declaration

public ImageObjectCollection()

ImageObjectCollection(IList<ImageContent>)

Declaration

public ImageObjectCollection(IList<ImageContent> items)

Parameters

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

Properties

IsReadOnly

Declaration

public bool IsReadOnly { get; }

Property Value

Type	Description
System.Boolean

Items

Declaration

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

Property Value

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

Methods

ToJson()

Declaration

public string ToJson()

Returns

Type	Description
System.String

Implements

IWordImageObjectCollection

System.Collections.Generic.IList<>

System.Collections.Generic.ICollection<>

System.Collections.Generic.IEnumerable<>

System.Collections.IEnumerable

IronSoftware.Abstractions.IJsonSerializable