Xojo Conferences
| MBS | Oct | 2019 | Cologne | DE |
Platforms to show: All Mac Windows Linux Cross-Platform
DynaPDFMBS.AddActionToObj(ObjType as Integer, theEvent as Integer, ActHandle as Integer, ObjHandle as Integer) as boolean
Function:
This function adds an action to a PDF object.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | No |
See also AddActionToObj function in DynaPDF manual.
DynaPDFMBS.AddAnnotToPage(PageNum as UInt32, Handle as UInt32) as boolean
Function:
Adds an annotation to a page.
Notes:
With exception of PopUp annotations all annotation types can be drawn on multiple pages. Watermark or Stamp annotations are typical annotations which can be placed on multiple pages.
Returns true on success.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 17.0 | Yes | Yes | Yes | Yes | No |
Notes:
With exception of PopUp annotations all annotation types can be drawn on multiple pages. Watermark or Stamp annotations are typical annotations which can be placed on multiple pages.
Returns true on success.
See also AddAnnotToPage function in DynaPDF manual.
DynaPDFMBS.AddArticle(PosX as Double, PosY as Double, Width as Double, Height as Double) as Integer
Function:
This function creates a new article and adds it to the currently open article thread that must be created with CreateArticleThread() beforehand.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | No |
See also AddArticle function in DynaPDF manual.
DynaPDFMBS.AddBookmark(title as String, parent as Integer, DestPage as Integer, Open as boolean) as Integer
Function:
This function adds a bookmark to the global outline tree of the document.
Notes: The title parameter is converted to unicode.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | No |
Notes: The title parameter is converted to unicode.
See also AddBookmark function in DynaPDF manual.
DynaPDFMBS.AddBookmarkAnsi(title as String, parent as Integer, DestPage as Integer, Open as boolean) as Integer
Function:
This function adds a bookmark to the global outline tree of the document.
Notes: The title parameter is converted to ANSI.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 8.3 | Yes | Yes | Yes | Yes | No |
Notes: The title parameter is converted to ANSI.
See also AddBookmark function in DynaPDF manual.
DynaPDFMBS.AddBookmarkEx(title as String, parent as Integer, NamedDest as Integer, Open as boolean) as Integer
Function:
This function adds a bookmark to the global outline tree of the document.
Notes: The title parameter is converted to unicode.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | No |
Notes: The title parameter is converted to unicode.
See also AddBookmarkEx function in DynaPDF manual.
DynaPDFMBS.AddBookmarkEx2(title as String, parent as Integer, NamedDest as String, unicode as boolean, Open as boolean) as Integer
Function:
This function adds a bookmark to the global outline tree of the document.
Notes: If unicode is true, the plugin passes NamedDest as unicode, else as Windows ANSI text.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 12.1 | Yes | Yes | Yes | Yes | No |
Notes: If unicode is true, the plugin passes NamedDest as unicode, else as Windows ANSI text.
See also AddBookmarkEx2 function in DynaPDF manual.
DynaPDFMBS.AddBookmarkEx2Ansi(title as String, parent as Integer, NamedDest as String, unicode as boolean, Open as boolean) as Integer
Function:
This function adds a bookmark to the global outline tree of the document.
Notes: If unicode is true, the plugin passes NamedDest as unicode, else as Windows ANSI text.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 12.1 | Yes | Yes | Yes | Yes | No |
Notes: If unicode is true, the plugin passes NamedDest as unicode, else as Windows ANSI text.
See also AddBookmarkEx2 function in DynaPDF manual.
DynaPDFMBS.AddBookmarkExAnsi(title as String, parent as Integer, NamedDest as Integer, Open as boolean) as Integer
Function:
This function adds a bookmark to the global outline tree of the document.
Notes: The title parameter is converted to ANSI.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 8.3 | Yes | Yes | Yes | Yes | No |
Notes: The title parameter is converted to ANSI.
See also AddBookmarkEx function in DynaPDF manual.
DynaPDFMBS.AddButtonImage(BtnHandle as Integer, State as Integer, Caption as string, ImgFile as Folderitem) as boolean
Function:
The function adds an image to a push button to one or more of the three different states of a button.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | No |
See also AddButtonImage function in DynaPDF manual.
DynaPDFMBS.AddButtonImageEx(BtnHandle as Integer, State as Integer, Caption as string, hbitmap as Integer) as boolean
Function:
The function adds a memory bitmap to a push button in the same ways as AddButtonImage() but accepts a HBITMAP handle as input image.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | No |
See also AddButtonImageEx function in DynaPDF manual.
DynaPDFMBS.AddContinueText(text as string) as boolean
Function:
This function prints a single text line and adds a line feed.
Notes: The text string is converted to Unicode.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | No |
Notes: The text string is converted to Unicode.
See also AddContinueText function in DynaPDF manual.
DynaPDFMBS.AddContinueTextAnsi(text as string) as boolean
Function:
This function prints a single text line and adds a line feed.
Notes: The text string is converted to ANSI.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 8.3 | Yes | Yes | Yes | Yes | No |
Notes: The text string is converted to ANSI.
See also AddContinueText function in DynaPDF manual.
DynaPDFMBS.AddDeviceNProcessColorants(DeviceNCS as Integer, Colorants() as string, ProcessCS as Integer, Handle as Integer) as boolean
Function:
Adds DeviceN process colorants.
Notes: Returns true on success and false on failure.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 9.3 | Yes | Yes | Yes | Yes | No |
Notes: Returns true on success and false on failure.
See also AddDeviceNProcessColorants function in DynaPDF manual.
DynaPDFMBS.AddDeviceNSeparations(DeviceNCS as Integer, Colorants() as string, SeparationCS() as Integer) as boolean
Function:
Adds device N seperations.
Notes:
Same as AddDeviceNSeparationsAnsi, but here the Xojo colorant strings are converted to UTF-8 encoding before they are passed to the DynaPDF library.
ubound(Colorants) must be ubound(SeparationCS).
Returns true on success and false on failure.
Currently limited to 100 colorants on the plugin side.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 9.3 | Yes | Yes | Yes | Yes | No |
Notes:
Same as AddDeviceNSeparationsAnsi, but here the Xojo colorant strings are converted to UTF-8 encoding before they are passed to the DynaPDF library.
ubound(Colorants) must be ubound(SeparationCS).
Returns true on success and false on failure.
Currently limited to 100 colorants on the plugin side.
See also AddDeviceNSeparations function in DynaPDF manual.
DynaPDFMBS.AddDeviceNSeparationsAnsi(DeviceNCS as Integer, Colorants() as string, SeparationCS() as Integer) as boolean
Function:
Adds device N seperations.
Notes:
Same as AddDeviceNSeparations, but here the Xojo colorant strings are converted to ANSI encoding before they are passed to the DynaPDF library.
ubound(Colorants) must be ubound(SeparationCS).
Returns true on success and false on failure.
Currently limited to 100 colorants on the plugin side.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 10.1 | Yes | Yes | Yes | Yes | No |
Notes:
Same as AddDeviceNSeparations, but here the Xojo colorant strings are converted to ANSI encoding before they are passed to the DynaPDF library.
ubound(Colorants) must be ubound(SeparationCS).
Returns true on success and false on failure.
Currently limited to 100 colorants on the plugin side.
See also AddDeviceNSeparations function in DynaPDF manual.
DynaPDFMBS.AddFieldToFormAction(Action as Integer, Field as Integer, Include as Boolean) as boolean
Function:
Adds a field to a form action.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | No |
See also AddFieldToFormAction function in DynaPDF manual.
DynaPDFMBS.AddFieldToHideAction(HideAct as Integer, Field as Integer) as boolean
Function:
This function adds a field to a hide action.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | No |
See also AddFieldToHideAction function in DynaPDF manual.
DynaPDFMBS.AddFileComment(Text as string) as boolean
Function:
Adds one or more comments to the end of the PDF file.
Notes: The text parameter is converted to unicode.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | No |
Notes: The text parameter is converted to unicode.
See also AddFileComment function in DynaPDF manual.
DynaPDFMBS.AddFileCommentAnsi(Text as string) as boolean
Function:
Adds one or more comments to the end of the PDF file.
Notes: The text parameter is converted to ANSI.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 8.3 | Yes | Yes | Yes | Yes | No |
Notes: The text parameter is converted to ANSI.
See also AddFileComment function in DynaPDF manual.
DynaPDFMBS.AddFontSearchPath(path as folderitem, recursive as boolean = true) as Integer
Function:
This function adds a search path to the list of available font search paths.
Example:
Notes:
This function adds a search path to the list of available font search paths. An arbitrary number of search paths can be added at runtime. Subdirectories are included recursively if the parameter Recursive is true.
DynaPDF requires no separate metric files for Type1 fonts.
The list of search directories can be cleared at runtime with the function ClearHostFonts().
If system fonts are enabled (default) DynaPDF adds the default font directories of the operating system automatically to the list of font search paths (Windows and Mac OSX only, see SetUseSystemFonts() for further information). On Windows this is the %Windows%/Fonts directory as well as fonts listed in the Registry and linked fonts.
On Mac OSX the following directories are added to the list of font search paths (in this order):
If the function succeeds the function returns the number of found font files (this is maybe not the number of available fonts, because the list is cleared each time all fonts in the list are processed during font selection). If the function fails a negative error code is returned.
Please call this method on Linux to get fonts loaded from your font folder.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 7.7 | Yes | Yes | Yes | Yes | No |
Example:
dim d as new DynaPDFMBS
if TargetLinux then
call d.AddFontSearchPath "/usr/share/fonts/truetype", true
else
// on Mac and Windows we use system fonts.
end if
This function adds a search path to the list of available font search paths. An arbitrary number of search paths can be added at runtime. Subdirectories are included recursively if the parameter Recursive is true.
DynaPDF requires no separate metric files for Type1 fonts.
The list of search directories can be cleared at runtime with the function ClearHostFonts().
If system fonts are enabled (default) DynaPDF adds the default font directories of the operating system automatically to the list of font search paths (Windows and Mac OSX only, see SetUseSystemFonts() for further information). On Windows this is the %Windows%/Fonts directory as well as fonts listed in the Registry and linked fonts.
On Mac OSX the following directories are added to the list of font search paths (in this order):
- users font folder in ~/Library/Fonts
- /Library/Fonts
- /System/Library/Fonts
If the function succeeds the function returns the number of found font files (this is maybe not the number of available fonts, because the list is cleared each time all fonts in the list are processed during font selection). If the function fails a negative error code is returned.
Please call this method on Linux to get fonts loaded from your font folder.
See also:
See also AddFontSearchPath function in DynaPDF manual.
DynaPDFMBS.AddFontSearchPath(path as string, recursive as boolean = true) as Integer
Function:
This function adds a search path to the list of available font search paths.
Example:
Notes:
This function adds a search path to the list of available font search paths. An arbitrary number of search paths can be added at runtime. Subdirectories are included recursively if the parameter Recursive is true.
DynaPDF requires no separate metric files for Type1 fonts.
This function is implemented in an ANSI and Unicode compatible version. However, Unicode file paths are converted back to ANSI on Windows. On non-Windows operating systems the path is converted to UTF-8 and passed to the ANSI version of the function.
The list of search directories can be cleared at runtime with the function ClearHostFonts().
If system fonts are enabled (default) DynaPDF adds the default font directories of the operating system automatically to the list of font search paths (Windows and Mac OSX only, see SetUseSystemFonts() for further information). On Windows this is the %Windows%/Fonts directory as well as fonts listed in the Registry and linked fonts.
On Mac OSX the following directories are added to the list of font search paths (in this order):
If the function succeeds the function returns the number of found font files (this is maybe not the number of available fonts, because the list is cleared each time all fonts in the list are processed during font selection). If the function fails a negative error code is returned.
Please call this method on Linux to get fonts loaded from your font folder.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 12.5 | Yes | Yes | Yes | Yes | No |
Example:
dim d as new DynaPDFMBS
if TargetLinux then
call d.AddFontSearchPath "/usr/share/fonts/truetype", true
else
// on Mac and Windows we use system fonts.
end if
This function adds a search path to the list of available font search paths. An arbitrary number of search paths can be added at runtime. Subdirectories are included recursively if the parameter Recursive is true.
DynaPDF requires no separate metric files for Type1 fonts.
This function is implemented in an ANSI and Unicode compatible version. However, Unicode file paths are converted back to ANSI on Windows. On non-Windows operating systems the path is converted to UTF-8 and passed to the ANSI version of the function.
The list of search directories can be cleared at runtime with the function ClearHostFonts().
If system fonts are enabled (default) DynaPDF adds the default font directories of the operating system automatically to the list of font search paths (Windows and Mac OSX only, see SetUseSystemFonts() for further information). On Windows this is the %Windows%/Fonts directory as well as fonts listed in the Registry and linked fonts.
On Mac OSX the following directories are added to the list of font search paths (in this order):
- users font folder in ~/Library/Fonts
- /Library/Fonts
- /System/Library/Fonts
If the function succeeds the function returns the number of found font files (this is maybe not the number of available fonts, because the list is cleared each time all fonts in the list are processed during font selection). If the function fails a negative error code is returned.
Please call this method on Linux to get fonts loaded from your font folder.
See also:
See also AddFontSearchPath function in DynaPDF manual.
DynaPDFMBS.AddImage(Filter as Integer, Flags as Integer, Image as DynaPDFImageMBS) as boolean
Function:
Adds an image to the current image file.
Notes:
For the filter you use one of the kcf* constants.
For the flags you use either kicNone of kicUseCCITT4.
TIFF is the only format that supports different compression filters. The Filter parameter of the function AddImage() is ignored if the image format supports only one specific compression filter.
Note that images are automatically converted to the nearest supported color space if the image format does not support the color space of the image.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 8.6 | Yes | Yes | Yes | Yes | No |
Notes:
For the filter you use one of the kcf* constants.
For the flags you use either kicNone of kicUseCCITT4.
TIFF is the only format that supports different compression filters. The Filter parameter of the function AddImage() is ignored if the image format supports only one specific compression filter.
Note that images are automatically converted to the nearest supported color space if the image format does not support the color space of the image.
See also AddImage function in DynaPDF manual.
DynaPDFMBS.AddInkList(InkAnnot as UInt32, points() as DynaPDFPointMBS) as boolean
Function:
Adds an array of points or path to an Ink Annotation.
Notes:
The function must be called within an open page.
An ink annotation can contain an arbitrary number of paths. The points will be connected by curves to achieve a smooth transition between points. The coordinates are treated in current user space. Any transformation that was applied on the coordinate system will be taken into account.
If the number of points is zero then all paths will be deleted from the annotation.
Returns true on success.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 15.3 | Yes | Yes | Yes | Yes | No |
Notes:
The function must be called within an open page.
An ink annotation can contain an arbitrary number of paths. The points will be connected by curves to achieve a smooth transition between points. The coordinates are treated in current user space. Any transformation that was applied on the coordinate system will be taken into account.
If the number of points is zero then all paths will be deleted from the annotation.
Returns true on success.
See also AddInkList function in DynaPDF manual.
DynaPDFMBS.AddJavaScript(Name as string, Script as string) as Integer
Function:
The function adds a global JavaScript to the PDF file.
Notes: The script parameter is converted to unicode.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | No |
Notes: The script parameter is converted to unicode.
See also AddJavaScript function in DynaPDF manual.
DynaPDFMBS.AddJavaScriptAnsi(Name as string, Script as string) as Integer
Function:
The function adds a global JavaScript to the PDF file.
Notes: The script parameter is converted to ANSI.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 8.3 | Yes | Yes | Yes | Yes | No |
Notes: The script parameter is converted to ANSI.
See also AddJavaScript function in DynaPDF manual.
DynaPDFMBS.AddLayerToDisplTree(parent as DynaPDFLayerGroupMBS, layer as UInt32, Title as string) as DynaPDFLayerGroupMBS
Function:
Adds a layer to the display tree.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 12.4 | Yes | Yes | Yes | Yes | No |
See also AddLayerToDisplTree function in DynaPDF manual.
DynaPDFMBS.AddLayerToDisplTreeAnsi(parent as DynaPDFLayerGroupMBS, layer as UInt32, Title as string) as DynaPDFLayerGroupMBS
Function:
Adds a layer to the display tree.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 12.4 | Yes | Yes | Yes | Yes | No |
See also AddLayerToDisplTree function in DynaPDF manual.
DynaPDFMBS.AddMaskImage(BaseImage as Integer, Buffer as MemoryBlock, Stride as UInt32, BitsPerPixel as UInt32, Width as UInt32, Height as UInt32) as boolean
Function:
The function adds an image mask to a base image.
Notes:
Please note that this function can be called with Ptr or Memoryblock.
See also AddMaskImage function in dynapdf_help.pdf manual.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 13.3 | Yes | Yes | Yes | Yes | No |
Notes:
Please note that this function can be called with Ptr or Memoryblock.
See also AddMaskImage function in dynapdf_help.pdf manual.
See also:
See also AddMaskImage function in DynaPDF manual.
The items on this page are in the following plugins: MBS DynaPDF Plugin.
Links
MBS Xojo Plugins
