Topics   All   MacOS (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server   Client   Old   Deprecated   Guides   Examples   Videos
New in version: 9.3   9.4   9.5   10.0   10.1   10.2   10.3   10.4   10.5   10.6    Statistic    FMM    Blog  

PDFKit.SetPDFPageDisplayAnnotation

Sets whether annotations are drawn.

Component Version macOS Windows Linux Server FileMaker iOS SDK
PDFKit 6.0 Yes No No Yes, macOS only Yes
MBS( "PDFKit.SetPDFPageDisplayAnnotation"; PDF; index; Value )   More

Parameters

Parameter Description Example
PDF The PDF reference number. $pdf
index The index of the page. From zero to PDFKit.GetPDFPageCount-1. 1
Value The new value for whether to display annotations. Can be 0 or 1. 1

Result

Returns OK or error.

Description

Sets whether annotations are drawn.
Function to turn on or off the display of annotations when the page is drawn.

Your changes are only done in memory, so please remember to write modified pdf back to disk, e.g. by using PDFKit.WriteToPath. Or use PDFKit.GetPDFDocument to get a PDF for storing in a container.

Examples

Render with or without image:

Set Variable [$pdf; Value:MBS( "PDFKit.OpenContainer"; PDFKit Rendering::PDF )]
Set Variable [$r; Value:MBS( "PDFKit.SetPDFPageDisplayAnnotation"; $pdf; 0; 0 )]
Set Field [PDFKit Rendering::Image1; MBS( "PDFKit.GetPDFPageImage"; $pdf; 0)]
Set Variable [$r; Value:MBS( "PDFKit.SetPDFPageDisplayAnnotation"; $pdf; 0; 1 )]
Set Field [PDFKit Rendering::Image2; MBS( "PDFKit.GetPDFPageImage"; $pdf; 0)]
Set Variable [$r; Value:MBS("PDFKit.Release"; $pdf)]

See also

Created 30th November 2015, last changed 25th April 2016


PDFKit.SetPDFAttribute   -   PDFKit.SetPDFPageRotation

Feedback: Report problem or ask question.



Links
MBS Xojo Chart Plugins

Start Chat