Platforms to show: All Mac Windows Linux Cross-Platform
DynaPDFMBS.GetUseGlobalImpFiles as Boolean
Function:
The property specifies whether import files should be loaded permanent into memory, e.g. to enable splitting of large PDF files.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetUseGlobalImpFiles function in DynaPDF manual.
DynaPDFMBS.GetUserRights as Integer
Function:
The function returns the encryption flags of an imported PDF file or -1 if the imported PDF file was not encrypted.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetUserRights function in DynaPDF manual.
DynaPDFMBS.GetUserUnit as single
Function:
The function returns the user unit of the current open page.
Notes:
A user unit acts like a scaling factor. The page format and all page coordinates are multiplied with this factor in a viewer application. The default size of a PDF unit is 1/72 inch and the default user unit is 1.0. User units can be useful if the page format would be too large to be expressed in standard PDF units. The largest page format in PDF is limited to 14400 units or 200 inches. This limit can be extended with the user unit.
The largest value that is supported is 75.0 which results in a maximum page format of 15,000 x 15,000 inches or 1,800,000 units.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 11.3 | Yes | Yes | Yes | Yes | All |
Notes:
A user unit acts like a scaling factor. The page format and all page coordinates are multiplied with this factor in a viewer application. The default size of a PDF unit is 1/72 inch and the default user unit is 1.0. User units can be useful if the page format would be too large to be expressed in standard PDF units. The largest page format in PDF is limited to 14400 units or 200 inches. This limit can be extended with the user unit.
The largest value that is supported is 75.0 which results in a maximum page format of 15,000 x 15,000 inches or 1,800,000 units.
See also GetUserUnit function in DynaPDF manual.
DynaPDFMBS.GetUseStdFonts as Boolean
Function:
The function returns 1 (true) if the 14 standard fonts are enabled.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetUseStdFonts function in DynaPDF manual.
DynaPDFMBS.GetUsesTransparency(Page as Integer = -1) as Boolean
Function:
Checks whether a page or the entire document uses transparency.
Notes:
This is no quick check as GetDocUsesTransparency() applies. The function parses the page or pages to determine whether transparent objects are relly used.
To check whether a specific page uses transparency set the parameter PageNum to the wished page number. The first page is denoted by 1. To check the entire PDF file set PageNum to -1.
The return value is a bit mask on success (a positive integer value), or a negative error code on failure.
The following flags are defined:
The above values can occur in any combination. To check whether a specific flag was set use a binary and operator: BitwiseAnd(value, flag)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 18.2 | Yes | Yes | Yes | Yes | All |
Notes:
This is no quick check as GetDocUsesTransparency() applies. The function parses the page or pages to determine whether transparent objects are relly used.
To check whether a specific page uses transparency set the parameter PageNum to the wished page number. The first page is denoted by 1. To check the entire PDF file set PageNum to -1.
The return value is a bit mask on success (a positive integer value), or a negative error code on failure.
The following flags are defined:
- 0: The page or document uses no transparency.
- 1: The content stream of a page contains transparent objects.
- 2: A page defines the blending color space (Group dictionary).
- 4: A page contains transparent annotations or form fields.
The above values can occur in any combination. To check whether a specific flag was set use a binary and operator: BitwiseAnd(value, flag)
See also GetUsesTransparency function in DynaPDF manual.
DynaPDFMBS.GetUseSystemFonts as Boolean
Function:
The property specifies whether the %Windows%/Fonts directory should be added automatically to the list of available font search paths.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetUseSystemFonts function in DynaPDF manual.
DynaPDFMBS.GetUseTransparency as Boolean
Function:
The property specifies whether images should get a transparent background.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetUseTransparency function in DynaPDF manual.
DynaPDFMBS.GetUseVisibleCoords as Boolean
Function:
The property specifies whether DynaPDF should consider the crop box to calculate to position of an object.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetUseVisibleCoords function in DynaPDF manual.
DynaPDFMBS.GetViewerPreferences(byref Preference as Integer, byref AddVal as Integer) as Boolean
Function:
The function retrieves the viewer preferences specified in the document.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetViewerPreferences function in DynaPDF manual.
DynaPDFMBS.GetViewport(Page as UInt32, index as Integer) as DynaPDFViewportMBS
Function:
Returns a viewport that is associated with a page.
Notes:
A viewport is a rectangular region of a page, that specifies usually a measure coordinate system or points in a geospatical coordinate system.
Since viewports might overlap, to determine the viewport to use for any point on a page, the viewports in the array shall be examined, starting with the last one and iterating in reverse, and the first one whose BBox entry contains the point shall be chosen.
To determine how viewports and measure dictionaries can be used, please have a look into the PDF Reference 2.0, ISO/DIS 32000-2, Section Measurement properties.
Returns nil on any error.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 15.0 | Yes | Yes | Yes | Yes | All |
Notes:
A viewport is a rectangular region of a page, that specifies usually a measure coordinate system or points in a geospatical coordinate system.
Since viewports might overlap, to determine the viewport to use for any point on a page, the viewports in the array shall be examined, starting with the last one and iterating in reverse, and the first one whose BBox entry contains the point shall be chosen.
To determine how viewports and measure dictionaries can be used, please have a look into the PDF Reference 2.0, ISO/DIS 32000-2, Section Measurement properties.
Returns nil on any error.
See also GetViewport function in DynaPDF manual.
DynaPDFMBS.GetViewportCount(Page as UInt32) as Integer
Function:
Returns the number of viewports which are associated with a page.
Notes:
The first page has the page number 1.
If the function succeeds the return value is the number of viewports, a number greater or equal zero. If the function fails the return value is a negative error code. The function can only fail if the page number is invalid.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 15.0 | Yes | Yes | Yes | Yes | All |
Notes:
The first page has the page number 1.
If the function succeeds the return value is the number of viewports, a number greater or equal zero. If the function fails the return value is a negative error code. The function can only fail if the page number is invalid.
See also GetViewportCount function in DynaPDF manual.
DynaPDFMBS.GetWMFDefExtent(byref width as Integer, byref height as Integer) as Boolean
Function:
The function retrieves the default size which is used to convert non portable WMF files to EMF.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetWMFDefExtent function in DynaPDF manual.
DynaPDFMBS.GetWMFPixelPerInch as Integer
Function:
The function returns the default pixels per inch of the y-axis which are used to convert portable WMF files to EMF.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetWMFPixelPerInch function in DynaPDF manual.
DynaPDFMBS.GetWordSpacing as Double
Function:
The function returns the current word spacing.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetWordSpacing function in DynaPDF manual.
DynaPDFMBS.GetXFAStream(Handle as UInt32) as DynaPDFXFAStreamMBS
Function:
The function returns an XFA stream.
Notes:
The parameter Index is the array index. The function GetXFAStreamCount() returns the number of available streams.
An XFA form consist of several XML streams. The stream name must be used to determine which stream was returned.
If the function succeeds the return value is 1. If the function fails the return value is 0.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 16.5 | Yes | Yes | Yes | Yes | All |
Notes:
The parameter Index is the array index. The function GetXFAStreamCount() returns the number of available streams.
An XFA form consist of several XML streams. The stream name must be used to determine which stream was returned.
If the function succeeds the return value is 1. If the function fails the return value is 0.
See also GetXFAStream function in DynaPDF manual.
DynaPDFMBS.GetXFAStreamCount as Integer
Function:
Returns the number of available XFA streams.
Notes:
XFA streams are available after a PDF file was imported.
If the function succeeds the return value is the number of available XFA streams. If the function fails the return value is a negative error code.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 16.5 | Yes | Yes | Yes | Yes | All |
Notes:
XFA streams are available after a PDF file was imported.
If the function succeeds the return value is the number of available XFA streams. If the function fails the return value is a negative error code.
See also GetXFAStreamCount function in DynaPDF manual.
DynaPDFMBS.HaveOpenDoc as Boolean
Function:
If an error occurred it is not always clear whether the PDF file was already deleted or if it is still in memory.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also HaveOpenDoc function in DynaPDF manual.
DynaPDFMBS.HaveOpenPage as Boolean
Function:
Whether a page is open.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 11.1 | Yes | Yes | Yes | Yes | All |
See also HaveOpenPage function in DynaPDF manual.
DynaPDFMBS.HighlightAnnot(SubType as Integer, PosX as Double, PosY as Double, Width as Double, Height as Double, ColorValue as Integer, Author as string, Subject as string, Comment as string) as Integer
Function:
Adds a highlight annotation with unicode text.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.7 | Yes | Yes | Yes | Yes | All |
See also HighlightAnnot function in DynaPDF manual.
DynaPDFMBS.HighlightAnnotAnsi(SubType as Integer, PosX as Double, PosY as Double, Width as Double, Height as Double, ColorValue as Integer, Author as string, Subject as string, Comment as string) as Integer
Function:
Adds a highlight annotation with ANSI text.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.7 | Yes | Yes | Yes | Yes | All |
This item is deprecated and should no longer be used.
You can use Non ANSI function. instead.
See also HighlightAnnot function in DynaPDF manual.
DynaPDFMBS.HighlightOnAllPages(SearchText as string, ColorValue as Color, CaseInsenitive as boolean = false) as Integer
Function:
Highlights text on all pages of the current document.
Notes:
If CaseInsenitive is true, the case of letters is ignored (also umlauts and accents)
Searches on all pages in the document.
Returns number of times the text was found.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 14.0 | Yes | Yes | Yes | Yes | All |
Notes:
If CaseInsenitive is true, the case of letters is ignored (also umlauts and accents)
Searches on all pages in the document.
Returns number of times the text was found.
DynaPDFMBS.HighlightOnCurrentPage(SearchText as string, ColorValue as Color, CaseInsenitive as boolean = false) as Integer
Function:
Highlights text on all pages of the current page.
Notes:
If CaseInsenitive is true, the case of letters is ignored (also umlauts and accents)
Use EditPage function to open the page before you search on it.
Returns number of times the text was found.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 14.0 | Yes | Yes | Yes | Yes | All |
Notes:
If CaseInsenitive is true, the case of letters is ignored (also umlauts and accents)
Use EditPage function to open the page before you search on it.
Returns number of times the text was found.
DynaPDFMBS.ImportBookmarks as Integer
Function:
This function imports the outline tree of the currently opened import file (see OpenImportFile() or OpenImportBuffer()).
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also ImportBookmarks function in DynaPDF manual.
DynaPDFMBS.ImportCatalogObjects as Boolean
Function:
The function imports global objects of the currently opened import file such as bookmarks, JavaScripts, embedded files, open actions, invisible page templates, rendering intents, the document info entries, and certain other global properties such as the page mode or page layout.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also ImportCatalogObjects function in DynaPDF manual.
DynaPDFMBS.ImportDocInfo as Boolean
Function:
The function imports the document info entries from the currently opened import file.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also ImportDocInfo function in DynaPDF manual.
DynaPDFMBS.ImportEncryptionSettings as Boolean
Function:
Imports the encryption settings from the currently open import file (see OpenImportFile() or OpenImportBuffer() for further information).
Notes:
If the PDF file is not encrypted, the function does nothing. To determine whether the open PDF file is encrypted call GetInIsEncrypted().
The encryption settings should be imported to make sure that the PDF file can be saved with the same settings after it was edited. The user rights should be considered if the file was opened with the open password, also if the password was just an empty string. See GetUserRights() for further information.
If the file was opened with the owner password, then all editing rights should be grated. The PDF file must be closed with CloseFile() or CloseAndSignFile() for example. Don't use
CloseFileEx() for example since this function would override the encryption settings.
If the file should be saved unencrypted call ResetEncryptionSettings() before closing the file. Return values:
If the function succeeds the return value is true. If the function fails the return value is false.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 17.0 | Yes | Yes | Yes | Yes | All |
Notes:
If the PDF file is not encrypted, the function does nothing. To determine whether the open PDF file is encrypted call GetInIsEncrypted().
The encryption settings should be imported to make sure that the PDF file can be saved with the same settings after it was edited. The user rights should be considered if the file was opened with the open password, also if the password was just an empty string. See GetUserRights() for further information.
If the file was opened with the owner password, then all editing rights should be grated. The PDF file must be closed with CloseFile() or CloseAndSignFile() for example. Don't use
CloseFileEx() for example since this function would override the encryption settings.
If the file should be saved unencrypted call ResetEncryptionSettings() before closing the file. Return values:
If the function succeeds the return value is true. If the function fails the return value is false.
See also ImportEncryptionSettings function in DynaPDF manual.
DynaPDFMBS.ImportOCProperties as Boolean
Function:
Imports the global Optional Content Properties of the curent open import file.
Notes:
OC properties are normally automatically imported by functions like ImportPDFFile() or when importing a page that contains layers. However, a viewer application must be able to access the OC properties right after the PDF file was opened so that the layer configuration and the layer tree can be loaded (see LoadLayerConfig() and GetOCUINode() for further information).
The function can be called multiple times without causing unwanted side effects.
If the function succeeds the return value is true. If the function fails the return value is false.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 17.5 | Yes | Yes | Yes | Yes | All |
Notes:
OC properties are normally automatically imported by functions like ImportPDFFile() or when importing a page that contains layers. However, a viewer application must be able to access the OC properties right after the PDF file was opened so that the layer configuration and the layer tree can be loaded (see LoadLayerConfig() and GetOCUINode() for further information).
The function can be called multiple times without causing unwanted side effects.
If the function succeeds the return value is true. If the function fails the return value is false.
See also ImportOCProperties function in DynaPDF manual.
DynaPDFMBS.ImportPage(PageNum as Integer) as Integer
Function:
The function imports a page of an external PDF file and converts this page to a template.
Notes: Requires DynaPDF Pro license.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
Notes: Requires DynaPDF Pro license.
See also ImportPage function in DynaPDF manual.
DynaPDFMBS.ImportPageEx(PageNum as Integer, ScaleX as Double = 1.0, ScaleY as Double = 1.0) as Integer
Function:
The function imports a PDF page of an external PDF file incl. interactive objects such as annotations, form fields and so on, if any.
Notes: Requires DynaPDF Pro license.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
Notes: Requires DynaPDF Pro license.
See also ImportPageEx function in DynaPDF manual.
DynaPDFMBS.ImportPDFFile(DestPage as Integer, ScaleX as Double = 1.0, ScaleY as Double = 1.0) as Integer
Function:
The function imports an external PDF file incl. interactive objects such as annotations, bookmarks, form fields and so on.
Example:
Notes:
Scaling factor is ignored if importing as pages (not templates).
This function returns the page number of the last page imported. It does not return how many pages are imported. If you need number of imported pages, please use returned value minus DestPage.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
Example:
// new PDF
Dim pdf As New MyDynapdfMBS
pdf.SetLicenseKey "Lite" // For this example you can use a Lite, Pro or Enterprise License
// create output file
Dim outFile As folderitem = SpecialFolder.Desktop.Child("NewPDF.pdf")
Call pdf.CreateNewPDF(outFile)
// set flags to import all
Dim flags As Integer = Bitwise.BitOr(pdf.kifImportAsPage, pdf.kifImportAll)
Call pdf.SetImportFlags(flags)
// import PDF
Dim inFile As folderitem = SpecialFolder.Desktop.Child("test.pdf")
Call pdf.OpenImportFile(inFile)
Call pdf.ImportPDFFile(1)
// now delete one page
Call pdf.DeletePage(2)
// close output file
Call pdf.closefile
Scaling factor is ignored if importing as pages (not templates).
This function returns the page number of the last page imported. It does not return how many pages are imported. If you need number of imported pages, please use returned value minus DestPage.
See also ImportPDFFile function in DynaPDF manual.
The items on this page are in the following plugins: MBS DynaPDF Plugin.
Links
MBS Xojo tutorial videos
