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.v24.2.Core.dll
NuGet Package: DevExpress.RichEdit.Core
#Declaration
ReadOnlyDocumentImageCollection Get(
DocumentRange range
)
#Parameters
Name | Type | Description |
---|---|---|
range | Document |
A Document |
#Returns
Type | Description |
---|---|
Read |
A Read |
#Remarks
The method can be accessed by 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 Document
#Example
The code sample below retrieves all images in the specific document range and exports them in the PNG format.
Document document = server.Document;
document.LoadDocument("Documents\\MovieRentals.docx", DocumentFormat.OpenXml);
DocumentRange myRange = document.CreateRange(0, 100);
// Obtain all images im the specific range:
ReadOnlyDocumentImageCollection images = document.Images.Get(myRange);
// Export the retrieved images as png files:
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);
}
#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.