Click or drag to resize
Pdftools logo

ImageMaskCreate Method

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.

Namespace: PdfTools.Toolbox.Pdf.Content
Assembly: PdfTools.Toolbox (in PdfTools.Toolbox.dll) Version: 1.2.0+708f7116d933787a0712d56133e4c2c9bf21e5e3
Syntax
C#
public static ImageMask Create(
	Document targetDocument,
	Stream stream
)

Parameters

targetDocument  Document
the output document with which the returned object is associated
stream  Stream
the image data stream

Return Value

ImageMask
the newly created image mask object
Exceptions
ExceptionCondition
IOExceptionError reading from the image or writing to the document
UnknownFormatExceptionThe image data has an unknown format or the format is not suitable for an image mask
CorruptExceptionThe image data is corrupt
ArgumentExceptionif the targetDocument argument has already been closed
ArgumentExceptionif the targetDocument argument is read-only
ArgumentExceptionif the stream argument is
ArgumentNullExceptionif targetDocument is .
ArgumentNullExceptionif stream is .
See Also