Skip to main content
A newer version of this page is available. .

OfficeImage Members

An image in the document.

Properties

Name Description
DesiredSizeAfterLoad For internal use only.
EncapsulatedOfficeNativeImage This member supports the internal infrastructure and is not intended to be used directly from your code.
HorizontalResolution Gets the horizontal resolution of the image in pixels per inch.
ImageCacheKey This member supports the internal infrastructure and is not intended to be used directly from your code.
IsLoaded For internal use only.
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 only.
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 only.
CreateImage(MemoryStreamBasedImage) static This member supports the internal infrastructure and is not intended to be used directly from your code.
CreateImage(Image) static This member supports the internal infrastructure and is not intended to be used directly from your code.
CreateImage(Stream, IUniqueImageId) static This member supports the internal infrastructure and is not intended to be used directly from your code.
CreateImage(Stream) static This member supports the internal infrastructure and is not intended to be used directly from your code.
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() This member supports the internal infrastructure and is not intended to be used directly from your code.
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