Platforms to show: All Mac Windows Linux Cross-Platform

Previous items Next items

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
Function: 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
Function: 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
Function: 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
Function: 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
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.

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
Function: Returns an array with missing glyphs.
Notes: 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
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.
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
Function: 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
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.

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
Function: Queries details for a named action.
Notes: 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
Function: Queries information about the named destination with the given index.
Notes:
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
Function: 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
Function: 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
Function: The function returns the number of actions used by an object.
This item is deprecated and should no longer be used. You can use GetObjActions instead.

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
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:
<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.

DynaPDFMBS.GetOCG(Handle as UInt32) as DynaPDFOCGMBS
Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 15.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
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.

Some examples using this method:

See also GetOCG function in DynaPDF manual.

DynaPDFMBS.GetOCGContUsage(Handle as UInt32) as DynaPDFOCGContUsageMBS
Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 15.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
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.

See also GetOCGContUsage function in DynaPDF manual.

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

Some examples using this method:

See also GetOCGCount function in DynaPDF manual.

DynaPDFMBS.GetOCGUsageUserName(Handle as UInt32, Index as UInt32, byref Name as String) as Boolean
Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 15.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
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.

See also GetOCGUsageUserName function in DynaPDF manual.

DynaPDFMBS.GetOCUINode(Node as Integer) as DynaPDFOCUINodeMBS
Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 17.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
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.

See also GetOCUINode function in DynaPDF manual.

DynaPDFMBS.GetOpacity as Double
Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: The function returns the opacity value used to draw the visible appearance of an annotation (requires Acrobat 5 or higher).

See also GetOpacity function in DynaPDF manual.

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

Some examples using this method:

See also GetOrientation function in DynaPDF manual.

DynaPDFMBS.GetOutputIntent(Index as Integer) as DynaPDFOutputIntentMBS
Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 14.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
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.

See also GetOutputIntent function in DynaPDF manual.

DynaPDFMBS.GetOutputIntentCount as Integer
Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 14.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Returns the number of available output intents.

See also GetOutputIntentCount function in DynaPDF manual.

DynaPDFMBS.GetPageAnnot(index as Integer) as DynaPDFAnnotationMBS deprecated
Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.6 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Retrieves the page annotation with the given index.
This item is deprecated and should no longer be used. You can use GetPageAnnotEx instead.

See also GetPageAnnot function in DynaPDF manual.

DynaPDFMBS.GetPageAnnotCount as Integer
Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.6 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Queries the page annotation count.

See also GetPageAnnotCount function in DynaPDF manual.

DynaPDFMBS.GetPageAnnotEx(index as Integer) as DynaPDFAnnotationExMBS
Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.6 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Queries an extended annotation with the given index.

See also GetPageAnnotEx function in DynaPDF manual.

DynaPDFMBS.GetPageColorSpaces as DynaPDFColorSpaceMBS()
Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 16.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
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.

Some examples using this method:

DynaPDFMBS.GetPageCoords as Integer
Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Queries the page coordinate system setting.
Notes: The native coordinate system of the Portable Document Format is bottom up.

Some examples using this method:

See also GetPageCoords function in DynaPDF manual.

Previous items Next items

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

Feedback: Report problem or ask question.

The biggest plugin in space...


Start Chat