Platforms to show: All Mac Windows Linux Cross-Platform
DynaPDFMBS.GetOCG(Handle as UInt32) as DynaPDFOCGMBS
Function:
Returns the properties of an OCG, also called layer.
Notes:
An OCG handle is a simple array index. You can loop over all available OCGs from 0 to GetOCGCount - 1.
If the member HaveContUsage is true, the OCG contains a Content Usage dictionary. The contents of this dictionary can be accessed with the function GetOCGContUsage. A Content Usage dictionary contains additional information about a layer or OCG.
If the OCG is also included in an application event, this is the case if AppEvent is non-zero, then the Content Usage dictionary is used to control the visibility state of the layer. The member Categories specifies which categories control the visibility state.
Returns nil on any error.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 15.0 | Yes | Yes | Yes | Yes | All |
Notes:
An OCG handle is a simple array index. You can loop over all available OCGs from 0 to GetOCGCount - 1.
If the member HaveContUsage is true, the OCG contains a Content Usage dictionary. The contents of this dictionary can be accessed with the function GetOCGContUsage. A Content Usage dictionary contains additional information about a layer or OCG.
If the OCG is also included in an application event, this is the case if AppEvent is non-zero, then the Content Usage dictionary is used to control the visibility state of the layer. The member Categories specifies which categories control the visibility state.
Returns nil on any error.
See also GetOCG function in DynaPDF manual.
DynaPDFMBS.GetOCGContUsage(Handle as UInt32) as DynaPDFOCGContUsageMBS
Function:
Returns the properties of the Content Usage dictionary that is associated with an OCG or layer.
Notes:
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 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 GetOCGUsageUserName.

Returns nil on any error.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 15.0 | Yes | Yes | Yes | Yes | All |
Notes:
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 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 GetOCGUsageUserName.

Returns nil on any error.
See also GetOCGContUsage function in DynaPDF manual.
DynaPDFMBS.GetOCGCount as Integer
Function:
Returns the number of OCGs or layers which are available in document.
Notes: This function cannot fail, the return value is always greater or equal zero.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 15.0 | Yes | Yes | Yes | Yes | All |
Notes: This function cannot fail, the return value is always greater or equal zero.
See also GetOCGCount function in DynaPDF manual.
DynaPDFMBS.GetOCGUsageUserName(Handle as UInt32, Index as UInt32, byref Name as String) as Boolean
Function:
Returns a user name of a Content Usage dictionary that is associated with an OCG or layer.
Notes:
The functions a pointer of the original string that is stored in the PDF file.
If the function succeeds the return value is true. If the function fails the return value is false.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 15.0 | Yes | Yes | Yes | Yes | All |
Notes:
The functions a pointer of the original string that is stored in the PDF file.
If the function succeeds the return value is true. If the function fails the return value is false.
See also GetOCGUsageUserName function in DynaPDF manual.
DynaPDFMBS.GetOCUINode(Node as Integer) as DynaPDFOCUINodeMBS
Function:
Retrieves the most important properties of an Optional Content UI node (UI stands for User Interface).
Notes:
If the PDF file was not already imported with ImportPDFFile() the function ImportOCProperties() must be called to import the global Optional Content Properties.
UI nodes are part of a layer configuration. Therefore, a layer configuration must be loaded with LoadLayerConfig() before the function can be called.
Optional Content Groups (OCGs) which are returned by this function should be visible in the user interface of a viewer application. All other OCGs should not be shown by default.
UI nodes are stored in a single linked list. To get the pointer of the root node set the parameter Node to 0. The parameter OutNode will be ignored in this case but it is required otherwise.
The next node of the root is in the NextItem property. If no further node is available the return value will be 0.
Every node can contain one or more child nodes, an optional label, or a reference to an OCG.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 17.5 | Yes | Yes | Yes | Yes | All |
Notes:
If the PDF file was not already imported with ImportPDFFile() the function ImportOCProperties() must be called to import the global Optional Content Properties.
UI nodes are part of a layer configuration. Therefore, a layer configuration must be loaded with LoadLayerConfig() before the function can be called.
Optional Content Groups (OCGs) which are returned by this function should be visible in the user interface of a viewer application. All other OCGs should not be shown by default.
UI nodes are stored in a single linked list. To get the pointer of the root node set the parameter Node to 0. The parameter OutNode will be ignored in this case but it is required otherwise.
The next node of the root is in the NextItem property. If no further node is available the return value will be 0.
Every node can contain one or more child nodes, an optional label, or a reference to an OCG.
See also GetOCUINode function in DynaPDF manual.
DynaPDFMBS.GetOpacity as Double
Function:
The function returns the opacity value used to draw the visible appearance of an annotation (requires Acrobat 5 or higher).
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetOpacity function in DynaPDF manual.
DynaPDFMBS.GetOrientation as Integer
Function:
The function returns the orientation of the current open page if an open page was detected or the default orientation for newly created pages if no open page was detected.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetOrientation function in DynaPDF manual.
DynaPDFMBS.GetOutputIntent(Index as Integer) as DynaPDFOutputIntentMBS
Function:
Returns an output intent as well as the properties of it.
Notes:
An output intent is an ICC profile that describes the characteristics of the output device. The profile is mostly embedded but certain standards like PDF/X 4p, for example, allow also the usage of non-embedded profiles.
The parameter Index is the array index of the output intent. To determine the number of available intents call GetOutputIntentCount.
Returns nil in case of error.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 14.2 | Yes | Yes | Yes | Yes | All |
Notes:
An output intent is an ICC profile that describes the characteristics of the output device. The profile is mostly embedded but certain standards like PDF/X 4p, for example, allow also the usage of non-embedded profiles.
The parameter Index is the array index of the output intent. To determine the number of available intents call GetOutputIntentCount.
Returns nil in case of error.
See also GetOutputIntent function in DynaPDF manual.
DynaPDFMBS.GetOutputIntentCount as Integer
Function:
Returns the number of available output intents.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 14.2 | Yes | Yes | Yes | Yes | All |
See also GetOutputIntentCount function in DynaPDF manual.
DynaPDFMBS.GetPage(PageNum as UInt32) as DynaPDFPageMBS
Function:
Returns the page object for the given page number.
Notes: If you like to open a page for editing, please use editpage function.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 11.1 | Yes | Yes | Yes | Yes | All |
Notes: If you like to open a page for editing, please use editpage function.
DynaPDFMBS.GetPageAnnot(index as Integer) as DynaPDFAnnotationMBS
Function:
Retrieves the page annotation with the given index.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.6 | Yes | Yes | Yes | Yes | All |
This item is deprecated and should no longer be used.
You can use GetPageAnnotEx instead.
DynaPDFMBS.GetPageAnnotCount as Integer
Function:
Queries the page annotation count.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.6 | Yes | Yes | Yes | Yes | All |
See also GetPageAnnotCount function in DynaPDF manual.
DynaPDFMBS.GetPageAnnotEx(index as Integer) as DynaPDFAnnotationExMBS
Function:
Queries an extended annotation with the given index.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.6 | Yes | Yes | Yes | Yes | All |
See also GetPageAnnotEx function in DynaPDF manual.
DynaPDFMBS.GetPageColorSpaces as DynaPDFColorSpaceMBS()
Function:
Queries for current open page the color spaces used.
Notes:
Color spaces used for drawing colors (Stroke and Fill Color) and for image color space.
The list may be empty if for example everything is drawn in standard color spaces like RGB.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 16.0 | Yes | Yes | Yes | Yes | All |
Notes:
Color spaces used for drawing colors (Stroke and Fill Color) and for image color space.
The list may be empty if for example everything is drawn in standard color spaces like RGB.
DynaPDFMBS.GetPageCoords as Integer
Function:
Queries the page coordinate system setting.
Notes: The native coordinate system of the Portable Document Format is bottom up.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
Notes: The native coordinate system of the Portable Document Format is bottom up.
See also GetPageCoords function in DynaPDF manual.
DynaPDFMBS.GetPageCount as Integer
Function:
The function returns the number of pages of the current PDF file if any.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetPageCount function in DynaPDF manual.
DynaPDFMBS.GetPageField(Index as Integer) as DynaPDFFieldMBS
Function:
The function retrieves the most important properties of a field.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
This item is deprecated and should no longer be used.
You can use GetPageFieldEx instead.
DynaPDFMBS.GetPageFieldCount as Integer
Function:
The function returns the number of fields used by a page.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetPageFieldCount function in DynaPDF manual.
DynaPDFMBS.GetPageFieldEx(Index as Integer) as DynaPDFFieldExMBS
Function:
The function retrieves the most important properties of a field.
Notes: The parameter Index must be a valid index to the page's field array. To enumerate the fields of a page execute the function in a loop from 0 to GetPageFieldCount - 1.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 10.1 | Yes | Yes | Yes | Yes | All |
Notes: The parameter Index must be a valid index to the page's field array. To enumerate the fields of a page execute the function in a loop from 0 to GetPageFieldCount - 1.
See also GetPageFieldEx function in DynaPDF manual.
DynaPDFMBS.GetPageHeight as Double
Function:
The function returns the height of the currently open page.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetPageHeight function in DynaPDF manual.
DynaPDFMBS.GetPageLabel(index as Integer, byref Label as DynaPDFPageLabelMBS) as boolean
Function:
The function retrieves the properties of a page label.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetPageLabel function in DynaPDF manual.
DynaPDFMBS.GetPageLabelCount as Integer
Function:
The function returns the number of page labels defined in the document.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetPageLabelCount function in DynaPDF manual.
DynaPDFMBS.GetPageLayout as Integer
Function:
The function returns the page layout that is used when opening the document with Adobe s Acrobat.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetPageLayout function in DynaPDF manual.
DynaPDFMBS.GetPageMode as Integer
Function:
The function returns the page mode that is used when opening the document with Adobe's Acrobat.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetPageMode function in DynaPDF manual.
DynaPDFMBS.GetPageNum as Integer
Function:
The function returns the page number of the currently open page.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetPageNum function in DynaPDF manual.
DynaPDFMBS.GetPageText(stack as DynaPDFStackMBS) as boolean
Function:
This function can be used to extract the text of a page or template, or to find a specific text that should be replaced or deleted with the function ReplacePageText() or ReplacePageTextEx().
Notes:
InitStack must be called before you use GetPageText.
If you have problems with asian characters, please make sure you use SetCMapDir and load the CMAPs.
Requires DynaPDF Pro license.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 7.7 | Yes | Yes | Yes | Yes | All |
Notes:
InitStack must be called before you use GetPageText.
If you have problems with asian characters, please make sure you use SetCMapDir and load the CMAPs.
Requires DynaPDF Pro license.
See also GetPageText function in DynaPDF manual.
DynaPDFMBS.GetPageWidth as Double
Function:
The function returns the width of the currently open page.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetPageWidth function in DynaPDF manual.
DynaPDFMBS.GetPDFVersion as Integer
Function:
The function returns the minor version of the output PDF file as Integer value.
Notes: Zero stand for PDF 1.0, one for PDF 1.1 and so on.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
Notes: Zero stand for PDF 1.0, one for PDF 1.1 and so on.
See also GetPDFVersion function in DynaPDF manual.
DynaPDFMBS.GetPrintSettings as DynaPDFPrintSettingsMBS
Function:
Queries the print settings for the current document.
Notes: This is a PDF 1.7 extension.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.7 | Yes | Yes | Yes | Yes | All |
Notes: This is a PDF 1.7 extension.
See also GetPrintSettings function in DynaPDF manual.
DynaPDFMBS.GetResetAction(Handle as UInt32) as DynaPDFResetFormActionMBS
Function:
The function returns the properties of a Reset Form Action.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 15.3 | Yes | Yes | Yes | Yes | All |
See also GetResetAction function in DynaPDF manual.
The items on this page are in the following plugins: MBS DynaPDF Plugin.
Links
MBS FileMaker Plugins
