Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

OfficeTiffCodec

Namespace OfficeIMO.Drawing
Assembly OfficeIMO.Core
Modifiers static

Dependency-free classic TIFF encoder for single-page RGBA images.

Inheritance

  • Object
  • OfficeTiffCodec

Methods

public static Byte[] Encode(OfficeRasterImage image, OfficeTiffEncodeOptions options = null) #
Returns: Byte[]

Encodes a single RGBA image as a little-endian baseline TIFF.

Parameters

image OfficeIMO.Drawing.OfficeRasterImage requiredposition: 0
options OfficeIMO.Drawing.OfficeTiffEncodeOptions = null optionalposition: 1
public static Byte[] EncodePages(IReadOnlyList<OfficeRasterImage> pages, OfficeTiffEncodeOptions options = null) #
Returns: Byte[]

Encodes one or more RGBA pages as a bounded classic TIFF IFD chain.

Parameters

pages System.Collections.Generic.IReadOnlyList{OfficeIMO.Drawing.OfficeRasterImage} requiredposition: 0
options OfficeIMO.Drawing.OfficeTiffEncodeOptions = null optionalposition: 1
public static Void EncodePagesTo(IReadOnlyList<OfficeRasterImage> pages, Stream destination, OfficeTiffEncodeOptions options = null) #
Returns: Void

Encodes one or more RGBA pages to a caller-owned writable stream.

Parameters

pages System.Collections.Generic.IReadOnlyList{OfficeIMO.Drawing.OfficeRasterImage} requiredposition: 0
destination System.IO.Stream requiredposition: 1
options OfficeIMO.Drawing.OfficeTiffEncodeOptions = null optionalposition: 2
EncodeTo 2 overloads
public static Void EncodeTo(OfficeRasterImage image, Stream destination, OfficeTiffEncodeOptions options = null) #
Returns: Void

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

Parameters

image OfficeIMO.Drawing.OfficeRasterImage requiredposition: 0
destination System.IO.Stream requiredposition: 1
options OfficeIMO.Drawing.OfficeTiffEncodeOptions = null optionalposition: 2
public static Void EncodeTo(OfficeRasterImage image, IBufferWriter<Byte> destination, OfficeTiffEncodeOptions options = null) #
Returns: Void

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

Parameters

image OfficeIMO.Drawing.OfficeRasterImage requiredposition: 0
destination System.Buffers.IBufferWriter{System.Byte} requiredposition: 1
options OfficeIMO.Drawing.OfficeTiffEncodeOptions = null optionalposition: 2
public static Boolean IsTiff(Byte[] encodedBytes) #
Returns: Boolean

Returns whether the payload starts with a TIFF byte-order marker and magic value.

Parameters

encodedBytes System.Byte[] requiredposition: 0
public static Boolean TryDecode(Byte[] encodedBytes, out OfficeRasterImage image) #
Returns: Boolean

Attempts to decode a classic baseline grayscale, palette, RGB, RGBA, or device-CMYK TIFF using chunky or planar strips or tiles with uncompressed, LZW, PackBits, or Deflate payloads. Floating-point, JPEG-compressed, and BigTIFF payloads remain optional caller-codec responsibilities.

Parameters

encodedBytes System.Byte[] requiredposition: 0
image OfficeIMO.Drawing.OfficeRasterImage@ requiredposition: 1
public static Boolean TryDecodePage(Byte[] encodedBytes, Int32 pageIndex, out OfficeRasterImage image) #
Returns: Boolean

Attempts to decode one zero-based page from a bounded classic TIFF container.

Parameters

encodedBytes System.Byte[] requiredposition: 0
pageIndex System.Int32 requiredposition: 1
image OfficeIMO.Drawing.OfficeRasterImage@ requiredposition: 2
public static Boolean TryGetPageCount(Byte[] encodedBytes, out Int32 pageCount) #
Returns: Boolean

Reads the number of top-level images from a bounded classic TIFF IFD chain.

Parameters

encodedBytes System.Byte[] requiredposition: 0
pageCount System.Int32@ requiredposition: 1