Monkeybread Software - MBS FileMaker Plugin: DynaPDF.SetAnnotFlags

Components	All	New	MacOS		Windows		Linux		iOS
Examples	Mac & Win		Server	Client	Guides	Statistic	FMM	Blog	Deprecated	Old

DynaPDF.SetAnnotFlags

Sets the default flags used for new annotations.

Component	Version	macOS	Windows	Linux	Server	iOS SDK
DynaPDF	5.0	✅ Yes	✅ Yes	✅ Yes	✅ Yes	✅ Yes

MBS( "DynaPDF.SetAnnotFlags"; PDF; Flags ) More

Parameters

Parameter Description Example

PDF The PDF reference returned from DynaPDF.New. $pdf

Flags The new flags value. 4

Parameter	Description	Example
PDF	The PDF reference returned from DynaPDF.New.	$pdf
Flags	The new flags value.	4

Result

Returns OK or error.

Description

Sets the default flags used for new annotations.
The parameter Flags is a bit mask; multiple flags can be set with a binary or operator (e.g. afPrint (4) + afReadOnly (64)). It is also possible to add each flag separately; the previous flags are only deleted if the flag afNone (=0) is used.

Flag	Description
afNone	No flags are set.
afInvisible	If set, do not display the annotation if it does not belong to one of the standard annotation types and no annotation handler is available.
afHidden	(PDF 1.2) If set, do not display or print the annotation or allow it to interact with the user, regardless of its annotation type or whether an annotation handler is available.
afPrint	(PDF 1.2) If set, print the annotation when the page is printed. If clear, never print the annotation, regardless of whether it is displayed on the screen. This can be useful, for example, for annotations representing interactive pushbuttons, which would serve no meaningful purpose on the printed page.
afNoZoom	(PDF 1.3) If set, do not scale the annotation’s appearance to match the magnification of the page. The location of the annotation on the page (defined by the upper-left corner of its annotation rectangle) remains fixed, regardless of the page magnification.
afNoRotate	(PDF 1.3) If set, do not rotate the annotation’s appearance to match the rotation of the page. The upper-left corner of the annotation rectangle remains in a fixed location on the page, regardless of the page rotation.
afNoView	(PDF 1.3) If set, do not display the annotation on the screen or allow it to interact with the user. The annotation may be printed (depending on the setting of the afPrint flag), but should be considered hidden for purposes of on-screen display and user interaction.
afReadOnly	(PDF 1.3) If set, do not allow the annotation to interact with the user. The annotation may be displayed or printed (depending on the settings of the afNoView and afPrint flags), but should not respond to mouse clicks or change its appearance in response to mouse motions.

See also SetAnnotFlags function in DynaPDF manual.