Xojo Conferences
MBSOct2019CologneDE

Platforms to show: All Mac Windows Linux Cross-Platform

Previous items Next items

DynaPDFMBS.GetLastTextPosX as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function returns the x coordinate of the last printed text.

Feedback, Comments & Corrections

DynaPDFMBS.GetLastTextPosY as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function returns the y coordinate of the last printed text.

Feedback, Comments & Corrections

DynaPDFMBS.GetLaunchAction(index as Integer, Decompress as Boolean = false, ImageParseFlags as Integer = &h00000080) as DynaPDFLaunchActionMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 17.0 Yes Yes Yes Yes No
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.

See also GetLaunchAction function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetLayerConfig(Index as Integer) as DynaPDFOCLayerConfigMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 17.5 Yes Yes Yes Yes No
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.

See also GetLayerConfig function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetLayerConfigCount as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 17.5 Yes Yes Yes Yes No
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().

See also GetLayerConfigCount function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetLeading as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function returns the current leading.

See also GetLeading function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetLineCapStyle as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function returns the current line cap style used for vector graphics.

See also GetLineCapStyle function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetLineJoinStyle as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function returns the current line join style used for vector graphics.

See also GetLineJoinStyle function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetLineWidth as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: 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.

Feedback, Comments & Corrections

DynaPDFMBS.GetLinkHighlightMode as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function returns the current highlight mode used for newly created annotations.

See also GetLinkHighlightMode function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetLogMetafileSize(FileName as folderitem) as DynaPDFRectMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function retrieves the logical bounding box of an enhanced or Windows metafile.

See also GetLogMetafileSize function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetLogMetafileSizeEx(Buffer as Memoryblock) as DynaPDFRectMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 13.0 Yes Yes Yes Yes No
Function: The function retrieves the logical bounding box of an enhanced or Windows metafile.

See also:

See also GetLogMetafileSizeEx function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetLogMetafileSizeEx(Buffer as string) as DynaPDFRectMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function retrieves the logical bounding box of an enhanced or Windows metafile.

See also:

See also GetLogMetafileSizeEx function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetMatrix(byref Matrix as DynaPDFMatrixMBS) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function retrieves the current transformation.

See also GetMatrix function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetMaxFieldLen(TxtField as Integer) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
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.

Feedback, Comments & Corrections

DynaPDFMBS.GetMetaConvFlags as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function returns the conversion flags used to convert enhanced metafiles to PDF.

See also GetMetaConvFlags function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetMetadata(ObjType as Integer, Handle as Integer) as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 14.0 Yes Yes Yes Yes No
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.

Feedback, Comments & Corrections

DynaPDFMBS.GetMissingGlyphs as UInt32()
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 10.1 Yes Yes Yes Yes No
Function: Returns an array with missing glyphs.
Notes: See also GetMissingGlyphsString.

See also GetMissingGlyphs function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetMissingGlyphsString as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 12.2 Yes Yes Yes Yes No
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.

Feedback, Comments & Corrections

DynaPDFMBS.GetMiterLimit as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function returns the current miter limit used to draw stroked vector graphics.

See also GetMiterLimit function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetMovieAction(index as Integer, Decompress as Boolean = false, ImageParseFlags as Integer = &h00000080) as DynaPDFFieldMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 17.0 Yes Yes Yes Yes No
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.

Feedback, Comments & Corrections

DynaPDFMBS.GetNamedAction(index as Integer) as DynaPDFNamedActionMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 17.0 Yes Yes Yes Yes No
Function: Queries details for a named action.
Notes: Index is from 0 to GetActionCount-1.

See also GetNamedAction function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetNamedDest(index as Integer) as DynaPDFNamedDestMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 11.1 Yes Yes Yes Yes No
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.

Feedback, Comments & Corrections

DynaPDFMBS.GetNamedDestCount as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 11.1 Yes Yes Yes Yes No
Function: Queries number of named destination objects.

See also GetNamedDestCount function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetNeedAppearance as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 9.3 Yes Yes Yes Yes No
Function: Whether appearance is needed.

See also GetNeedAppearance function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetObjActionCount(ObjType as Integer, ObjHandle as Integer) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function returns the number of actions used by an object.

Feedback, Comments & Corrections

DynaPDFMBS.GetObjActions(ObjType as Integer, ObjHandle as Integer, byref Actions as DynaPDFObjActionsMBS) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 17.0 Yes Yes Yes Yes No
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.

See also GetObjActions function in DynaPDF manual.

Feedback, Comments & Corrections

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

See also GetOCG function in DynaPDF manual.

Feedback, Comments & Corrections

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

Feedback, Comments & Corrections

DynaPDFMBS.GetOCGCount as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 15.0 Yes Yes Yes Yes No
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.

See also GetOCGCount function in DynaPDF manual.

Feedback, Comments & Corrections

Previous items Next items

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

The biggest plugin in space...




Links
MBS Xojo Plugins