ReadOnlyDocumentImageCollection Interface
A read-only collection of document images (DocumentImage objects).
Namespace: DevExpress.XtraRichEdit.API.Native
Assembly: DevExpress.RichEdit.v19.1.Core.dll
Declaration
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(DocumentRange range) 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 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 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.