The requested page is not available for the requested platform. You are viewing the content for .NET Framework 4.5.2+ platform.
.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
.NET Core 3.0+

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

Declaration

ReadOnlyDocumentImageCollection Get(
    DocumentRange range
)
Function Get(
    range As DocumentRange
) As ReadOnlyDocumentImageCollection
ReadOnlyDocumentImageCollection Get(
    DocumentRange range
)
Function Get(
    range As DocumentRange
) As ReadOnlyDocumentImageCollection
ReadOnlyDocumentImageCollection Get(
    DocumentRange range
)
Function Get(
    range As DocumentRange
) As ReadOnlyDocumentImageCollection

Parameters

Name Type Description
range DocumentRange

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

Parameters

Name Type Description
range DocumentRange

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

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.

Returns

Type Description
ReadOnlyDocumentImageCollection

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

Returns

Type Description
ReadOnlyDocumentImageCollection

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

Remarks

The method can be accessed via the RichEditControl.Document.Images.Get or RichEditDocumentServer.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.

Examples

Document document = server.Document;
document.LoadDocument("Documents\\MovieRentals.docx", DocumentFormat.OpenXml);
DocumentRange myRange = document.CreateRange(0, 100);
ReadOnlyDocumentImageCollection images = document.Images.Get(myRange);
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);
}
See Also