OfficeImage Class

An image in the document.

Namespace: DevExpress.Office.Utils

Assembly: DevExpress.Office.v18.2.Core.dll

Declaration

C#

[ComVisible(true)]
public abstract class OfficeImage :
    IDisposable

VB.NET

<ComVisible(True)>
Public MustInherit Class OfficeImage
    Implements IDisposable

Related API Members

The following members return OfficeImage objects:

Show 11 links

• ChartObject.GetImage()
• ChartObject.GetImage(Size)
• DocumentImage.Image
• HeaderFooterPicture.Image
• InlinePictureBox.Image
• LayoutFloatingPicture.Image
• OfficeImage.Clone(IDocumentModel)
• OfficeImage.RootImage
• Picture.Image
• Shape.Picture
• ShapePictureFill.Image

Remarks

The OfficeImage object is accessible via the DocumentImage.Image property of the DocumentImage interface.

The OfficeImage class provides information on the image size, resolution and color depth.

To get a native Image object, use the OfficeImage.NativeImage property. The OfficeImage.GetImageBytes method enables you to obtain image data in any of the supported formats.

Static methods implemented in the OfficeImage class can help you to determine the MIME type and file extension for a given image format.

Related GitHub Examples

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

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#

export-to-html-how-to-export-only-body-tag-content-and-specify-the-location-of-css-styles-e1726/CS/ExportOnlyBodyContent/MyUriProvider.cs#L29

}
public string CreateImageUri(string rootUri, OfficeImage image, string relativeUri) {
    string imagesDir = String.Format("{0}\\{1}", this.rootDirecory, rootUri.Trim('/'));

how-to-save-the-text-of-a-document-range-in-different-formats-e1604/CS/GetTextMethodsExample/Form1.cs#L280

}
public string CreateImageUri(string rootUri, DevExpress.Office.Utils.OfficeImage image, string relativeUri)
{

how-to-retain-original-image-uri-in-html-document-e3189/CS/HTML_Export_ImageSourceExample/CustomUriProvider.cs#L12

public string CreateImageUri(string rootUri, OfficeImage image, string relativeUri) {
    return image.Uri;

VB.NET

export-to-html-how-to-export-only-body-tag-content-and-specify-the-location-of-css-styles-e1726/VB/ExportOnlyBodyContent/MyUriProvider.vb#L33

End Function
Public Function CreateImageUri(ByVal rootUri As String, ByVal image As OfficeImage, ByVal relativeUri As String) As String Implements  IUriProvider.CreateImageUri
    Dim imagesDir As String = String.Format("{0}\{1}", Me.rootDirecory, rootUri.Trim("/"c))

how-to-save-the-text-of-a-document-range-in-different-formats-e1604/VB/GetTextMethodsExample/Form1.vb#L218

End Function
Public Function CreateImageUri(ByVal rootUri As String, ByVal image As DevExpress.Office.Utils.OfficeImage, ByVal relativeUri As String) As String Implements DevExpress.Office.Services.IUriProvider.CreateImageUri
    Dim imagesDir As String = String.Format("{0}\{1}", Me.rootDirecory, rootUri.Trim("/"c))

how-to-retain-original-image-uri-in-html-document-e3189/VB/HTML_Export_ImageSourceExample/CustomUriProvider.vb#L14

Public Function CreateImageUri(ByVal rootUri As String, ByVal image As OfficeImage, ByVal relativeUri As String) As String Implements IUriProvider.CreateImageUri
    Return image.Uri

Inheritance

Object

OfficeImage