.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
A newer version of this page is available. Switch to the current version.

ReadOnlyDocumentImageCollection Interface

A read-only collection of document images (DocumentImage objects).

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

[ComVisible(true)]
public interface ReadOnlyDocumentImageCollection :
    ISimpleCollection<DocumentImage>,
    IEnumerable<DocumentImage>,
    IEnumerable,
    ICollection
<ComVisible(True)>
Public Interface ReadOnlyDocumentImageCollection
    Inherits ISimpleCollection(Of DocumentImage),
             IEnumerable(Of DocumentImage),
             IEnumerable,
             ICollection

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.

Examples

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.

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
See Also