Platforms to show: All Mac Windows Linux Cross-Platform

Back to DynaPDFMBS class.

Next items

DynaPDFMBS.ActivateAltFontList(FontListHandle as Integer, EnableSysFonts as Boolean) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 22.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Activates or deactivates an alternate font list that was created by CreateAltFontList().

An alternate font list represents a list of fallback fonts which are tested if one or more required glyphs were not found in the current font.
If no compatible font was found in the list, then system fonts are tested if EnableSysFonts was set to true. Although EnableSysFonts should be set to true in most cases, it is sometimes useful to disable system fonts, e.g. to restrict the number of fonts which can be embeded.
In order to disable the current alternate font list set the parameter Handle to -1. The value of EnableSysFonts is ignored this case. To fully deactivate font substitution disable system fonts with SetUseSystemFonts() before calling a text function.
Please note that alternate font lists are used only, if complex text layout was enabled. This can be done by setting the flag kgfComplexText with SetGStateFlags().

Some examples using this method:

See also ActivateAltFontList function in DynaPDF manual.

DynaPDFMBS.AddAnnotToPage(PageNum as UInt32, Handle as UInt32) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 17.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Adds an annotation to a page.

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.

Some examples using this method:

See also AddAnnotToPage function in DynaPDF manual.

DynaPDFMBS.AddArticle(PosX as Double, PosY as Double, Width as Double, Height as Double) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This function creates a new article and adds it to the currently open article thread that must be created with CreateArticleThread() beforehand.

See also AddArticle function in DynaPDF manual.

DynaPDFMBS.AddBookmark(title as String, parent as Integer, DestPage as Integer, Open as boolean) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This function adds a bookmark to the global outline tree of the document.

The title parameter is converted to unicode.

Some examples using this method:

See also AddBookmark function in DynaPDF manual.

DynaPDFMBS.AddBookmarkAnsi(title as String, parent as Integer, DestPage as Integer, Open as boolean) as Integer   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This item is deprecated and should no longer be used. You can use the non ANSI function instead.
This function adds a bookmark to the global outline tree of the document.

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

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This function adds a bookmark to the global outline tree of the document.

The title parameter is converted to unicode.

Some examples using this method:

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

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 12.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This function adds a bookmark to the global outline tree of the document.

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   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 12.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This item is deprecated and should no longer be used. You can use the non ANSI function instead.
This function adds a bookmark to the global outline tree of the document.

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   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This item is deprecated and should no longer be used. You can use the non ANSI function instead.
This function adds a bookmark to the global outline tree of the document.

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

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function adds an image to a push button to one or more of the three different states of a button.

See also AddButtonImage function in DynaPDF manual.

DynaPDFMBS.AddButtonImageEx(BtnHandle as Integer, State as Integer, Caption as string, hbitmap as Integer) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function adds a memory bitmap to a push button in the same ways as AddButtonImage() but accepts a HBITMAP handle as input image.

See also AddButtonImageEx function in DynaPDF manual.

DynaPDFMBS.AddButtonImageEx2(BtnHandle as integer, State as integer, Caption as string, ImageData as MemoryBlock) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 21.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Adds image to a button.

The function adds an image to a push button in the same way as AddButtonImage(), but accepts an image buffer as input.
The function supports all image formats that InsertImageEx() supports, e.g. JPEG or PNG.

If the function succeeds the return value is true. If the function fails the return value is false.

See also:

See also AddButtonImageEx2 function in DynaPDF manual.

DynaPDFMBS.AddButtonImageEx2(BtnHandle as integer, State as integer, Caption as string, ImageData as String) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 21.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Adds image to a button.

The function adds an image to a push button in the same way as AddButtonImage(), but accepts an image buffer as input.
The function supports all image formats that InsertImageEx() supports, e.g. JPEG or PNG.

If the function succeeds the return value is true. If the function fails the return value is false.

See also:

See also AddButtonImageEx2 function in DynaPDF manual.

DynaPDFMBS.AddContinueText(text as string) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This function prints a single text line and adds a line feed.

The text string is converted to Unicode.

Some examples using this method:

See also AddContinueText function in DynaPDF manual.

DynaPDFMBS.AddContinueTextAnsi(text as string) as boolean   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This item is deprecated and should no longer be used. You can use the non ANSI function instead.
This function prints a single text line and adds a line feed.

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

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Adds DeviceN process colorants.

Returns true on success and false on failure.

Some examples using this method:

See also AddDeviceNProcessColorants function in DynaPDF manual.

DynaPDFMBS.AddDeviceNSeparations(DeviceNCS as Integer, Colorants() as string, SeparationCS() as Integer) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Adds device N seperations.

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.

Some examples using this method:

See also AddDeviceNSeparations function in DynaPDF manual.

DynaPDFMBS.AddDeviceNSeparationsAnsi(DeviceNCS as Integer, Colorants() as string, SeparationCS() as Integer) as boolean   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 10.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This item is deprecated and should no longer be used. You can use the non ANSI function instead.
Adds device N seperations.

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.AddDPartNode(Parent as Integer, FirstPage as Integer, LastPage as Integer, DPM as String) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 23.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Creates a DPart Node.

DPart nodes can be used to add metadata to a single page or range of pages. In addition, DPart nodes can be nested to form a tree like structure.

Unlike XMP metadata streams which base on XML, Document Part Metadata (parameter DPM) is stored in PDF syntax. This type of metadata supports dictionaries, arrays, strings, name objects, numbers, and boolean values, or almost the entire range of PDF data types.

DPart nodes require a global root node that must be created with CreateDPartRoot() before this function can be called the first time.

Some examples using this method:

See also AddDPartNode function in DynaPDF manual.

DynaPDFMBS.AddFieldToFormAction(Action as Integer, Field as Integer, Include as Boolean) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Adds a field to a form action.

Some examples using this method:

See also AddFieldToFormAction function in DynaPDF manual.

DynaPDFMBS.AddFieldToHideAction(HideAct as Integer, Field as Integer) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This function adds a field to a hide action.

See also AddFieldToHideAction function in DynaPDF manual.

DynaPDFMBS.AddFileComment(Text as string) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Adds one or more comments to the end of the PDF file.

The text parameter is converted to unicode.

See also AddFileComment function in DynaPDF manual.

DynaPDFMBS.AddFileCommentAnsi(Text as string) as boolean   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This item is deprecated and should no longer be used. You can use the non ANSI function instead.
Adds one or more comments to the end of the PDF file.

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

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 7.7 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This function adds a search path to the list of available font search paths.
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:

Some examples using this method:

See also AddFontSearchPath function in DynaPDF manual.

DynaPDFMBS.AddFontSearchPath(path as string, recursive as boolean = true) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 12.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This function adds a search path to the list of available font search paths.
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

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.6 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Adds an image to the current image file.

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

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 15.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Adds an array of points or path to an Ink Annotation.

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

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function adds a global JavaScript to the PDF file.

The script parameter is converted to unicode.

Some examples using this method:

See also AddJavaScript function in DynaPDF manual.

DynaPDFMBS.AddJavaScriptAnsi(Name as string, Script as string) as Integer   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This item is deprecated and should no longer be used. You can use the non ANSI function instead.
The function adds a global JavaScript to the PDF file.

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

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 12.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Adds a layer to the display tree.

See also AddLayerToDisplTree function in DynaPDF manual.

DynaPDFMBS.AddLayerToDisplTreeAnsi(parent as DynaPDFLayerGroupMBS, layer as UInt32, Title as string) as DynaPDFLayerGroupMBS   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 12.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This item is deprecated and should no longer be used. You can use the non ANSI function instead.
Adds a layer to the display tree.

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

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 13.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function adds an image mask to a base image.

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.

DynaPDFMBS.AddMaskImage(BaseImage as Integer, Buffer as Ptr, BufSize as UInt32, Stride as UInt32, BitsPerPixel as UInt32, Width as UInt32, Height as UInt32) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 13.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function adds an image mask to a base image.

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.

DynaPDFMBS.AddObjectToLayer(OCG as UInt32, ObjType as Integer, Handle as Integer) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 10.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function adds an object to an Optional Content Group (OCG) or Optional Content Membership dictionary (OCMD).

If the function succeeds the return value is true. If the function fails the return value is false.


For ObjectType use the constants: kooAnnotation, kooField, kooImage and kooTemplate.

Some examples using this method:

See also AddObjectToLayer function in DynaPDF manual.

DynaPDFMBS.AddOCGToAppEvent(Handle as UInt32, Events as Integer, Categories as Integer) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 15.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Adds an Optional Content Group (OCG) to an application event.

See dynapdf_help.pdf manual for details.

See also AddOCGToAppEvent function in DynaPDF manual.

DynaPDFMBS.AddOutputIntent(ICCFile as folderitem) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This function adds an ICC color profile to the PDF file that should be used to render device dependent colors.

This function was named AddRenderingIntent before.
Requires DynaPDF Lite license.

Some examples using this method:

See also AddOutputIntent function in DynaPDF manual.

DynaPDFMBS.AddOutputIntentEx(buffer as Memoryblock) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 13.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This function adds an ICC color profile to the PDF file that should be used to render device dependent colors.

This function was named AddRenderingIntentEx before.
Requires DynaPDF Lite license.

See also:

See also AddOutputIntentEx function in DynaPDF manual.

DynaPDFMBS.AddOutputIntentEx(buffer as string) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 10.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This function adds an ICC color profile to the PDF file that should be used to render device dependent colors.

This function was named AddRenderingIntentEx before.
Requires DynaPDF Lite license.

See also:

See also AddOutputIntentEx function in DynaPDF manual.

DynaPDFMBS.AddPageLabel(StartRange as UInt32, PageLabelFormat as Integer, Value as string, FirstPageNum as Int32) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 10.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function creates a page label object.

The Value string is converted to Unicode internally.

See also AddPageLabel function in DynaPDF manual.

DynaPDFMBS.AddPageLabelAnsi(StartRange as UInt32, PageLabelFormat as Integer, Value as string, FirstPageNum as Int32) as Integer   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 10.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This item is deprecated and should no longer be used. You can use the non ANSI function instead.
The function creates a page label object.

The Value string is converted to Windows ANSI internally.

See also AddPageLabel function in DynaPDF manual.

DynaPDFMBS.AddValToChoiceField(Field as Integer, ExpValue as string, Value as string, Selected as Boolean) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This function adds a value to a choice field.

The Value string is converted to Unicode.

Some examples using this method:

See also AddValToChoiceField function in DynaPDF manual.

DynaPDFMBS.Append as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This function appends an empty page to the document.
Example
dim pdf as DynaPDFMBS // your DynaPDF object
dim bBool as Boolean

// Create a new page
bBool=pdf.Append

See also Append function in DynaPDF manual.

DynaPDFMBS.AppendTraceFile(File as FolderItem) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 21.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Opens a trace file with appending.

The plugin writes debug messages to this file so you can check what functions you called.

Improved with 16.2 plugin to really cover over 99% of all calls with parameters and result. Please report if you miss something.

While assignment to TraceFile property or CreateTraceFile() always overwrites existing log file, this method can append to it.

DynaPDFMBS.ApplyAppEvent(TOCAppEvent as Integer, SaveResult as Boolean) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 16.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The visibility state of optional content groups (OCGs) can be dynamically changed in application events like Export, View, or Print.

DynaPDF loads the view state when rendering PDF pages by default.
The function can be used to apply the visibility state of another event if necessary. The result can optionally be stored in the PDF file but note that this has only an effect in PDF viewers which support layers but no application events since the events will not be deleted from the PDF file. It is also possible to delete the events with DeleteAppEvents().

If the function succeeds the return value is true. If the function fails the return value is false.

See also ApplyAppEvent function in DynaPDF manual.

DynaPDFMBS.ApplyPattern(PattHandle as Integer, ColorMode as Integer, ColorValue as Integer) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This function sets a tiling pattern as current fill, stroke or fill, and stroke color.

See also ApplyPattern function in DynaPDF manual.

DynaPDFMBS.ApplyShading(ShadHandle as Integer) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This function applies a shading to the current clipping path, or if no clipping is active, to the entire page.

Some examples using this method:

See also ApplyShading function in DynaPDF manual.

DynaPDFMBS.AssociateEmbFile(DestObject as Integer, DestHandle as Integer, Relationship as Integer, EmbFile as UInt32) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 13.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function associates an embedded file with a PDF object.

The parameter DestHandle must be a valid handle of a PDF object. If destination object type is a page, then the page number must be used as handle. The first page is denoted by one. If the destination object is the documents catalog then the parameter DestHandle is ignored. Set the parameter to zero or -1 in this case.
The parameter EmbFile must be a valid handle of an embedded file. See AttachFile() or AttachFileEx() for further information.

Associated files are supported since PDF 2.0 and in PDF/A 3 files. In PDF/A 3 files all embedded files must be associated with a PDF object.

If the function succeeds the return value is true. If the function fails the return value is false.

Some examples using this method:

See also AssociateEmbFile function in DynaPDF manual.

DynaPDFMBS.AttachFile(File as folderitem, Description as string, Compress as boolean) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function attaches a file to the document.

On Windows, the description parameter is converted to unicode.

Some examples using this method:

See also AttachFile function in DynaPDF manual.

Next items

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


The biggest plugin in space...