AddTextMarkupAnnotation

Annotations and hotspot links

Description

Adds a text markup annotation to the current page.

By default the annotation will consist of a single rectangular area matching the annotation's bounding box. This area can be edited and other areas can be added using the GetAnnotQuadCount, GetAnnotQuadPoints and SetAnnotQuadPoints functions.

Syntax

Delphi

function TPDFlib.AddTextMarkupAnnotation(MarkupType: Integer; Left, Top, Width, Height: Double): Integer;

ActiveX

Function PDFlib::AddTextMarkupAnnotation(MarkupType As Long, Left As Double, Top As Double, Width As Double, Height As Double) As Long

DLL

int DLAddTextMarkupAnnotation(int InstanceID, int MarkupType, double Left, double Top, double Width, double Height);

Parameters

MarkupType0 = Highlight 1 = Underline 2 = Squiggly 3 = Strike out The horizontal co-ordinate of the left edge of the annotation bounding box
Left
TopThe vertical co-ordinate of the top edge of the annotation bounding box
WidthThe width of the annotation bounding box
HeightThe height of the annotation bounding box

Return values

0The MarkupType parameter was not between 1 and 4. The text markup annotation was added successfully.
1