Back to Devexpress

DocumentImage.Image Property

officefileapi-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-documentimage-1db2a684.md

latest4.9 KB
Original Source

DocumentImage.Image Property

Provides access to the source image displayed as an inline object in the document.

Namespace : DevExpress.XtraRichEdit.API.Native

Assembly : DevExpress.RichEdit.v25.2.Core.dll

NuGet Package : DevExpress.RichEdit.Core

Declaration

csharp
OfficeImage Image { get; }
vb
ReadOnly Property Image As OfficeImage

Property Value

TypeDescription
OfficeImage

An OfficeImage object specifying the image incorporated in the document.

|

Remarks

The Image property enables you to get access to the native Image object via the OfficeImage.NativeImage property, and provides information on the original image format, size and location (the latter characteristic makes sense if an image is obtained from an external file).

The following code snippets (auto-collected from DevExpress Examples) contain references to the Image property.

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.

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

csharp
{
    DevExpress.Office.Utils.OfficeImage myImage = docImageColl[0].Image;
    System.Drawing.Image image = myImage.NativeImage;

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

csharp
{
    DevExpress.Office.Utils.OfficeImage myImage = docImageColl[0].Image;
    System.Drawing.Image image = myImage.NativeImage;

word-document-api-examples/CS/CodeExamples/InlinePictureActions.cs#L59

csharp
// Save the first retrieved image as a PNG file.
DevExpress.Office.Utils.OfficeImage myImage = images[0].Image;
System.Drawing.Image image = myImage.NativeImage;

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

vb
If docImageColl.Count > 0 Then
    Dim myImage As DevExpress.Office.Utils.OfficeImage = docImageColl(CInt((0))).Image
    Dim image As System.Drawing.Image = myImage.NativeImage

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

vb
If docImageColl.Count > 0 Then
    Dim myImage As DevExpress.Office.Utils.OfficeImage = docImageColl(0).Image
    Dim image As System.Drawing.Image = myImage.NativeImage

word-document-api-examples/VB/CodeExamples/InlinePictureActions.vb#L48

vb
' Save the first retrieved image as a PNG file.
Dim myImage As DevExpress.Office.Utils.OfficeImage = images(CInt((0))).Image
Dim image As System.Drawing.Image = myImage.NativeImage

See Also

OfficeImage

NativeImage

DuplicateObjectAsMetafile

DocumentImage Interface

DocumentImage Members

DevExpress.XtraRichEdit.API.Native Namespace