ReadOnlyDocumentImageCollection.Get(DocumentRange) Method

Gets all images (inline and floating pictures) located in the specified document range.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

ReadOnlyDocumentImageCollection Get(
    DocumentRange range
)

VB.NET

Function Get(
    range As DocumentRange
) As ReadOnlyDocumentImageCollection

Parameters

Name	Type	Description
range	DocumentRange	A DocumentRange specifying the range in which to search for images.

Returns

Type	Description
ReadOnlyDocumentImageCollection	A ReadOnlyDocumentImageCollection object specifying the read-only collection of images.

Remarks

The method can be accessed using the RichEditControl.Document.Images.Get notation.

Note

If you operate with a selection range, the Get method should be enclosed within a DocumentRange.BeginUpdateDocument - DocumentRange.EndUpdateDocument method pair. Otherwise, an incorrect document model might be selected, resulting in an exception “Error: specified document position or range belongs to other document or subdocument” being thrown.

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

InlinePictures.vb

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

InlinePictures.cs

document.LoadDocument("Grimm.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml);
ReadOnlyDocumentImageCollection images = document.Images;
// If the width of an image exceeds 50 millimeters, 
// the image is scaled proportionally to half its size.
for (int i = 0; i < images.Count; i++)
{
    if (images[i].Size.Width > DevExpress.Office.Utils.Units.MillimetersToDocumentsF(50))
    {
        images[i].ScaleX /= 2;
        images[i].ScaleY /= 2;
    }
}

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Get(DocumentRange) method.

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#

wpf-richedit-document-api-t213968/CS/DXRichEditControlAPISample/CodeExamples/ExportActions.cs#L18

DocumentRange docRange = document.Paragraphs[2].Range;
ReadOnlyDocumentImageCollection docImageColl = document.Images.Get(docRange);
if (docImageColl.Count > 0)

winforms-richedit-document-api-e5219/CS/RichEditAPISample/CodeExamples/Export.cs#L17

DocumentRange docRange = document.Paragraphs[2].Range;
ReadOnlyDocumentImageCollection docImageColl = document.Images.Get(docRange);
if (docImageColl.Count > 0)

word-document-api-examples/CS/CodeExamples/ExportActions.cs#L23

DocumentRange docRange = document.Paragraphs[2].Range;
ReadOnlyDocumentImageCollection docImageColl = document.Images.Get(docRange);
if (docImageColl.Count > 0)

inline-pictures-in-richeditcontrol-e1525/CS/InlinePictures/Form1.cs#L68

ReadOnlyDocumentImageCollection images =
    richEditControl1.Document.Images.Get(richEditControl1.Document.Range);

document-layout-api-practical-usage-t266080/CS/WindowsFormsApplication1/DocumentLayoutHelper/RichEditDocumentLayoutAnalyzer.cs#L15

ReadOnlyShapeCollection shapes = subDocument.Shapes.Get(subDocument.CreateRange(docPosition, 1));
ReadOnlyDocumentImageCollection images = subDocument.Images.Get(subDocument.CreateRange(docPosition, 1));

VB.NET

wpf-richedit-document-api-t213968/VB/DXRichEditControlAPISample/CodeExamples/ExportActions.vb#L15

Dim docRange As DocumentRange = document.Paragraphs(2).Range
Dim docImageColl As ReadOnlyDocumentImageCollection = document.Images.Get(docRange)
If docImageColl.Count > 0 Then

winforms-richedit-document-api-e5219/VB/RichEditAPISample/CodeExamples/Export.vb#L14

Dim docRange As DocumentRange = document.Paragraphs(2).Range
Dim docImageColl As ReadOnlyDocumentImageCollection = document.Images.Get(docRange)
If docImageColl.Count > 0 Then

word-document-api-examples/VB/CodeExamples/ExportActions.vb#L20

Dim docRange As DocumentRange = document.Paragraphs(2).Range
Dim docImageColl As ReadOnlyDocumentImageCollection = document.Images.Get(docRange)
If docImageColl.Count > 0 Then

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

richEditControl1.Document.Unit = DevExpress.Office.DocumentUnit.Millimeter
Dim images As ReadOnlyDocumentImageCollection = richEditControl1.Document.Images.Get(richEditControl1.Document.Range)

document-layout-api-practical-usage-t266080/VB/WindowsFormsApplication1/DocumentLayoutHelper/RichEditDocumentLayoutAnalyzer.vb#L18

Dim shapes As ReadOnlyShapeCollection = subDocument.Shapes.Get(subDocument.CreateRange(docPosition, 1))
Dim images As ReadOnlyDocumentImageCollection = subDocument.Images.Get(subDocument.CreateRange(docPosition, 1))