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.v19.1.Core.dll
Declaration
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 following example examines all images in the document. If the width of an image exceeds 50 millimeters, the image is scaled proportionally to half its size.
Note
A complete sample project is available at https://github.com/DevExpress-Examples/winforms-richedit-document-api-e5219
document.LoadDocument("Grimm.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml)
Dim images As ReadOnlyDocumentImageCollection = document.Images
' If the width of an image exceeds 50 millimeters,
' the image is scaled proportionally to half its size.
For i As Integer = 0 To images.Count - 1
If images(i).Size.Width > DevExpress.Office.Utils.Units.MillimetersToDocumentsF(50) Then
images(i).ScaleX /= 2
images(i).ScaleY /= 2
End If
Next i
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.