Skip to main content
BuyLog In
Office File API
Search in…
Docs > API Reference > DevExpress.Office.Utils > OfficeImage > Members
All docs
V24.1
Office File API
Demo Application
Install NuGet Packages
Redistribution and Deployment (.NET Framework)
.NET/.NET Core Support
Cloud Integration
Blazor Integration
Dockerize an Office File API Application
Use Office File API in .NET MAUI Applications
Backend Web/REST API for Office File API
Load and Use Custom Fonts in Office File API
Sign Office Documents
Spreadsheet Document API
Word Processing Document API
PDF Document API
Excel Export Library
Snap Report API
Zip Compression and Archive API
Barcode Generation API
Unit Conversion API
API Reference
DevExpress.BarCodes
DevExpress.Compression
DevExpress.Docs.Text
DevExpress.Office
DevExpress.Office.DigitalSignatures
DevExpress.Office.Drawing
DevExpress.Office.Export
DevExpress.Office.Export.Html
DevExpress.Office.Import
DevExpress.Office.Localization
DevExpress.Office.Options
DevExpress.Office.Services
DevExpress.Office.Tsp
DevExpress.Office.Utils
OfficeImage
Members
Properties
Methods
Events
OfficeImageFormat
OfficePixelFormat
Units
DevExpress.Pdf
DevExpress.Pdf.Localization
DevExpress.Pdf.Xmp
DevExpress.Spreadsheet
DevExpress.Spreadsheet.Charts
DevExpress.Spreadsheet.Drawings
DevExpress.Spreadsheet.Export
DevExpress.Spreadsheet.Formulas
DevExpress.Spreadsheet.Functions
DevExpress.UnitConversion
DevExpress.XtraPrinting
DevExpress.XtraRichEdit
DevExpress.XtraRichEdit.API.Layout
DevExpress.XtraRichEdit.API.Native
DevExpress.XtraRichEdit.API.Native.Implementation
DevExpress.XtraRichEdit.Commands
DevExpress.XtraRichEdit.Export
DevExpress.XtraRichEdit.Export.Html
DevExpress.XtraRichEdit.Export.Image
DevExpress.XtraRichEdit.Export.PlainText
DevExpress.XtraRichEdit.Export.Rtf
DevExpress.XtraRichEdit.Forms
DevExpress.XtraRichEdit.Import
DevExpress.XtraRichEdit.Localization
DevExpress.XtraRichEdit.Services
DevExpress.XtraRichEdit.Utils
DevExpress.XtraSpreadsheet
DevExpress.XtraSpreadsheet.Export
DevExpress.XtraSpreadsheet.Export.Html
DevExpress.XtraSpreadsheet.Import
DevExpress.XtraSpreadsheet.Localization
DevExpress.XtraSpreadsheet.Services
Download CHM

OfficeImage Members

An image in the document.

Properties

Name Description
DesiredSizeAfterLoad For internal use.
DXImage Retrieves the DXImage object.
EncapsulatedOfficeNativeImage For internal use.
HorizontalResolution Gets the horizontal resolution of the image in pixels per inch.
ImageCacheKey For internal use.
IsLoaded For internal use.
IsMetafile  
NativeImage Provides access to the native Image object.
PaletteLength Gets the number of colors in the image palette.
PixelFormat Gets the pixel format of the image.
RawFormat Gets the file format of this image.
RootImage This property is overridden in OfficeImage descendants to point to a single instance of an image that can be incorporated in different objects.
ShouldSetDesiredSizeAfterLoad For internal use.
SizeInDocuments Gets the size of an image in DocumentUnit.Document units.
SizeInHundredthsOfMillimeter Gets the size of an image in hundredths of a millimeter.
SizeInOriginalUnits This property is overridden in OfficeImage descendants to get the size of a native image measured in original units.
SizeInPixels Gets the size of an image in pixels.
SizeInTwips Gets the size of an image in twips (1,440 twips equals one inch, and 567 twips equals one centimeter).
Uri This property is overridden in OfficeImage class descendants to get the URI of the image.
VerticalResolution Gets the horizontal resolution of the image in pixels per inch.

Methods

Name Description
CanGetImageBytes(OfficeImageFormat) Indicates whether the OfficeImage descendant can get image data as an array of bytes.
Clone(IDocumentModel) For internal use.
CreateImage(DXImage) static For internal use.
CreateImage(MemoryStreamBasedImage) static For internal use.
CreateImage(Stream, IUniqueImageId) static For internal use.
CreateImage(Stream) static For internal use.
DiscardCachedData() Closes the current image stream and releases any resources associated with the current stream.
Dispose() Releases all resources used by this object.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
GetContentType(OfficeImageFormat) static Static method used to get the MIME content type by the OfficeImageFormat value.
GetExtension(OfficeImageFormat) static Static method used to obtain an extension by the OfficeImageFormat value.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetImageBytes(OfficeImageFormat) Returns a byte array of image data encoded in the specified format.
GetImageBytesSafe(OfficeImageFormat) Attempts to get image data as an array of bytes in specified format, and in case of failure gets the data in PNG format.
GetImageBytesStreamSafe(OfficeImageFormat) Attempts to get image data as a stream in the specified format, and in case of a failure, gets the data in PNG format.
GetResolution() For internal use.
GetType() Gets the Type of the current instance. Inherited from Object.
IsExportSupported(OfficeImageFormat) This property is overridden in OfficeImage class descendants to indicate image formats not suitable for export.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
ToString() Returns a string that represents the current object. Inherited from Object.

Events

Name Description
NativeImageChanged Intended for internal use.
NativeImageChanging Intended for internal use.
See Also