Components | All | New | MacOS | Windows | Linux | iOS | ||||
Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old |
DynaPDF.TextAnnot
Creates a text annotation.
Component | Version | macOS | Windows | Linux | Server | iOS SDK |
DynaPDF | 5.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
MBS( "DynaPDF.TextAnnot"; PDF; PosX; PosY; Width; Height; Author; Text; Icon; Open ) More
Parameters
Parameter | Description | Example |
---|---|---|
The PDF reference returned from DynaPDF.New. | ||
PosX | X-Coordinate of the annotation | 100 |
PosY | Y-Coordinate of the annotation | 100 |
Width | Width of the window in open state | 100 |
Height | Height of the window in open state | 100 |
Author | The author name. Can be empty. | "Christian Schmitz" |
Text | The text for the annotation. | "Hello World" |
Icon | Which icon to use. Can be Help, Insert, Key, NewParagraph, Note, Paragraph or UserDefined. |
"Help" |
Open | Should the annotation appear open or closed? Pass 1 for open or 0 for close. | 1 |
Result
Returns annotation handle or error.
Description
Creates a text annotation.The parameters Width and Height define the size of the annotation's window. The window is shown in the open state of the annotation.
If the parameter Open is true, the annotation appears in its open state when opening the document. If the annotation is closed, the annotation's icon appears on screen.
The parameters Author and Text are optional, they can be empty. DynaPDF does not embed the annotation icon. However, since Acrobat 5 they are available in Adobe's Acrobat or Reader.
See also TextAnnot function in DynaPDF manual.
Examples
Add text annotation:
Set Variable [ $r ; Value: MBS( "DynaPDF.TextAnnot"; $pdf; 50; 50; 300; 200; "Christian Schmitz"; "Hello World"; "Help"; 1) ]
See also
- DynaPDF.FreeTextAnnot
- DynaPDF.LineAnnot
- DynaPDF.New
- DynaPDF.ResetAnnotAP
- DynaPDF.SetAnnotIcon
- DynaPDF.StampAnnot
Blog Entries
This function checks for a license.
Created 28th November 2014, last changed 3th October 2024