Back to Devexpress

OfficeImage Members

officefileapi-devexpress-dot-office-dot-utils-dot-officeimage-dot-underscore-members.md

latest8.6 KB
Original Source

OfficeImage Members

An image in the document.

Properties

NameDescription
DesiredSizeAfterLoadFor internal use.
DXImageRetrieves the DXImage object.
EncapsulatedOfficeNativeImageFor internal use.
HorizontalResolutionGets the horizontal resolution of the image in pixels per inch.
ImageCacheKeyFor internal use.
IsLoadedFor internal use.
IsMetafile
NativeImageProvides access to the native Image object.
PaletteLengthGets the number of colors in the image palette.
PixelFormatGets the pixel format of the image.
RawFormatGets the file format of this image.
RootImageThis property is overridden in OfficeImage descendants to point to a single instance of an image that can be incorporated in different objects.
ShouldSetDesiredSizeAfterLoadFor internal use.
SizeInDocumentsGets the size of an image in DocumentUnit.Document units.
SizeInHundredthsOfMillimeterGets the size of an image in hundredths of a millimeter.
SizeInOriginalUnitsThis property is overridden in OfficeImage descendants to get the size of a native image measured in original units.
SizeInPixelsGets the size of an image in pixels.
SizeInTwipsGets the size of an image in twips (1,440 twips equals one inch, and 567 twips equals one centimeter).
UriThis property is overridden in OfficeImage class descendants to get the URI of the image.
VerticalResolutionGets the horizontal resolution of the image in pixels per inch.

Methods

NameDescription
CanGetImageBytes(OfficeImageFormat)Indicates whether the OfficeImage descendant can get image data as an array of bytes.
Clone(IDocumentModel)For internal use.
CreateImage(DXImage) staticFor internal use.
CreateImage(MemoryStreamBasedImage) staticFor internal use.
CreateImage(Stream, IUniqueImageId) staticFor internal use.
CreateImage(Stream) staticFor 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) staticDetermines 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) staticStatic method used to get the MIME content type by the OfficeImageFormat value.
GetExtension(OfficeImageFormat) staticStatic 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() protectedCreates a shallow copy of the current Object. Inherited from Object.
ReferenceEquals(Object, Object) staticDetermines 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

NameDescription
NativeImageChangedIntended for internal use.
NativeImageChangingIntended for internal use.

See Also

OfficeImage Class

DevExpress.Office.Utils Namespace