Platforms to show: All Mac Windows Linux Cross-Platform
DynaPDFMBS.GetJavaScriptName(Handle as Integer) as string
Function:
The function returns the name of a global JavaScript.
Notes: The result string has either unicode or ASCII encoding.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
Notes: The result string has either unicode or ASCII encoding.
See also GetJavaScriptName function in DynaPDF manual.
DynaPDFMBS.GetJPEGQuality as Integer
Function:
The function returns the current JPEG compression quality in percent used for newly inserted images which are compressed with JPEG.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetJPEGQuality function in DynaPDF manual.
DynaPDFMBS.GetLanguage as string
Function:
The function returns the language identifier of the document as an ISO 3166 language tag or IANA tag, or "" if not set.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetLanguage function in DynaPDF manual.
DynaPDFMBS.GetLastTextPosX as Double
Function:
The function returns the x coordinate of the last printed text.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
DynaPDFMBS.GetLastTextPosY as Double
Function:
The function returns the y coordinate of the last printed text.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
DynaPDFMBS.GetLaunchAction(index as Integer, Decompress as Boolean = false, ImageParseFlags as Integer = &h00000080) as DynaPDFLaunchActionMBS
Function:
Queries details for a launch action.
Notes:
Index is from 0 to GetActionCount-1.
If Decompress is true, all file specification containing compressed data are uncompressed.
And ImageParseFlags defines how GetImageObj is called internally to decompress image. Default is to only get image info, but you can pass other values to actually get image data.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 17.0 | Yes | Yes | Yes | Yes | All |
Notes:
Index is from 0 to GetActionCount-1.
If Decompress is true, all file specification containing compressed data are uncompressed.
And ImageParseFlags defines how GetImageObj is called internally to decompress image. Default is to only get image info, but you can pass other values to actually get image data.
See also GetLaunchAction function in DynaPDF manual.
DynaPDFMBS.GetLayerConfig(Index as Integer) as DynaPDFOCLayerConfigMBS
Function:
Retrieves the most important properties of a layer configuration.
Notes:
A PDF file can contain one or more layer configurations so that different layers can be initially shown or hidden.
A PDF file that contains layers (Optional Content Groups in PDF syntax) contains usually at least a default configuration dictionary. This configuration is loaded by default when the visibility state of a layer or optional content group must be determined, e.g. when rendering a page.
To determine the number of available configurations call GetLayerConfigCount(). The first index is denoted by 0.
If the function succeeds the return value is the object. If the function fails the return value is nil.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 17.5 | Yes | Yes | Yes | Yes | All |
Notes:
A PDF file can contain one or more layer configurations so that different layers can be initially shown or hidden.
A PDF file that contains layers (Optional Content Groups in PDF syntax) contains usually at least a default configuration dictionary. This configuration is loaded by default when the visibility state of a layer or optional content group must be determined, e.g. when rendering a page.
To determine the number of available configurations call GetLayerConfigCount(). The first index is denoted by 0.
If the function succeeds the return value is the object. If the function fails the return value is nil.
See also GetLayerConfig function in DynaPDF manual.
DynaPDFMBS.GetLayerConfigCount as Integer
Function:
Returns the number of available layer configurations.
Notes:
Note that it is possible that a document contains layers but no layer configuration. To determine whether a document contains layers or optional content groups use GetOCGCount().
To load a specific layer configuration call LoadLayerConfig().
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 17.5 | Yes | Yes | Yes | Yes | All |
Notes:
Note that it is possible that a document contains layers but no layer configuration. To determine whether a document contains layers or optional content groups use GetOCGCount().
To load a specific layer configuration call LoadLayerConfig().
See also GetLayerConfigCount function in DynaPDF manual.
DynaPDFMBS.GetLeading as Double
Function:
The function returns the current leading.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetLeading function in DynaPDF manual.
DynaPDFMBS.GetLineCapStyle as Integer
Function:
The function returns the current line cap style used for vector graphics.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetLineCapStyle function in DynaPDF manual.
DynaPDFMBS.GetLineJoinStyle as Integer
Function:
The function returns the current line join style used for vector graphics.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetLineJoinStyle function in DynaPDF manual.
DynaPDFMBS.GetLineWidth as Double
Function:
The function returns the current line width used for stroked vector graphics and the border of interactive objects.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetLineWidth function in DynaPDF manual.
DynaPDFMBS.GetLinkHighlightMode as Integer
Function:
The function returns the current highlight mode used for newly created annotations.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetLinkHighlightMode function in DynaPDF manual.
DynaPDFMBS.GetLogMetafileSize(FileName as folderitem) as DynaPDFRectMBS
Function:
The function retrieves the logical bounding box of an enhanced or Windows metafile.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetLogMetafileSize function in DynaPDF manual.
DynaPDFMBS.GetLogMetafileSizeEx(Buffer as Memoryblock) as DynaPDFRectMBS
Function:
The function retrieves the logical bounding box of an enhanced or Windows metafile.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 13.0 | Yes | Yes | Yes | Yes | All |
See also:
See also GetLogMetafileSizeEx function in DynaPDF manual.
DynaPDFMBS.GetLogMetafileSizeEx(Buffer as string) as DynaPDFRectMBS
Function:
The function retrieves the logical bounding box of an enhanced or Windows metafile.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also:
See also GetLogMetafileSizeEx function in DynaPDF manual.
DynaPDFMBS.GetMatrix(byref Matrix as DynaPDFMatrixMBS) as Boolean
Function:
The function retrieves the current transformation.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetMatrix function in DynaPDF manual.
DynaPDFMBS.GetMaxFieldLen(TxtField as Integer) as Integer
Function:
The function returns the allowed maximum string length of a text field, or zero if the length is not restricted.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetMaxFieldLen function in DynaPDF manual.
DynaPDFMBS.GetMetaConvFlags as Integer
Function:
The function returns the conversion flags used to convert enhanced metafiles to PDF.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetMetaConvFlags function in DynaPDF manual.
DynaPDFMBS.GetMetadata(ObjType as Integer, Handle as Integer) as String
Function:
The function can be used to access the optional metadata streams of pages, fonts, images, pages, templates, as well as the global metadata stream that is associated with the Catalog object.
Notes:
Metadata streams are in XMP format that is a superset of XML.
The global metadata stream will be created when this function is called. The returned stream is a preview of the XMP stream that will be stored in the file when CloseFile or CloseFileEx is called. Note that the creation and modification date will be updated when the file is closed.
The original global XMP stream of external PDF files can be accessed with GetInMetadata().
Metadata streams are optional and maybe not present. The function returns true if no error occurs, also if no metadata stream is present.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 14.0 | Yes | Yes | Yes | Yes | All |
Notes:
Metadata streams are in XMP format that is a superset of XML.
The global metadata stream will be created when this function is called. The returned stream is a preview of the XMP stream that will be stored in the file when CloseFile or CloseFileEx is called. Note that the creation and modification date will be updated when the file is closed.
The original global XMP stream of external PDF files can be accessed with GetInMetadata().
Metadata streams are optional and maybe not present. The function returns true if no error occurs, also if no metadata stream is present.
See also GetMetadata function in DynaPDF manual.
DynaPDFMBS.GetMissingGlyphs as UInt32()
Function:
Returns an array with missing glyphs.
Notes: See also GetMissingGlyphsString.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 10.1 | Yes | Yes | Yes | Yes | All |
Notes: See also GetMissingGlyphsString.
See also GetMissingGlyphs function in DynaPDF manual.
DynaPDFMBS.GetMissingGlyphsString as String
Function:
Returns a string containing the missing glpyhs characters.
Notes:
This is a convenience function which builds a string from the array given by pdfGetMissingGlyphs.
See also GetMissingGlyphs.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 12.2 | Yes | Yes | Yes | Yes | All |
Notes:
This is a convenience function which builds a string from the array given by pdfGetMissingGlyphs.
See also GetMissingGlyphs.
DynaPDFMBS.GetMiterLimit as Double
Function:
The function returns the current miter limit used to draw stroked vector graphics.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetMiterLimit function in DynaPDF manual.
DynaPDFMBS.GetMovieAction(index as Integer, Decompress as Boolean = false, ImageParseFlags as Integer = &h00000080) as DynaPDFFieldMBS
Function:
Queries details for a movie action.
Notes:
Index is from 0 to GetActionCount-1.
If Decompress is true, all file specification containing compressed data are uncompressed.
And ImageParseFlags defines how GetImageObj is called internally to decompress image. Default is to only get image info, but you can pass other values to actually get image data.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 17.0 | Yes | Yes | Yes | Yes | All |
Notes:
Index is from 0 to GetActionCount-1.
If Decompress is true, all file specification containing compressed data are uncompressed.
And ImageParseFlags defines how GetImageObj is called internally to decompress image. Default is to only get image info, but you can pass other values to actually get image data.
See also GetMovieAction function in DynaPDF manual.
DynaPDFMBS.GetNamedAction(index as Integer) as DynaPDFNamedActionMBS
Function:
Queries details for a named action.
Notes: Index is from 0 to GetActionCount-1.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 17.0 | Yes | Yes | Yes | Yes | All |
Notes: Index is from 0 to GetActionCount-1.
See also GetNamedAction function in DynaPDF manual.
DynaPDFMBS.GetNamedDest(index as Integer) as DynaPDFNamedDestMBS
Function:
Queries information about the named destination with the given index.
Notes:
Index from 0 to GetNamedDestCount-1.
Returns nil on any error.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 11.1 | Yes | Yes | Yes | Yes | All |
Notes:
Index from 0 to GetNamedDestCount-1.
Returns nil on any error.
See also GetNamedDest function in DynaPDF manual.
DynaPDFMBS.GetNamedDestCount as Integer
Function:
Queries number of named destination objects.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 11.1 | Yes | Yes | Yes | Yes | All |
See also GetNamedDestCount function in DynaPDF manual.
DynaPDFMBS.GetNeedAppearance as boolean
Function:
Whether appearance is needed.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 9.3 | Yes | Yes | Yes | Yes | All |
See also GetNeedAppearance function in DynaPDF manual.
DynaPDFMBS.GetObjActionCount(ObjType as Integer, ObjHandle as Integer) as Integer
Function:
The function returns the number of actions used by an object.
| 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 GetObjActions instead.
DynaPDFMBS.GetObjActions(ObjType as Integer, ObjHandle as Integer, byref Actions as DynaPDFObjActionsMBS) as Integer
Function:
Queries details for an object action.
Notes:
Index is from 0 to GetActionCount-1.
The function retrieves the first action and additional trigger events that should be executed when a specific event occurs.
If the object type is a page, then use the page number as handle.
Trigger events are supported by the global Catalog object (this is the document root), Pages, and Form Fields. All other objects do not support trigger events.
Actions are defined as a single linked list. That means one action can execute another action (if NextAction of that action is >= 0).
Note that an action can reference itself! The application must check whether an action is already in the execution list before it will be executed.
If an error occurred, the plugin returns nil.
On success, we provide the DynaPDFObjActionsMBS object in Actions parameter.
Return values:
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 17.0 | Yes | Yes | Yes | Yes | All |
Notes:
Index is from 0 to GetActionCount-1.
The function retrieves the first action and additional trigger events that should be executed when a specific event occurs.
If the object type is a page, then use the page number as handle.
Trigger events are supported by the global Catalog object (this is the document root), Pages, and Form Fields. All other objects do not support trigger events.
Actions are defined as a single linked list. That means one action can execute another action (if NextAction of that action is >= 0).
Note that an action can reference itself! The application must check whether an action is already in the execution list before it will be executed.
If an error occurred, the plugin returns nil.
On success, we provide the DynaPDFObjActionsMBS object in Actions parameter.
Return values:
| <0 | An error occurred, e.g. due to an invalid handle. |
| 0 | The object contains no action or trigger event. |
| 1 | The object contains an action. |
| 2 | The object contains a trigger event. |
| 3 | The object contains an action and a trigger event. |
See also GetObjActions function in DynaPDF manual.
The items on this page are in the following plugins: MBS DynaPDF Plugin.
Links
MBS FileMaker tutorial videos
