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


Queres properties of a layer.

Component Version macOS Windows Linux Server iOS SDK
DynaPDF 9.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "DynaPDF.GetOCGContUsage"; PDF; Handle; Selector )   More


Parameter Description Example
PDF The PDF reference returned from DynaPDF.New. $pdf
Handle The OCG handle. $OCG
Selector Which value to return. "Language"


Returns value or error.


Queres properties of a layer.
returns the properties of the Content Usage dictionary that is associated with an OCG or layer. If the OCG is not included in an application event, then the contents in this dictionary serves as pure information.
If the OCG is included in one or more application events, then these settings control also the visibility state of the OCG. The function DynaPDF.GetOCG returns the events and categories which control the layer visibility.
If UserNamesCount is greater zero, the dictionary contains also user names. The user names can be accessed with DynaPDF.GetOCGUsageUserName.

ExportState0 = Off, 1 = On, PDF_MAX_INT = not set
InfoCreatorCreatorInfo -> The application that created the group
InfoSubtypeCreatorInfo -> A name defining the type of content, e.g. Artwork, Technical etc.
LanguageA language code as described at DynaPDF.SetLanguage
LangPreferred0 = Off, 1 = On, PDF_MAX_INT = not set. The preffered state if there is a partial but no exact match of the lang id
PageElementIf the group contains a pagination artefact
PrintState0 = Off, 1 = On, PDF_MAX_INT = not set
PrintSubtypeThe type of content that is controlled by the OCG, e.g. Trapping, PrintersMarks or Watermark.
UserNamesCountThe user names can be accessed with DynaPDF.GetOCGUsageUserName
UserTypeThe user for whom the OCG is primarily intendet
ViewState0 = Off, 1 = On, PDF_MAX_INT = not set
ZoomMinMinimum zoom factor at which the OCG should be On. -1 = not set
ZoomMaxMaximum zoom factor at which the OCG should be On. -1 = not set

See also GetOCGContUsage function in DynaPDF manual.

See also

Release notes

Blog Entries

This function checks for a license.

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

DynaPDF.GetOCG - DynaPDF.GetOCGCount