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.2.Core.dll

NuGet Package: DevExpress.RichEdit.Core

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

Declaration

C#

DocumentImageCollection Images { get; }

VB.NET

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.

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 snippets (auto-collected from DevExpress Examples) contain references to the Images property.

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#L29

Image imageToInsert = imageCollection1.Images[3];
richEditControl1.Document.Images.Insert(pos, imageToInsert);

how-to-retain-original-image-uri-in-html-document-e3189/CS/HTML_Export_ImageSourceExample/Form1.cs#L18

DocumentPosition pos = richEditControl1.Document.CaretPosition;
richEditControl1.Document.Images.Insert(pos, DocumentImageSource.FromUri(imageUri, null));
embedImagesCheck.EditValue = true;

how-to-manually-create-a-table-of-contents-t488553/CS/TableOfContentsExample/MainWindow.xaml.cs#L28

{
    DocumentImage shape = document.Images[i];
    Paragraph paragraph = document.Paragraphs.Insert(shape.Range.End);

word-document-api-examples/CS/CodeExamples/InlinePictureActions.cs#L27

document.LoadDocument("Documents\\Grimm.docx", DocumentFormat.OpenXml);
ReadOnlyDocumentImageCollection images = document.Images;
// If the width of an image exceeds 50 millimeters,

wpf-richedit-document-api/CS/DXRichEditControlAPISample/CodeExamples/InlinePicturesActions.cs#L34

document.LoadDocument("Documents//Grimm.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml);
ReadOnlyDocumentImageCollection images = document.Images;
// If the width of an image exceeds 50 millimeters,

VB.NET

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

Dim imageToInsert As Image = imageCollection1.Images(3)
richEditControl1.Document.Images.Insert(pos, imageToInsert)

how-to-retain-original-image-uri-in-html-document-e3189/VB/HTML_Export_ImageSourceExample/Form1.vb#L17

Dim pos As DocumentPosition = richEditControl1.Document.CaretPosition
richEditControl1.Document.Images.Insert(pos, DocumentImageSource.FromUri(imageUri, Nothing))
embedImagesCheck.EditValue = True

how-to-manually-create-a-table-of-contents-t488553/VB/TableOfContentsExample/MainWindow.xaml.vb#L25

For i As Integer = 0 To document.Images.Count - 1
    Dim shape As DocumentImage = document.Images(i)
    Dim paragraph As Paragraph = document.Paragraphs.Insert(shape.Range.End)

word-document-api-examples/VB/CodeExamples/InlinePictureActions.vb#L25

document.LoadDocument("Documents\Grimm.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml)
Dim images As DevExpress.XtraRichEdit.API.Native.ReadOnlyDocumentImageCollection = document.Images
' If the width of an image exceeds 50 millimeters,

wpf-richedit-document-api/VB/DXRichEditControlAPISample/CodeExamples/InlinePicturesActions.vb#L28

document.LoadDocument("Documents//Grimm.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml)
Dim images As ReadOnlyDocumentImageCollection = document.Images
' If the width of an image exceeds 50 millimeters,