.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
.NET Core 3.0+

ReadOnlyDocumentImageCollection Interface

A read-only collection of document images (DocumentImage objects).

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v19.2.Core.dll

Declaration

[ComVisible(true)]
public interface ReadOnlyDocumentImageCollection :
    ISimpleCollection<DocumentImage>,
    IEnumerable<DocumentImage>,
    IEnumerable,
    ICollection
<ComVisible(True)>
Public Interface ReadOnlyDocumentImageCollection
    Inherits ISimpleCollection(Of DocumentImage),
             IEnumerable(Of DocumentImage),
             IEnumerable,
             ICollection
[ComVisible(true)]
public interface ReadOnlyDocumentImageCollection :
    ISimpleCollection<DocumentImage>,
    IEnumerable<DocumentImage>,
    IEnumerable,
    ICollection
<ComVisible(True)>
Public Interface ReadOnlyDocumentImageCollection
    Inherits ISimpleCollection(Of DocumentImage),
             IEnumerable(Of DocumentImage),
             IEnumerable,
             ICollection
[ComVisible(true)]
public interface ReadOnlyDocumentImageCollection :
    ISimpleCollection<DocumentImage>,
    IEnumerable<DocumentImage>,
    IEnumerable,
    ICollection
<ComVisible(True)>
Public Interface ReadOnlyDocumentImageCollection
    Inherits ISimpleCollection(Of DocumentImage),
             IEnumerable(Of DocumentImage),
             IEnumerable,
             ICollection

Remarks

The ReadOnlyDocumentImageCollection object specifies a collection of images located in a document range. You can access individual items of this collection, but you cannot add or delete items. Use index notation to obtain an individual DocumentImage object from this collection.

To access the ReadOnlyDocumentImageCollection object, use the RichEditControl.Document.Images.Get or RichEditDocumentServer.Document.Images.Get method notation.

The ReadOnlyDocumentImageCollection interface also serves as a base for the DocumentImageCollection interface, which specifies the collection of images in the document.

Examples

The code sample below retrieves all images in the specific document range and exports them in the PNG format.

Document document = server.Document;
document.LoadDocument("Documents\\MovieRentals.docx", DocumentFormat.OpenXml);
DocumentRange myRange = document.CreateRange(0, 100);

// Obtain all images im the specific range:
ReadOnlyDocumentImageCollection images = document.Images.Get(myRange);

// Export the retrieved images as png files:
if (images.Count > 0)
{
    DevExpress.Office.Utils.OfficeImage myImage = images[0].Image;
    System.Drawing.Image image = myImage.NativeImage;
    string imageName = String.Format("Image_at_pos_{0}.png", images[0].Range.Start.ToInt());
    image.Save(imageName);
    System.Diagnostics.Process.Start("explorer.exe", "/select," + imageName);
}
See Also