Skip to main content
.NET Framework 4.5.2+

SubDocument.Images Property

Provides access to the collection of all images (inline and floating pictures) in the document .

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v23.1.Core.dll

NuGet Package: DevExpress.RichEdit.Core


DocumentImageCollection Images { get; }

Property Value

Type Description

A DocumentImageCollection object that is a collection of images in the current document.


To get a collection of images located in the specified range, call the Get method of the DocumentImageCollection object. Use a ReadOnlyDocumentImageCollection collection returned by this method to count images in the document or access individual images.

To access document shapes, use the SubDocument.Shapes property.


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

View Example

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());
    System.Diagnostics.Process.Start("explorer.exe", "/select," + imageName);

The following code snippets (auto-collected from DevExpress Examples) contain references to the Images property.


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.

See Also