Platforms to show: All Mac Windows Linux Cross-Platform

Back to DynaPDFMBS class.

Previous items Next items

DynaPDFMBS.GetInIsTaggedPDF as integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 21.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Whether the currently open import file is a Tagged PDF file.

The PDF file must be opened beforehand with OpenImportFile() or OpenImportBuffer().
The return value is a set flags indicating the tagging status of the file.

If the function succeeds, the return value is greater or equal zero. If the function fails, the return value is a negative error code.

See also GetInIsTaggedPDF function in DynaPDF manual.

DynaPDFMBS.GetInIsTrapped as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 10.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Whether the input PDF is trapped.

Changed to integer in order to allow returning error codes besides 0 for false and 1 for true.

See also GetInIsTrapped function in DynaPDF manual.

DynaPDFMBS.GetInIsXFAForm as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.6 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Whether the input PDF is a XFA form.

Changed to integer in order to allow returning error codes besides 0 for false and 1 for true.

See also GetInIsXFAForm function in DynaPDF manual.

DynaPDFMBS.GetInMetadata(PageNum as Integer) as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 14.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Access the optional metadata streams of pages or the global metadata stream of the current open import file.

Metadata streams are in XMP format that is a superset of XML. The PDF file must be opened with OpenImportImportFile or OpenImportBuffer beforehand.
Although the global XMP stream does usually exist in todays PDF files, 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 GetInMetadata function in DynaPDF manual.

DynaPDFMBS.GetInOrientation(PageNum as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the orientation of a specific page within the currently open import file (see also OpenImportFile()).

Some examples using this method:

See also GetInOrientation function in DynaPDF manual.

DynaPDFMBS.GetInPageCount as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the number of pages contained in an external PDF file.

Some examples using this method:

See also GetInPageCount function in DynaPDF manual.

DynaPDFMBS.GetInPDFVersion as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the minor PDF version number of an external PDF file.

See also GetInPDFVersion function in DynaPDF manual.

DynaPDFMBS.GetInPDFVersionEx as DynaPDFVersionInfoMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 21.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function retrieves the version information of the currently open import file.

See also GetInPDFVersionEx function in DynaPDF manual.

DynaPDFMBS.GetInPrintSettings as DynaPDFPrintSettingsMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.7 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Queries the print settings for the imported document.

This is a PDF 1.7 extension.

See also GetInPrintSettings function in DynaPDF manual.

DynaPDFMBS.GetInRepairMode as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 11.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This function can be used to determine whether the current open import file was opened in repair or normal mode.

Changed to integer in order to allow returning error codes besides 0 for false and 1 for true.

See also GetInRepairMode function in DynaPDF manual.

DynaPDFMBS.GetIsFixedPitch as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns 1 if the active font is a fixed pitch font or 0 if the font is a variable pitch font.

Changed to integer in order to allow returning error codes besides 0 for false and 1 for true.

See also GetIsFixedPitch function in DynaPDF manual.

DynaPDFMBS.GetIsTaggingEnabled as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 11.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Whether tagging is enabled.

See also GetIsTaggingEnabled function in DynaPDF manual.

DynaPDFMBS.GetItalicAngle as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the italic angle in degrees that will be used to emulate italic style fonts.

See also GetItalicAngle function in DynaPDF manual.

DynaPDFMBS.GetJavaScript(Handle as Integer) as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns a global JavaScript as string.

The result text string has either unicode or ASCII encoding.

You can use JavaScriptEngineMBS class to execute JavaScript without HTMLViewer in our own cross platform JavaScript engine.

If the JavaScript is attached to a field, please use GetFieldEx functions to get the action handle (DynaPDFFieldExMBS.Action) and then use GetJavaScriptAction instead.

See also GetJavaScript function in DynaPDF manual.

DynaPDFMBS.GetJavaScriptAction(Handle as Integer) as string   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This item is deprecated and should no longer be used. You can use GetJavaScriptActionEx instead.
Returns a java script action value for the given handle.

May return an unicode string.

See also:

See also GetJavaScriptAction function in DynaPDF manual.

DynaPDFMBS.GetJavaScriptAction(ObjType as Integer, ObjHandle as Integer, ActIndex as Integer, byref ObjEvent as Integer) as string   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This item is deprecated and should no longer be used. You can use GetJavaScriptActionEx instead.
Returns a java script action value for the given object.

May return an unicode string.

The ObjEvent parameter was added in plugin version 9.3 and contains a value from the koe* constants.

See also:

See also GetJavaScriptAction function in DynaPDF manual.

DynaPDFMBS.GetJavaScriptActionEx(index as Integer) as DynaPDFJavaScriptActionMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 17.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Queries details for an javascript action.

Index is from 0 to GetActionCount-1.

Some examples using this method:

See also GetJavaScriptActionEx function in DynaPDF manual.

DynaPDFMBS.GetJavaScriptCount as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the number of global JavaScripts contained in a document.

Some examples using this method:

See also GetJavaScriptCount function in DynaPDF manual.

DynaPDFMBS.GetJavaScriptEx(Name as string) as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns a global JavaScript as string by using the script s name instead of a handle to identify the script.

The result string is an unicode or an ASCII string.

You can use JavaScriptEngineMBS class to execute JavaScript without HTMLViewer in our own cross platform JavaScript engine.

If the JavaScript is attached to a field, please use GetFieldEx functions to get the action handle (DynaPDFFieldExMBS.Action) and then use GetJavaScriptAction instead.

Some examples using this method:

See also GetJavaScriptEx function in DynaPDF manual.

DynaPDFMBS.GetJavaScriptName(Handle as Integer) as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the name of a global JavaScript.

The result string has either unicode or ASCII encoding.

Some examples using this method:

See also GetJavaScriptName function in DynaPDF manual.

DynaPDFMBS.GetJPEGQuality as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the current JPEG compression quality in percent used for newly inserted images which are compressed with JPEG.

See also GetJPEGQuality function in DynaPDF manual.

DynaPDFMBS.GetLanguage as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the language identifier of the document as an ISO 3166 language tag or IANA tag, or "" if not set.

See also GetLanguage function in DynaPDF manual.

DynaPDFMBS.GetLastTextOffset as UInt32

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 23.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Returns current text offset for WriteFText.

This lets you know how much text is left to write when you get a page break event.

Some examples using this method:

DynaPDFMBS.GetLastTextPosX as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the x coordinate of the last printed text.

Some examples using this method:

DynaPDFMBS.GetLaunchAction(index as Integer, Decompress as Boolean = false, ImageParseFlags as Integer = &h00000080) as DynaPDFLaunchActionMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 17.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Queries details for a launch action.

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

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 17.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Retrieves the most important properties of a layer configuration.

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

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 17.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Returns the number of available layer configurations.

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

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the current leading.

See also GetLeading function in DynaPDF manual.

DynaPDFMBS.GetLineCapStyle as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the current line cap style used for vector graphics.

See also GetLineCapStyle function in DynaPDF manual.

DynaPDFMBS.GetLineJoinStyle as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the current line join style used for vector graphics.

See also GetLineJoinStyle function in DynaPDF manual.

DynaPDFMBS.GetLineWidth as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the current line width used for stroked vector graphics and the border of interactive objects.

See also GetLineWidth function in DynaPDF manual.

DynaPDFMBS.GetLinkHighlightMode as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the current highlight mode used for newly created annotations.

See also GetLinkHighlightMode function in DynaPDF manual.

DynaPDFMBS.GetLogMetafileSize(FileName as folderitem) as DynaPDFRectMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function retrieves the logical bounding box of an enhanced or Windows metafile.

Some examples using this method:

See also GetLogMetafileSize function in DynaPDF manual.

DynaPDFMBS.GetLogMetafileSizeEx(Buffer as Memoryblock) as DynaPDFRectMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 13.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function retrieves the logical bounding box of an enhanced or Windows metafile.

See also:

See also GetLogMetafileSizeEx function in DynaPDF manual.

DynaPDFMBS.GetLogMetafileSizeEx(Buffer as string) as DynaPDFRectMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function retrieves the logical bounding box of an enhanced or Windows metafile.

See also:

See also GetLogMetafileSizeEx function in DynaPDF manual.

DynaPDFMBS.GetMatrix(byref Matrix as DynaPDFMatrixMBS) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function retrieves the current transformation.

Some examples using this method:

See also GetMatrix function in DynaPDF manual.

DynaPDFMBS.GetMaxFieldLen(TxtField as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the allowed maximum string length of a text field, or zero if the length is not restricted.

See also GetMaxFieldLen function in DynaPDF manual.

DynaPDFMBS.GetMetaConvFlags as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the conversion flags used to convert enhanced metafiles to PDF.

See also GetMetaConvFlags function in DynaPDF manual.

DynaPDFMBS.GetMetadata(ObjType as Integer, Handle as Integer) as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 14.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
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.

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()

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 10.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Returns an array with missing glyphs.

See also GetMissingGlyphsString.

See also GetMissingGlyphs function in DynaPDF manual.

DynaPDFMBS.GetMissingGlyphsString as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 12.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Returns a string containing the missing glpyhs characters.

This is a convenience function which builds a string from the array given by pdfGetMissingGlyphs.

See also GetMissingGlyphs.

DynaPDFMBS.GetMiterLimit as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the current miter limit used to draw stroked vector graphics.

See also GetMiterLimit function in DynaPDF manual.

DynaPDFMBS.GetMovieAction(index as Integer, Decompress as Boolean = false, ImageParseFlags as Integer = &h00000080) as DynaPDFFieldMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 17.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Queries details for a movie action.

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

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 17.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Queries details for a named action.

Index is from 0 to GetActionCount-1.

See also GetNamedAction function in DynaPDF manual.

DynaPDFMBS.GetNamedDest(index as Integer) as DynaPDFNamedDestMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 11.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Queries information about the named destination with the given index.

Index from 0 to GetNamedDestCount-1.
Returns nil on any error.

See also GetNamedDest function in DynaPDF manual.

DynaPDFMBS.GetNamedDestCount as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 11.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Queries number of named destination objects.

See also GetNamedDestCount function in DynaPDF manual.

DynaPDFMBS.GetNeedAppearance as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Whether appearance is needed.

See also GetNeedAppearance function in DynaPDF manual.

DynaPDFMBS.GetObjActionCount(ObjType as Integer, ObjHandle as Integer) as Integer   Deprecated

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.
The function returns the number of actions used by an object.

See also GetObjActionCount function in DynaPDF manual.

DynaPDFMBS.GetObjActions(ObjType as Integer, ObjHandle as Integer, byref Actions as DynaPDFObjActionsMBS) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 17.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Queries details for an object action.

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:
<0An error occurred, e.g. due to an invalid handle.
0The object contains no action or trigger event.
1The object contains an action.
2The object contains a trigger event.
3The object contains an action and a trigger event.

Some examples using this method:

See also GetObjActions function in DynaPDF manual.

Previous items Next items

The items on this page are in the following plugins: MBS DynaPDF Plugin.


The biggest plugin in space...