Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, CLI, Studio and browser tools 571 stars PSWriteOfficePowerShell module 164 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/

API Reference

Class

OfficeRasterImageEncoder

Edit on GitHub
Namespace OfficeIMO.Drawing
Assembly OfficeIMO.Core
Source OfficeRasterImageEncoder.cs:24
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) #
OfficeRasterImageEncoder.cs:83
Returns: Byte[]

Encodes an RGBA image using the requested raster format.

Parameters

image OfficeIMO.Drawing.OfficeRasterImage requiredposition: 0
format OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 1
options OfficeIMO.Drawing.OfficeRasterEncodingOptions? = null optionalposition: 2
public static Byte[] Encode(OfficeRasterImage image, OfficeImageExportFormat format, OfficeRasterEncodingOptions? options, Int64 maximumEncodedBytes, CancellationToken cancellationToken = default) #
OfficeRasterImageEncoder.cs:113
Returns: Byte[]

Encodes an RGBA image while observing cancellation and enforcing an encoded-byte ceiling as bytes are produced.

Parameters

image OfficeIMO.Drawing.OfficeRasterImage requiredposition: 0
format OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 1
options OfficeIMO.Drawing.OfficeRasterEncodingOptions? requiredposition: 2
maximumEncodedBytes System.Int64 requiredposition: 3
cancellationToken System.Threading.CancellationToken = default optionalposition: 4
EncodeTo 3 overloads
public static Void EncodeTo(OfficeRasterImage image, OfficeImageExportFormat format, Stream destination, OfficeRasterEncodingOptions? options = null) #
OfficeRasterImageEncoder.Streaming.cs:27
Returns: Void

Encodes an RGBA image directly to a caller-owned writable stream.

Parameters

image OfficeIMO.Drawing.OfficeRasterImage requiredposition: 0
format OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 1
destination System.IO.Stream requiredposition: 2
options OfficeIMO.Drawing.OfficeRasterEncodingOptions? = null optionalposition: 3
public static Void EncodeTo(OfficeRasterImage image, OfficeImageExportFormat format, Stream destination, OfficeRasterEncodingOptions? options, Int64 maximumEncodedBytes, CancellationToken cancellationToken = default) #
OfficeRasterImageEncoder.Streaming.cs:42
Returns: Void

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 requiredposition: 0
format OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 1
destination System.IO.Stream requiredposition: 2
options OfficeIMO.Drawing.OfficeRasterEncodingOptions? requiredposition: 3
maximumEncodedBytes System.Int64 requiredposition: 4
cancellationToken System.Threading.CancellationToken = default optionalposition: 5
public static Void EncodeTo(OfficeRasterImage image, OfficeImageExportFormat format, IBufferWriter<Byte> destination, OfficeRasterEncodingOptions? options = null) #
OfficeRasterImageEncoder.Streaming.cs:150
Returns: Void

Encodes an RGBA image directly to a caller-owned buffer writer.

Parameters

image OfficeIMO.Drawing.OfficeRasterImage requiredposition: 0
format OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 1
destination System.Buffers.IBufferWriter<System.Byte> requiredposition: 2
options OfficeIMO.Drawing.OfficeRasterEncodingOptions? = null optionalposition: 3
EncodeWithMetadata 2 overloads
public static OfficeRasterEncodingResult EncodeWithMetadata(OfficeRasterImage image, OfficeImageExportFormat format, OfficeImageMetadata metadata, OfficeRasterEncodingOptions? options = null, Int64 maximumEncodedBytes = 134217728, CancellationToken cancellationToken = default) #
OfficeRasterImageEncoder.Metadata.cs:15
Returns: OfficeRasterEncodingResult

Encodes pixels and applies supported primary-image metadata, reporting supplied profile families omitted by the output container.

Parameters

image OfficeIMO.Drawing.OfficeRasterImage requiredposition: 0
format OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 1
metadata OfficeIMO.Drawing.OfficeImageMetadata requiredposition: 2
options OfficeIMO.Drawing.OfficeRasterEncodingOptions? = null optionalposition: 3
maximumEncodedBytes System.Int64 = 134217728 optionalposition: 4
cancellationToken System.Threading.CancellationToken = default optionalposition: 5
public static OfficeRasterEncodingResult EncodeWithMetadata(OfficeRasterFrames frames, OfficeImageExportFormat format, OfficeImageMetadata metadata, OfficeRasterEncodingOptions? options = null, Int64 maximumEncodedBytes = 134217728, CancellationToken cancellationToken = default) #
OfficeRasterImageEncoder.Metadata.cs:36
Returns: OfficeRasterEncodingResult

Encodes a single still frame, TIFF pages, or icon entries with primary-image metadata and omission evidence.

Parameters

frames OfficeIMO.Drawing.OfficeRasterFrames requiredposition: 0
format OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 1
metadata OfficeIMO.Drawing.OfficeImageMetadata requiredposition: 2
options OfficeIMO.Drawing.OfficeRasterEncodingOptions? = null optionalposition: 3
maximumEncodedBytes System.Int64 = 134217728 optionalposition: 4
cancellationToken System.Threading.CancellationToken = default optionalposition: 5
public static Int32 GetMaximumDimension(OfficeImageExportFormat format) #
OfficeRasterImageEncoder.cs:24
Returns: Int32

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

Parameters

format OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 0
public static Int64 GetMaximumPixelCount(OfficeImageExportFormat format) #
OfficeRasterImageEncoder.cs:37
Returns: Int64

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

Parameters

format OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 0