PdfImage.IsMask Property

Gets a value indicating whether this PdfImage is a stencil mask image.

Namespace:  BitMiracle.Docotic.Pdf
Assembly:  BitMiracle.Docotic.Pdf (in BitMiracle.Docotic.Pdf.dll)


public bool IsMask { get; }
Public ReadOnly Property IsMask As Boolean

Property Value

Type: Boolean
true if this PdfImage is a stencil mask image; otherwise, false.


An image mask is a monochrome image in which each sample is specified by a single bit. However, instead of being painted in opaque black and white, the image mask is treated as a stencil mask that is partly opaque and partly transparent.

Sample values in the image do not represent black and white pixels; rather, they designate places on the page that should either be marked with the current color or masked out (not marked at all). Areas that are masked out retain their former contents. The effect is like applying paint in the current color through a cut-out stencil, which lets the paint reach the page in some places and masks it out in others.

See Also