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


Sets whether annotations are drawn.

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


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


Returns OK or error.


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.


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

This function checks for a license.

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

PDFKit.SetPDFAttribute - PDFKit.SetPDFPageRotation