Skip to content

PdfGraphics.DrawStencilMask Method

Overloads

Name Description
DrawStencilMask(PdfStencilMask,PdfBrush,Double,Double,Double,Double) Draws the specified PdfStencilMask at the specified location and with the specified size.
DrawStencilMask(PdfStencilMask,PdfBrush,Double,Double,Double,Double,Double) Draws the specified PdfStencilMask at the specified location and with the specified size.
DrawStencilMask(PdfStencilMask,PdfBrush,Double,Double,Double,Double,Double,PdfFlipDirection) Draws the specified PdfStencilMask at the specified location and with the specified size.

DrawStencilMask(PdfStencilMask,PdfBrush,Double,Double,Double,Double)

Draws the specified PdfStencilMask at the specified location and with the specified size.

C#
public PdfSize DrawStencilMask(PdfStencilMask stencilMask, PdfBrush brush, double x, double y, double width, double height)

Parameters

stencilMask PdfStencilMask

PdfStencilMask to draw.

brush PdfBrush

PdfBrush that defines the characteristics of the stencil mask fill.

x Double

The x-coordinate of the upper-left corner of the drawn stencil mask.

y Double

The y-coordinate of the upper-left corner of the drawn stencil mask.

width Double

Width of the drawn stencil mask.

height Double

Height of the drawn stencil mask.

Remarks

A stencil mask is a B/W image where the 1 pixels are left transparent and 0 pixels are filled with the brush.
If width is zero or negative then width is automatically computed in order to keep the original aspect ratio. If height is zero or negative then height is automatically computed in order to keep the original aspect ratio. If both width and height are negative then the stencil mask is scaled automatically to fit the given area and the original aspect ratio is kept.

DrawStencilMask(PdfStencilMask,PdfBrush,Double,Double,Double,Double,Double)

Draws the specified PdfStencilMask at the specified location and with the specified size.

C#
public PdfSize DrawStencilMask(PdfStencilMask stencilMask, PdfBrush brush, double x, double y, double width, double height, double rotation)

Parameters

stencilMask PdfStencilMask

PdfStencilMask to draw.

brush PdfBrush

PdfBrush that defines the characteristics of the stencil mask fill.

x Double

The x-coordinate of the upper-left corner of the drawn stencil mask.

y Double

The y-coordinate of the upper-left corner of the drawn stencil mask.

width Double

Width of the drawn stencil mask.

height Double

Height of the drawn stencil mask.

rotation Double

Rotation angle of the drawn stencil mask.

Remarks

A stencil mask is a B/W image where the 1 pixels are left transparent and 0 pixels are filled with the brush.
If width is zero or negative then width is automatically computed in order to keep the original aspect ratio. If height is zero or negative then height is automatically computed in order to keep the original aspect ratio. If both width and height are negative then the stencil mask is scaled automatically to fit the given area and the original aspect ratio is kept.

DrawStencilMask(PdfStencilMask,PdfBrush,Double,Double,Double,Double,Double,PdfFlipDirection)

Draws the specified PdfStencilMask at the specified location and with the specified size.

C#
public PdfSize DrawStencilMask(PdfStencilMask stencilMask, PdfBrush brush, double x, double y, double width, double height, double rotation, PdfFlipDirection flipDirection)

Parameters

stencilMask PdfStencilMask

PdfStencilMask to draw.

brush PdfBrush

PdfBrush that defines the characteristics of the stencil mask fill.

x Double

The x-coordinate of the upper-left corner of the drawn stencil mask.

y Double

The y-coordinate of the upper-left corner of the drawn stencil mask.

width Double

Width of the drawn stencil mask.

height Double

Height of the drawn stencil mask.

rotation Double

Rotation angle of the drawn stencil mask.

flipDirection PdfFlipDirection

Direction for flipping the drawn stencil mask.

Remarks

A stencil mask is a B/W image where the 1 pixels are left transparent and 0 pixels are filled with the brush.
If width is zero or negative then width is automatically computed in order to keep the original aspect ratio. If height is zero or negative then height is automatically computed in order to keep the original aspect ratio. If both width and height are negative then the stencil mask is scaled automatically to fit the given area and the original aspect ratio is kept.