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.SetAnnotBorderStyle

Sets or changes the border style of an annotation.

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

MBS( "DynaPDF.SetAnnotBorderStyle"; PDF; AnnotationHandle; BorderStyle )

Parameters

Parameter Description Example value
PDF The PDF reference returned from DynaPDF.New. $pdf
AnnotationHandle The annotation index. 5
BorderStyle The new border style. Can be Solid, Bevelled, Inset, Underline, Dashed or UserDefined. "Solid"

Result

Returns OK or error.

Description

Sets or changes the border style of an annotation.
Note that the border style has no effect if the border width is set to zero or if the border color is set to NO_COLOR (=4294967281) (see DynaPDF.SetAnnotColor, DynaPDF.SetAnnotBorderWidth).
Note also that not all styles are meaningful for all annotation types. For example, while link annotations support all border styles, FreeText annotations support the styles Solid and Dashed only. File Aattach, Sound, Stamp, or Text annotations for example support no border style because these annotation types contain no appearance on which a border style could be applied.
Setting the border style to an unsupported value causes no error; the value will be ignored instead.
When changing the border style of a Free Text annotation DynaPDF must rebuild the appearance stream of the annotation. The text position can slightly change especially if the border width was changed too. See also DynaPDF.FreeTextAnnot.

See also SetAnnotBorderStyle function in DynaPDF manual.

See also


DynaPDF.SetAlpha   -   DynaPDF.SetAnnotBorderWidth

Feedback: Report problem or ask question.




Links
MBS FileMaker blog