FSPDF_ANNOTBORDER Struct Reference

Structure for annotation border. More...

#include <fpdf_annot_r.h>

Public Attributes

FS_FLOAT borderWidth
 Width of border, in points. More...
 
FS_INT32 borderStyle
 Border style. More...
 
FS_FLOAT cloudIntensity
 Intensity of the cloudy effect. More...
 
FS_FLOAT dashPhase
 Dash phase. More...
 
FS_INT32 dashCount
 Count of useful elements in array dashPattern. More...
 
FS_FLOAT dashPattern [16]
 Dash array. More...
 

Detailed Description

Structure for annotation border.

Member Data Documentation

FS_INT32 FSPDF_ANNOTBORDER::borderStyle

Border style.

Please refer to macro definitions FSPDF_ANNOT_BORDERSTYLE_XXX and this should be one of these macros.

FS_FLOAT FSPDF_ANNOTBORDER::borderWidth

Width of border, in points.

If this value is 0, no border is drawn. This value should not be negative.

FS_FLOAT FSPDF_ANNOTBORDER::cloudIntensity

Intensity of the cloudy effect.

Only free text, square, circle, polygon, and polyline annotations can have cloud intensity property.
Suggested values range from 0 to 2. -1 mean no cloudy border effect.
Only useful when borderStyle is FSPDF_ANNOT_BORDERSTYLE_CLOUDY; otherwise -1.

FS_INT32 FSPDF_ANNOTBORDER::dashCount

Count of useful elements in array dashPattern.

Only useful when borderStyle is FSPDF_ANNOT_BORDERSTYLE_DASHED.

FS_FLOAT FSPDF_ANNOTBORDER::dashPattern[16]

Dash array.

The value of elements in this array should not be negative.
Only be useful when borderStyle is FSPDF_ANNOT_BORDERSTYLE_DASHED.

FS_FLOAT FSPDF_ANNOTBORDER::dashPhase

Dash phase.

Only useful when borderStyle is FSPDF_ANNOT_BORDERSTYLE_DASHED.


The documentation for this struct was generated from the following file:

Foxit Corporation