Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

DynaPDF.SquareAnnot

Draws a square annotation on the current open page.

Component Version macOS Windows Linux Server iOS SDK
DynaPDF 5.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "DynaPDF.SquareAnnot"; PDF; PosX; PosY; Width; Height; LineWidth { ; FillColor; StrokeColor; ColorSpace; Author; Subject; Comment } )   More

Parameters

Parameter Description Example Flags
PDF The PDF reference returned from DynaPDF.New. $pdf
PosX X-coordinate of the annotation 100
PosY Y-coordinate of the annotation 100
Width Width of the annotation 100
Height Height of the annotation 100
LineWidth Line width of the circle or ellipse 2
FillColor Fill color for square.
See DynaPDF.RGB function for RGB colors.
200 Optional
StrokeColor Stroke color for square.
See DynaPDF.RGB function for RGB colors.
255 Optional
ColorSpace Color space of the fill and stroke colors. "RGB" Optional
Author The author name. Can be empty. "Christian Schmitz" Optional
Subject The subject to use. Can be empty. Optional
Comment The comment. Can be empty. Optional

Result

Returns annotation handle or error.

Description

Draws a square annotation on the current open page.
If the parameters Width and Height are equal the function draws a square, a rectangle otherwise. If the annotation should be drawn without a border, set the parameter LineWidth to zero or StrokeColor to the special constant NO_COLOR (4294967281).
If the interior should be transparent set FillColor to the special constant NO_COLOR (4294967281).
Although the line width can be set to any positive floating point value, Adobe’s Acrobat or Reader restrict the line width to 0 through 12 units. The line width should be restricted in the same way to avoid issues in Adobe viewer products.

See also SquareAnnot function in DynaPDF manual.

Examples

Add a rectangle annotation:

Set Variable [ $r ; Value: MBS("DynaPDF.EditPage"; $pdf;1) ]
Set Variable [ $r ; Value: MBS( "DynaPDF.SquareAnnot"; /* Draws a square annotation on the current open page. */
$PDF; /* The PDF reference returned from DynaPDF.New. */
100; /* X-coordinate of the annotatione.g. 100 */
100; /* Y-coordinate of the annotatione.g. 100 */
300; /* Width of the annotatione.g. 100 */
200; /* Height of the annotatione.g. 100 */
5; /* Line width of the circle or ellipsee.g. 2 */
4294967281; /* Fill color for square.e.g. 200 */
MBS( "DynaPDF.RGB"; 255; 0; 0 ); /* Stroke color for square.e.g. 255 */
"RGB"; /* Color space of the fill and stroke colors.e.g. "RGB" */
"Christian Schmitz"; /* The author name. Can be empty. */
"Hello World"; /* The subject to use. Can be empty. */
"Just testing") /* The comment. Can be empty. */]

See also

This function checks for a license.

Created 28th November 2014, last changed 17th July 2022


DynaPDF.SkewCoords - DynaPDF.StampAnnot