Click or drag to resize
Pdftools logo

ImageMask Class

Inheritance Hierarchy
SystemObject
  PdfTools.Toolbox.InternalNativeBase
    PdfTools.Toolbox.InternalNativeObject
      PdfTools.Toolbox.Pdf.ContentImageMask

Namespace: PdfTools.Toolbox.Pdf.Content
Assembly: PdfTools.Toolbox (in PdfTools.Toolbox.dll) Version: 1.10.0+cda01add3923b11abcc0077fbe8862ccecbd75b0
Syntax
C#
Copy
public class ImageMask : NativeObject

The ImageMask type exposes the following members.

Properties
 NameDescription
Public propertySize

The size of the image mask in samples.

Top
Methods
 NameDescription
Public methodStatic memberCreate

Create an image mask object from image data.

Supported formats are:
  • BMP
  • DIB
  • JBIG2
  • PNG
  • GIF
The returned image mask object is not yet painted on any page, but it is associated with the given target document.
Public methodEquals
(Inherited from NativeObject)
Public methodExtract

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.

Public methodGetHashCode
(Inherited from NativeObject)
Public methodGetResolution

The resolution of an image mask on the page in DPI (dots per inch).

The resolution is the ratio between the size of the image mask and the size it uses on the page.
Top
See Also