Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, CLI, Studio and browser tools 565 stars PSWriteOfficePowerShell module 165 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 ../../../../_/OfficeIMO.Core/Raster/OfficeRasterImageEncoder.cs:23
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) #
../../../../_/OfficeIMO.Core/Raster/OfficeRasterImageEncoder.cs:75
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) #
../../../../_/OfficeIMO.Core/Raster/OfficeRasterImageEncoder.cs:106
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) #
../../../../_/OfficeIMO.Core/Raster/OfficeRasterImageEncoder.Streaming.cs:26
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) #
../../../../_/OfficeIMO.Core/Raster/OfficeRasterImageEncoder.Streaming.cs:41
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) #
../../../../_/OfficeIMO.Core/Raster/OfficeRasterImageEncoder.Streaming.cs:135
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
public static Int32 GetMaximumDimension(OfficeImageExportFormat format) #
../../../../_/OfficeIMO.Core/Raster/OfficeRasterImageEncoder.cs:23
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) #
../../../../_/OfficeIMO.Core/Raster/OfficeRasterImageEncoder.cs:33
Returns: Int64

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

Parameters

format OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 0