Click or drag to resize
Pdftools logo

ImageMaskExtract Method

Extract image mask from PDF

Facilitate the extraction of image masks from a specified page within a PDF, outputting them in the imageType format.

By default imageType takes the value Tiff.

Key considerations include:

  • The extraction process isolates the image from the page's resources, neglecting any contextual attributes from the PDF page. Consequently, the original resolution and modifications—such as scaling, rotation, or cropping—that influence the image's appearance on the page are not preserved in the extracted image mask.
  • In instances where a GenericException error arises, the output file may be compromised and rendered unusable.

This method is designed to efficiently retrieve image masks without their page-specific modifications, ensuring a straightforward extraction process.


Namespace: PdfTools.Toolbox.Pdf.Content
Assembly: PdfTools.Toolbox (in PdfTools.Toolbox.dll) Version: 1.1.0+5820e9ca9ca173983539ffc40abc227fb62e6928
Syntax
C#
public void Extract(
	Stream stream,
	ImageType? imageType = null
)

Parameters

stream  Stream
The image mask data stream.
imageType  NullableImageType  (Optional)
Exceptions
ExceptionCondition
ArgumentExceptionif the stream argument is null
InvalidOperationExceptionif the image has already been closed
GenericExceptionif image extraction fails
ArgumentNullExceptionif stream is .
See Also