Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

OfficeRasterImageEncoder

OfficeIMO.Drawing

Namespace
OfficeIMO.Drawing
Assembly
OfficeIMO.Core
Source revision
ba882f6b0d07 with working tree changes
Modifiers
static

Shared dependency-free encoder for raster export formats.

Inheritance

  • object
  • OfficeRasterImageEncoder

Methods

Encode 2 overloads
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 required
format OfficeIMO.Drawing.OfficeImageExportFormat required
options OfficeIMO.Drawing.OfficeRasterEncodingOptions? = null optional

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 required
format OfficeIMO.Drawing.OfficeImageExportFormat required
options OfficeIMO.Drawing.OfficeRasterEncodingOptions? required
maximumEncodedBytes long required
cancellationToken System.Threading.CancellationToken = default optional

Returns

byte[]
EncodeTo 3 overloads
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 required
format OfficeIMO.Drawing.OfficeImageExportFormat required
destination System.IO.Stream required
options OfficeIMO.Drawing.OfficeRasterEncodingOptions? = null optional
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 required
format OfficeIMO.Drawing.OfficeImageExportFormat required
destination System.IO.Stream required
options OfficeIMO.Drawing.OfficeRasterEncodingOptions? required
maximumEncodedBytes long required
cancellationToken System.Threading.CancellationToken = default optional
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 required
format OfficeIMO.Drawing.OfficeImageExportFormat required
destination System.Buffers.IBufferWriter<byte> required
options OfficeIMO.Drawing.OfficeRasterEncodingOptions? = null optional
EncodeWithMetadata 2 overloads
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 required
format OfficeIMO.Drawing.OfficeImageExportFormat required
metadata OfficeIMO.Drawing.OfficeImageMetadata required
options OfficeIMO.Drawing.OfficeRasterEncodingOptions? = null optional
maximumEncodedBytes long = 134217728 optional
cancellationToken System.Threading.CancellationToken = default optional
public 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 required
format OfficeIMO.Drawing.OfficeImageExportFormat required
metadata OfficeIMO.Drawing.OfficeImageMetadata required
options OfficeIMO.Drawing.OfficeRasterEncodingOptions? = null optional
maximumEncodedBytes long = 134217728 optional
cancellationToken System.Threading.CancellationToken = default optional
public static int GetMaximumDimension(OfficeImageExportFormat format) #

Returns the maximum supported pixel width or height for a raster format.

Parameters

format OfficeIMO.Drawing.OfficeImageExportFormat required

Returns

int
public static long GetMaximumPixelCount(OfficeImageExportFormat format) #

Returns the maximum source pixel count accepted by a raster encoder.

Parameters

format OfficeIMO.Drawing.OfficeImageExportFormat required

Returns

long