Topics   All   Mac OS X (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server (Not)   Client   Old   Guides   Examples
New in version: 6.2   6.3   6.4   6.5   7.0   7.1   7.2   7.3   7.4   7.5    Statistic  

DynaPDF.HighlightAnnot

Creates a Highlight annotation.

Component Version macOS Windows Server FileMaker Cloud FileMaker iOS SDK
DynaPDF 5.0 Yes Yes Yes Yes Yes

MBS( "DynaPDF.HighlightAnnot"; PDF; PosX; PosY; Width; Height; HighlightColor; Author; Subject; Comment )

Parameters

Parameter Description Example value
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
HighlightColor Highlight color. 200
Author The author name. Can be empty. "Christian Schmitz"
Subject The subject to use. Can be empty.
Comment The comment. Can be empty.

Result

Returns annotation handle or error.

Description

Creates a Highlight annotation.
Highlight annotations are used to mark text on a PDF page.
If the coordinate system is bottom-up the point PosX, PosY defines the lower left corner of the bounding rectangle. If the coordinate system is top-down it defines the upper left corner.
The parameter Color specifies the highlight color; it must be defined in RGB color space. The line width of a Strikout or Underline annotation is not adjustable. The line width depends on the size of the annotation and is automatically calculated.
The active color space must be set to DeviceRGB before creating the annotation. See DynaPDF.SetColorSpace for further information.

See also HighlightAnnot function in DynaPDF manual.

See also


DynaPDF.HaveOpenPage   -   DynaPDF.HighlightPattern

Feedback: Report problem or ask question.




Links
MBS FileMaker blog