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: 10.4   10.5   11.0   11.1   11.2   11.3   11.4   11.5   12.0   12.1    Statistic    FMM    Blog  


Changes the visibility state of an OCG or layer.

Component Version macOS Windows Linux Server iOS SDK
DynaPDF 9.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "DynaPDF.SetOCGState"; PDF; Handle; On { ; SaveState } )   More


Parameter Description Example Flags
PDF The PDF reference returned from DynaPDF.New. $pdf
Handle The OCG handle.
Index from 0 to DynaPDF.GetOCGCount-1.
On Wished state: 1 = visible, 0 = invisible 1
SaveState Whether to save the state in the PDF file?
Pass 1 to save or 0 to only switch temporarly.
Default 0.
1 Optional


Returns OK or error.


Changes the visibility state of an OCG or layer.
If the parameter SaveState is 1, the new state is also saved in the PDF file. Otherwise, the state is only changed temporarily so that the wished state can be rendered with DynaPDF.RenderPage or DynaPDF.RenderPDFFile for example.
Note that only the new state of the current OCG will be be saved. If the state of other OCGs were changed beforehand, while SaveState was set to 0, then these changes will not be considered.

See also SetOCGState function in DynaPDF manual.

See also

Release notes

Blog Entries

Created 18th February 2019, last changed 18th February 2019

DynaPDF.SetNumberFormat - DynaPDF.SetOpacity

Feedback: Report problem or ask question.

MBS Xojo PDF Plugins

Start Chat