DSSDK logo Document Scanner SDK
z

Class ImageWriter

Wraps native image writer handles and optional platform-specific writers, providing a unified API for exporting images to files. Call Open(string) before writing, configure optional settings via Configure(EConfigParam, object), and dispose when finished.

Namespace: ImageSdkWrapper Assembly: ImageSdkWrapper.MAUI

Inheritance: object

public class ImageWriter : IDisposable

Constructor

ImageWriter(EImageFileType)

Creates a writer for the specified target file type without opening a file.

public ImageWriter(ImageWriter.EImageFileType eImageFileType)

Parameters

  • eImageFileType (EImageFileType): Target output container, e.g. JPEG, PNG, TIFF, or PDF.

ImageWriter(EImageFileType, string)

Creates a writer and immediately opens the provided file path.

public ImageWriter(ImageWriter.EImageFileType eImageFileType, string fname)

Parameters

  • eImageFileType (EImageFileType): Target output container, e.g. JPEG, PNG, TIFF, or PDF.
  • fname (string): Destination file path. Existing files may be overwritten by the native SDK.

Field

ConfigCompression

Deprecated alias for CompressionQuality.

[Obsolete("Deprecated")]
public const ImageWriter.EConfigParam ConfigCompression = CompressionQuality

Returns

  • EConfigParam

ConfigPageHeigt

Deprecated alias for PageHeight.

[Obsolete("Deprecated")]
public const ImageWriter.EConfigParam ConfigPageHeigt = PageHeight

Returns

  • EConfigParam

ConfigPageWidth

Deprecated alias for PageWidth.

[Obsolete("Deprecated")]
public const ImageWriter.EConfigParam ConfigPageWidth = PageWidth

Returns

  • EConfigParam

ConfigPaper

Deprecated alias for Paper.

[Obsolete("Deprecated")]
public const ImageWriter.EConfigParam ConfigPaper = Paper

Returns

  • EConfigParam

ConfigUnits

Deprecated alias for Units.

[Obsolete("Deprecated")]
public const ImageWriter.EConfigParam ConfigUnits = Units

Returns

  • EConfigParam

Extensible

Sentinel value indicating an extensible dimension.

public const float Extensible = -1

Returns

  • float

Inches

Deprecated integer alias for Inches.

[Obsolete("Deprecated")]
public const int Inches = 1

Returns

  • int

Millimeters

Deprecated integer alias for Millimeters.

[Obsolete("Deprecated")]
public const int Millimeters = 0

Returns

  • int

PaperA4

Deprecated integer constant for A4.

[Obsolete("Deprecated")]
public const int PaperA4 = 1

Returns

  • int

PaperA5

Deprecated integer constant for A5.

[Obsolete("Deprecated")]
public const int PaperA5 = 2

Returns

  • int

PaperA6

Deprecated integer constant for A6.

[Obsolete("Deprecated")]
public const int PaperA6 = 3

Returns

  • int

PaperBusinessCard

Deprecated integer constant for BusinessCard.

[Obsolete("Deprecated")]
public const int PaperBusinessCard = 9

Returns

  • int

PaperBusinessCard2

Deprecated integer constant for BusinessCard2.

[Obsolete("Deprecated")]
public const int PaperBusinessCard2 = 10

Returns

  • int

PaperHalfLetter

Deprecated integer constant for HalfLetter.

[Obsolete("Deprecated")]
public const int PaperHalfLetter = 4

Returns

  • int

PaperJuniorLegal

Deprecated integer constant for JuniorLegal.

[Obsolete("Deprecated")]
public const int PaperJuniorLegal = 7

Returns

  • int

PaperLegal

Deprecated integer constant for Legal.

[Obsolete("Deprecated")]
public const int PaperLegal = 6

Returns

  • int

PaperLeger

Deprecated integer constant for Leger.

[Obsolete("Deprecated")]
public const int PaperLeger = 8

Returns

  • int

PaperLetter

Deprecated integer constant for Letter.

[Obsolete("Deprecated")]
public const int PaperLetter = 5

Returns

  • int

PaperReceiptKitchen

Deprecated integer constant for ReceiptKitchen.

[Obsolete("Deprecated")]
public const int PaperReceiptKitchen = 13

Returns

  • int

PaperReceiptMobile

Deprecated integer constant for ReceiptMobile.

[Obsolete("Deprecated")]
public const int PaperReceiptMobile = 11

Returns

  • int

PaperReceiptStation

Deprecated integer constant for ReceiptStation.

[Obsolete("Deprecated")]
public const int PaperReceiptStation = 12

Returns

  • int

PaperTerminator

Deprecated integer constant for Terminator.

[Obsolete("Deprecated")]
public const int PaperTerminator = -1

Returns

  • int

PaperUnknown

Deprecated integer constant for Unknown.

[Obsolete("Deprecated")]
public const int PaperUnknown = 0

Returns

  • int

Method

Configure(EConfigParam, object)

Configures writer behaviour. Supported value types depend on param.

public void Configure(ImageWriter.EConfigParam param, object value)

Parameters

  • param (EConfigParam): One of the EConfigParam values such as CompressionQuality.
  • value (object): For footer settings provide a System.String; for page metrics use System.Single, System.Double, or System.Int32; for other parameters use integral types. An invalid value throws System.InvalidCastException.

Dispose()

Closes the underlying native writer handle and releases any OS-specific resources.

public void Dispose()

Open(string)

Opens or creates a target file for the previously selected type.

public bool Open(string fname)

Parameters

  • fname (string): Destination file path or URI understood by the platform implementation.

Returns

  • bool: true if the writer is ready to accept images; otherwise false.

Write(MetaImage)

Writes the provided MetaImage to the previously opened destination.

public string Write(MetaImage image)

Parameters

  • image (MetaImage): Image to export. The instance must remain valid for the duration of the call.

Returns

  • string: Optional diagnostic string returned by the native API, or null when the OS specific writer handles output.

WriteFile(string, EPngPdfImageFileType, EOrienation)

Writes an existing image file into the open PDF/PNG container without loading it as a MetaImage.

public string WriteFile(string imageFile, ImageWriter.EPngPdfImageFileType imageType, MetaImage.EOrienation orienation)

Parameters

  • imageFile (string): Source image file path.
  • imageType (EPngPdfImageFileType): Nature of the source image when exporting to a PDF/PNG container.
  • orienation (EOrienation): Orientation metadata to store alongside the page.

Returns

  • string: Diagnostic string returned by the native API.
Top