Xojo Conferences
MBSOct2019CologneDE

Platforms to show: All Mac Windows Linux Cross-Platform

Previous items Next items

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

Feedback, Comments & Corrections

DynaPDFMBS.GetOCUINode(Node as Integer) as DynaPDFOCUINodeMBS
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 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.

Feedback, Comments & Corrections

DynaPDFMBS.GetOpacity 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 opacity value used to draw the visible appearance of an annotation (requires Acrobat 5 or higher).

See also GetOpacity function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetOrientation 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 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.

See also GetOrientation function in DynaPDF manual.

Feedback, Comments & Corrections

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

Feedback, Comments & Corrections

DynaPDFMBS.GetOutputIntentCount as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 14.2 Yes Yes Yes Yes No
Function: Returns the number of available output intents.

See also GetOutputIntentCount function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetPage(PageNum as UInt32) as DynaPDFPageMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 11.1 Yes Yes Yes Yes No
Function: Returns the page object for the given page number.
Notes: If you like to open a page for editing, please use editpage function.

Feedback, Comments & Corrections

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

Feedback, Comments & Corrections

DynaPDFMBS.GetPageAnnotCount as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.6 Yes Yes Yes Yes No
Function: Queries the page annotation count.

See also GetPageAnnotCount function in DynaPDF manual.

Feedback, Comments & Corrections

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

See also GetPageAnnotEx function in DynaPDF manual.

Feedback, Comments & Corrections

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

Feedback, Comments & Corrections

DynaPDFMBS.GetPageCoords 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: Queries the page coordinate system setting.
Notes: The native coordinate system of the Portable Document Format is bottom up.

See also GetPageCoords function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetPageCount 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 pages of the current PDF file if any.

See also GetPageCount function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetPageField(Index as Integer) as DynaPDFFieldMBS
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 most important properties of a field.
This item is deprecated and should no longer be used. You can use GetPageFieldEx instead.

Feedback, Comments & Corrections

DynaPDFMBS.GetPageFieldCount 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 fields used by a page.

See also GetPageFieldCount function in DynaPDF manual.

Feedback, Comments & Corrections

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

See also GetPageFieldEx function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetPageHeight 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 height of the currently open page.

See also GetPageHeight function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetPageLabel(index as Integer, byref Label as DynaPDFPageLabelMBS) 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 properties of a page label.

See also GetPageLabel function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetPageLabelCount 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 page labels defined in the document.

See also GetPageLabelCount function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetPageLayout 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 page layout that is used when opening the document with Adobe s Acrobat.

See also GetPageLayout function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetPageMode 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 page mode that is used when opening the document with Adobe's Acrobat.

See also GetPageMode function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetPageNum 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 page number of the currently open page.

See also GetPageNum function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetPageText(stack as DynaPDFStackMBS) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.7 Yes Yes Yes Yes No
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.

See also GetPageText function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetPageWidth 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 width of the currently open page.

See also GetPageWidth function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetPDFVersion 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 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.

See also GetPDFVersion function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetPrintSettings as DynaPDFPrintSettingsMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.7 Yes Yes Yes Yes No
Function: Queries the print settings for the current document.
Notes: This is a PDF 1.7 extension.

See also GetPrintSettings function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetResetAction(Handle as UInt32) as DynaPDFResetFormActionMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 15.3 Yes Yes Yes Yes No
Function: The function returns the properties of a Reset Form Action.

See also GetResetAction function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetResolution 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 resolution in DPI (Dots per Inch), in which images are stored by DynaPDF.

See also GetResolution function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetSaveNewImageFormat 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: If false, images are not downscaled if necessary.

See also GetSaveNewImageFormat function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetSeparationInfo(byref Colorant as string, byref ColorSpace as Integer) 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 returns the separation info stored in the current open page.

See also GetSeparationInfo 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