Table of Contents

Method Save

Namespace
BitMiracle.Docotic.Pdf
Assembly
BitMiracle.Docotic.Pdf.dll

Save(Stream)

Saves the image to the specified stream.

public PdfExtractedImageFormat Save(Stream stream)

Parameters

stream Stream

The stream to save image to.

Returns

PdfExtractedImageFormat

Format of extracted image.

Remarks

Mask images (see IsMask property) are always saved according to usual PDF convention:

  • White pixels corresponds to masked-out area, the "transparent" pixels. Such masked out area will not be painted on the page.
  • Black pixels corresponds to unmasked area, the "opaque" pixels. Such unmasked area will be painted on the page with the current fill color or corresponding portion of the base image (when this mask image is set as Mask for other image).

The Extract PDF images section shows how to extract images from PDF documents.

Save(string)

Saves the image to the file with specified name.

public string Save(string fileNameWithoutExtension)

Parameters

fileNameWithoutExtension string

Name of the file <without extension> to save image to.

Returns

string

Full name of the file with extension where image was saved.

Remarks

Mask images (see IsMask property) are always saved according to usual PDF convention:

  • White pixels corresponds to masked-out area, the "transparent" pixels. Such masked out area will not be painted on the page.
  • Black pixels corresponds to unmasked area, the "opaque" pixels. Such unmasked area will be painted on the page with the current fill color or corresponding portion of the base image (when this mask image is set as Mask for other image).

The Extract PDF images section shows how to extract images from PDF documents.