ReadOnlyDocumentImageCollection Interface

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

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Package: DevExpress.RichEdit.Core

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.WindowsDesktop.RichEdit.Core

Declaration

C#

[ComVisible(true)]
public interface ReadOnlyDocumentImageCollection :
    ISimpleCollection<DocumentImage>,
    IEnumerable<DocumentImage>,
    IEnumerable,
    ICollection

VB.NET

<ComVisible(True)>
Public Interface ReadOnlyDocumentImageCollection
    Inherits ISimpleCollection(Of DocumentImage),
             IEnumerable(Of DocumentImage),
             IEnumerable,
             ICollection

Related API Members

The following members return ReadOnlyDocumentImageCollection objects:

• ReadOnlyDocumentImageCollection.Get(DocumentRange)

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.

Example

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

View Example

InlinePictureActions.cs

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);
}

InlinePictureActions.vb

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

' Obtain all images im the specific range:
Dim images As ReadOnlyDocumentImageCollection = document.Images.Get(myRange)

' Export the retrieved images as png files:
If images.Count > 0 Then
    Dim myImage As DevExpress.Office.Utils.OfficeImage = images(0).Image
    Dim image As System.Drawing.Image = myImage.NativeImage
    Dim imageName As String = String.Format("Image_at_pos_{0}.png", images(0).Range.Start.ToInt())
    image.Save(imageName)
    System.Diagnostics.Process.Start("explorer.exe", "/select," & imageName)
End If

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ReadOnlyDocumentImageCollection interface.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

inline-pictures-in-richeditcontrol-e1525/CS/InlinePictures/Form1.cs#L67

    DevExpress.Office.DocumentUnit.Millimeter;
ReadOnlyDocumentImageCollection images =
    richEditControl1.Document.Images.Get(richEditControl1.Document.Range);

VB.NET

inline-pictures-in-richeditcontrol-e1525/VB/InlinePictures/Form1.vb#L66

richEditControl1.Document.Unit = DevExpress.Office.DocumentUnit.Millimeter
Dim images As ReadOnlyDocumentImageCollection = richEditControl1.Document.Images.Get(richEditControl1.Document.Range)