OfficeRasterImageEncoder
OfficeIMO.Drawing
Shared dependency-free encoder for raster export formats.
Inheritance
- object
- OfficeRasterImageEncoder
Methods
public static byte[] Encode(OfficeRasterImage image, OfficeImageExportFormat format, OfficeRasterEncodingOptions? options = null) #Encodes an RGBA image using the requested raster format.
Parameters
- image OfficeIMO.Drawing.OfficeRasterImage
- format OfficeIMO.Drawing.OfficeImageExportFormat
- options OfficeIMO.Drawing.OfficeRasterEncodingOptions? = null
Returns
byte[]public static byte[] Encode(OfficeRasterImage image, OfficeImageExportFormat format, OfficeRasterEncodingOptions? options, long maximumEncodedBytes, CancellationToken cancellationToken = default) #Encodes an RGBA image while observing cancellation and enforcing an encoded-byte ceiling as bytes are produced.
Parameters
- image OfficeIMO.Drawing.OfficeRasterImage
- format OfficeIMO.Drawing.OfficeImageExportFormat
- options OfficeIMO.Drawing.OfficeRasterEncodingOptions?
- maximumEncodedBytes long
- cancellationToken System.Threading.CancellationToken = default
Returns
byte[]public static void EncodeTo(OfficeRasterImage image, OfficeImageExportFormat format, Stream destination, OfficeRasterEncodingOptions? options = null) #Encodes an RGBA image directly to a caller-owned writable stream.
Parameters
- image OfficeIMO.Drawing.OfficeRasterImage
- format OfficeIMO.Drawing.OfficeImageExportFormat
- destination System.IO.Stream
- options OfficeIMO.Drawing.OfficeRasterEncodingOptions? = null
public static void EncodeTo(OfficeRasterImage image, OfficeImageExportFormat format, Stream destination, OfficeRasterEncodingOptions? options, long maximumEncodedBytes, CancellationToken cancellationToken = default) #Encodes an RGBA image directly to a caller-owned writable stream while observing cancellation and enforcing an encoded-byte ceiling as bytes are produced.
Parameters
- image OfficeIMO.Drawing.OfficeRasterImage
- format OfficeIMO.Drawing.OfficeImageExportFormat
- destination System.IO.Stream
- options OfficeIMO.Drawing.OfficeRasterEncodingOptions?
- maximumEncodedBytes long
- cancellationToken System.Threading.CancellationToken = default
public static void EncodeTo(OfficeRasterImage image, OfficeImageExportFormat format, IBufferWriter<byte> destination, OfficeRasterEncodingOptions? options = null) #Encodes an RGBA image directly to a caller-owned buffer writer.
Parameters
- image OfficeIMO.Drawing.OfficeRasterImage
- format OfficeIMO.Drawing.OfficeImageExportFormat
- destination System.Buffers.IBufferWriter<byte>
- options OfficeIMO.Drawing.OfficeRasterEncodingOptions? = null
public static OfficeRasterEncodingResult EncodeWithMetadata(OfficeRasterImage image, OfficeImageExportFormat format, OfficeImageMetadata metadata, OfficeRasterEncodingOptions? options = null, long maximumEncodedBytes = 134217728, CancellationToken cancellationToken = default) #Encodes pixels and applies supported primary-image metadata, reporting supplied profile families omitted by the output container.
Parameters
- image OfficeIMO.Drawing.OfficeRasterImage
- format OfficeIMO.Drawing.OfficeImageExportFormat
- metadata OfficeIMO.Drawing.OfficeImageMetadata
- options OfficeIMO.Drawing.OfficeRasterEncodingOptions? = null
- maximumEncodedBytes long = 134217728
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeRasterEncodingResultpublic static OfficeRasterEncodingResult EncodeWithMetadata(OfficeRasterFrames frames, OfficeImageExportFormat format, OfficeImageMetadata metadata, OfficeRasterEncodingOptions? options = null, long maximumEncodedBytes = 134217728, CancellationToken cancellationToken = default) #Encodes a single still frame, TIFF pages, or icon entries with primary-image metadata and omission evidence.
Parameters
- frames OfficeIMO.Drawing.OfficeRasterFrames
- format OfficeIMO.Drawing.OfficeImageExportFormat
- metadata OfficeIMO.Drawing.OfficeImageMetadata
- options OfficeIMO.Drawing.OfficeRasterEncodingOptions? = null
- maximumEncodedBytes long = 134217728
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeRasterEncodingResultpublic static int GetMaximumDimension(OfficeImageExportFormat format) #Returns the maximum supported pixel width or height for a raster format.
Parameters
- format OfficeIMO.Drawing.OfficeImageExportFormat
Returns
intpublic static long GetMaximumPixelCount(OfficeImageExportFormat format) #Returns the maximum source pixel count accepted by a raster encoder.
Parameters
- format OfficeIMO.Drawing.OfficeImageExportFormat
Returns
long