| Components | All | New | MacOS | Windows | Linux | iOS | ||||
| Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old | |
DynaPDF.GetOCGContUsage
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
Parameters
| Parameter | Description | Example |
|---|---|---|
| The PDF reference returned from DynaPDF.New. | ||
| Handle | The OCG handle. | $OCG |
| Selector | Which value to return. | "Language" |
Result
Returns value or error.
Description
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.
Properties:
| ExportState | 0 = Off, 1 = On, PDF_MAX_INT = not set |
| InfoCreator | CreatorInfo -> The application that created the group |
| InfoSubtype | CreatorInfo -> A name defining the type of content, e.g. Artwork, Technical etc. |
| Language | A language code as described at DynaPDF.SetLanguage |
| LangPreferred | 0 = Off, 1 = On, PDF_MAX_INT = not set. The preffered state if there is a partial but no exact match of the lang id |
| PageElement | If the group contains a pagination artefact |
| PrintState | 0 = Off, 1 = On, PDF_MAX_INT = not set |
| PrintSubtype | The type of content that is controlled by the OCG, e.g. Trapping, PrintersMarks or Watermark. |
| UserNamesCount | The user names can be accessed with DynaPDF.GetOCGUsageUserName |
| UserType | The user for whom the OCG is primarily intendet |
| ViewState | 0 = Off, 1 = On, PDF_MAX_INT = not set |
| ZoomMin | Minimum zoom factor at which the OCG should be On. -1 = not set |
| ZoomMax | Maximum zoom factor at which the OCG should be On. -1 = not set |
See also GetOCGContUsage function in DynaPDF manual.
See also
Release notes
- Version 9.1
- Added DynaPDF.GetOCG, DynaPDF.GetOCGContUsage, DynaPDF.GetOCGCount, DynaPDF.GetOCGUsageUserName and DynaPDF.SetOCGState functions for PDF layers.
Blog Entries
This function checks for a license.
Created 18th February 2019, last changed 18th February 2019
