.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+

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.v20.1.Core.dll

Declaration

DocumentImageCollection Images { get; }
ReadOnly Property Images As DocumentImageCollection

Property Value

Type Description
DocumentImageCollection

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

Remarks

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.

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