Platforms to show: All Mac Windows Linux Cross-Platform

Back to DynaPDFMBS class.

DynaPDFMBS.PageLink(PosX as Double, PosY as Double, Width as Double, Height as Double, DestPage as Integer) 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 inserts a page link onto the current open page.

Some examples using this method:

See also PageLink function in DynaPDF manual.

DynaPDFMBS.PageLink2(PosX as Double, PosY as Double, Width as Double, Height as Double, NamedDest as Integer) 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 inserts a page link onto the current open page by using a named destination as target.

Some examples using this method:

See also PageLink2 function in DynaPDF manual.

DynaPDFMBS.PageLink3(PosX as Double, PosY as Double, Width as Double, Height as Double, NamedDest as string) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 12.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function adds a page link to the current open page by using a named destination as target.

The difference in comparison to PageLink2() is that the named destination can be defined as string.
This makes it possible to create the link, also if you don't have the required information to create the named destination at this point. If the named destination does not exist when the file is closed then the link does nothing. See also, CreateNamedDest().

Return values:
If the function succeeds the return value is the annotation handle, a value greater or equal zero. If the function fails the return value is a negative error code.

See also PageLink3 function in DynaPDF manual.

DynaPDFMBS.PageLinkEx(PosX as Double, PosY as Double, Width as Double, Height as Double, DestType as Integer, DestPage as Integer, a as Double = 0.0, b as Double = 0.0, c as Double = 0.0, d as Double = 0.0) 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 inserts a page link onto the current open page.

See also PageLinkEx function in DynaPDF manual.

DynaPDFMBS.PageStatistic(page as Integer = -1) as DynaPDFPageStatisticMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 12.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Queries statistics from a page.

If page is -1 the current open page is used. Else the plugin uses editpage(page) to open the page and run the statistics on that.
Returns nil on any error or statistic value.

If a page is open, we automatically close it.

Some examples using this method:

DynaPDFMBS.ParseContent(ParseInterface as DynaPDFParseInterfaceMBS, flags as Integer) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.6 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Parses the content of a page.

Requires DynaPDF Pro license.

Some examples using this method:

See also ParseContent function in DynaPDF manual.

DynaPDFMBS.PlaceImage(ImgHandle as Integer, PosX as Double, PosY as Double, Width as Double, Height as Double) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Images can be used multiple times on different positions and with different sizes. This function places an image onto a page or template that was already inserted beforehand by an image function.

See also PlaceImage function in DynaPDF manual.

DynaPDFMBS.PlaceSigFieldValidateIcon(SigField as Integer, PosX as Double, PosY as Double, Width as Double, Height as Double) 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 places the validation icon in a signature field to the whished position.

Some examples using this method:

See also PlaceSigFieldValidateIcon function in DynaPDF manual.

DynaPDFMBS.PlaceTemplate(TmplHandle as Integer, PosX as Double, PosY as Double, Width as Double, Height as Double) 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 places a template onto a page, another open template, or pattern.

Some examples using this method:

See also PlaceTemplate function in DynaPDF manual.

DynaPDFMBS.PlaceTemplateEx(TmplHandle as Integer, PosX as Double, PosY as Double, ScaleWidth as Double, ScaleHeight as Double) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 10.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Places a template.

Some examples using this method:

See also PlaceTemplateEx function in DynaPDF manual.

DynaPDFMBS.PolygonAnnot(Vertices() as DynaPDFPointMBS, LineWidth as Double, FillColor as UInt32, StrokeColor as UInt32, ColorSpace as Integer, Author as string, Subject as string, Content as string) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 14.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function creates a Polygon Annotation.

The vertices are connected by straight lines. The path is always closed before it will be drawn. It is not required to close the path explicitly. At least two vertices must be provided.
The coordinates of the vertices are interpretet in current user space. Any transformation that was applied on the coordinate system will be taken into account.
The stroke or fill color can be set to the special constant kNO_COLOR to fill or stroke the polygon. It is not allowed to set both colors to kNO_COLOR since this would result in an invisible annotation.
This annotation type has an associated PopUp annotation that displays the string Content in a floating window. The initial window state of the associated PopUp annotation is closed by default but the state can be changed with SetAnnotOpenState if necessary.


If the function succeeds the return value is the annotation handle, a value greater or equal zero. If the function fails the return value is a negative error code.

Some examples using this method:

See also PolygonAnnot function in DynaPDF manual.

DynaPDFMBS.PolygonAnnotAnsi(Vertices() as DynaPDFPointMBS, LineWidth as Double, FillColor as UInt32, StrokeColor as UInt32, ColorSpace as Integer, Author as string, Subject as string, Content as string) as Integer   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 14.0 ✅ 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 Polygon Annotation.

The vertices are connected by straight lines. The path is always closed before it will be drawn. It is not required to close the path explicitly. At least two vertices must be provided.
The coordinates of the vertices are interpretet in current user space. Any transformation that was applied on the coordinate system will be taken into account.
The stroke or fill color can be set to the special constant kNO_COLOR to fill or stroke the polygon. It is not allowed to set both colors to kNO_COLOR since this would result in an invisible annotation.
This annotation type has an associated PopUp annotation that displays the string Content in a floating window. The initial window state of the associated PopUp annotation is closed by default but the state can be changed with SetAnnotOpenState if necessary.


If the function succeeds the return value is the annotation handle, a value greater or equal zero. If the function fails the return value is a negative error code.

See also PolygonAnnot function in DynaPDF manual.

DynaPDFMBS.PolyLineAnnot(Vertices() as DynaPDFPointMBS, LineWidth as Double, StartLineEndStyle as Integer, EndLineEndStyle as Integer, FillColor as UInt32, StrokeColor as UInt32, ColorSpace as Integer, Author as string, Subject as string, Content as string) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 14.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function creates a PolyLine Annotation.

The vertices are connected by straight lines. At least two vertices must be provided.
The coordinates of the vertices are interpretet in current user space. Any transformation that was applied on the coordinate system will be taken into account.
The parameter FillColor is only used if the line end style of the start or end point has an interior that can be filled. The special constant kNO_COLOR represents a transparent interior.
The stroke color is required and must not be set to kNO_COLOR.

This annotation type has an associated PopUp annotation that displays the string Content in a floating window. The initial window state of the associated PopUp annotation is closed by default but the state can be changed with SetAnnotOpenState if necessary.
The parameter LineWidth must be in the range 0 through 12 units. Values outside the valid range will be adjusted to the nearest allowed value. A zero line width produces a 1 pixel wide line.
The line end styles can be changed if necessary with SetAnnotLineEndStyle.

If the function succeeds the return value is the annotation handle, a value greater or equal zero. If the function fails the return value is a negative error code.

Some examples using this method:

See also PolyLineAnnot function in DynaPDF manual.

DynaPDFMBS.PolyLineAnnotAnsi(Vertices() as DynaPDFPointMBS, LineWidth as Double, StartLineEndStyle as Integer, EndLineEndStyle as Integer, FillColor as UInt32, StrokeColor as UInt32, ColorSpace as Integer, Author as string, Subject as string, Content as string) as Integer   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 14.0 ✅ 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 PolyLine Annotation.

The vertices are connected by straight lines. At least two vertices must be provided.
The coordinates of the vertices are interpretet in current user space. Any transformation that was applied on the coordinate system will be taken into account.
The parameter FillColor is only used if the line end style of the start or end point has an interior that can be filled. The special constant kNO_COLOR represents a transparent interior.
The stroke color is required and must not be set to kNO_COLOR.

This annotation type has an associated PopUp annotation that displays the string Content in a floating window. The initial window state of the associated PopUp annotation is closed by default but the state can be changed with SetAnnotOpenState if necessary.
The parameter LineWidth must be in the range 0 through 12 units. Values outside the valid range will be adjusted to the nearest allowed value. A zero line width produces a 1 pixel wide line.
The line end styles can be changed if necessary with SetAnnotLineEndStyle.

If the function succeeds the return value is the annotation handle, a value greater or equal zero. If the function fails the return value is a negative error code.

See also PolyLineAnnot function in DynaPDF manual.

DynaPDFMBS.PrintGetDevMode as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 17.2 ❌ No ✅ Yes ❌ No ❌ No All
Queries last print dev mode.

You can store this in a preferences file for next printing.
This is same data structure as in WindowsDeviceModeMBS class.

Some examples using this method:

DynaPDFMBS.PrintGetDevNames(byref Driver as String, byref Device as String, byref Output as String, byref DefaultFlag as Integer) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 17.2 ❌ No ✅ Yes ❌ No ❌ No All
Queries printer device names.

Driver: File name (without the extension) of the device driver.
Device: Name of the device.
Output: Device name for the physical output medium (output port).
DefaultFlag: 1 if the selected printer is the default one.

Returns true on success or false on failure.

DynaPDFMBS.PrintPDFFile(TempDir as FolderItem, DocName as string, DCHandle as integer, Flags as Integer = 0, Margin as DynaPDFRectMBS = nil, PrintParams as DynaPDFPrintParamsMBS = nil) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 15.1 ❌ No ✅ Yes ❌ No ❌ No All
Prints current PDF file.

Returns true on success and false on failure.
Flags can be a combination of the flag values kpffPrintAsImage, kpffDefault, kpffColor, kpffAutoRotateAndCenter and kpff1Bit.
Margin can be nil. If not nil, specifies the margins to use.
DCHandle is the handle of the graphics context.

If you only want to print a selection of pages, please only import those pages via ImportPDFPage function. Or use DeletePage to remove the pages you don't want to print.

Does not work with a graphics handle from Xojo 2016r4 and newer due to switch to DirectDraw APIs.
Or in other words, you can use a HDC handle from graphics class in Xojo 2016r3 and older to print PDF.

See also:

Some examples using this method:

See also PrintPDFFile function in DynaPDF manual.

DynaPDFMBS.PrintPDFFile(TempDir as FolderItem, DocName as string, PrinterName as String, Flags as Integer = 0, Margin as DynaPDFRectMBS = nil, PrintParams as DynaPDFPrintParamsMBS = nil) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 17.2 ❌ No ✅ Yes ❌ No ❌ No All
Prints current PDF file.

Returns true on success and false on failure.
Flags can be a combination of the flag values kpffPrintAsImage, kpffDefault, kpffColor, kpffAutoRotateAndCenter and kpff1Bit.
Margin can be nil. If not nil, specifies the margins to use.
PrinterName is the name of the printer to use. The plugin will open the printer and print PDF there with default settings.

If you only want to print a selection of pages, please only import those pages via ImportPDFPage function. Or use DeletePage to remove the pages you don't want to print.

See also:

See also PrintPDFFile function in DynaPDF manual.

DynaPDFMBS.PrintPDFFileWithDialog(TempDir as FolderItem, DocName as string, Flags as Integer = 0, Margin as DynaPDFRectMBS = nil, PrintParams as DynaPDFPrintParamsMBS = nil, parentWindow as Window = nil) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 17.2 ❌ No ✅ Yes ❌ No ❌ No Desktop only
Prints current PDF file with dialog.

Returns true on success and false on failure.
Flags can be a combination of the flag values kpffPrintAsImage, kpffDefault, kpffColor, kpffAutoRotateAndCenter and kpff1Bit.
Margin can be nil. If not nil, specifies the margins to use.
Shows print dialog and allows user to set printer.

If you only want to print a selection of pages, please only import those pages via ImportPDFPage function. Or use DeletePage to remove the pages you don't want to print.

After this call you can use PrintGetDevNames and PrintGetDevMode to get printer settings.
And before this call you can use PrintSetDevMode and PrintSetDevNames to restore printer settings.

See also:

Some examples using this method:

DynaPDFMBS.PrintPDFFileWithDialog(TempDir as FolderItem, DocName as string, Flags as Integer, Margin as DynaPDFRectMBS, PrintParams as DynaPDFPrintParamsMBS, parentWindow as DesktopWindow) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 22.0 ❌ No ✅ Yes ❌ No ❌ No Desktop only
Prints current PDF file with dialog.

Returns true on success and false on failure.
Flags can be a combination of the flag values kpffPrintAsImage, kpffDefault, kpffColor, kpffAutoRotateAndCenter and kpff1Bit.
Margin can be nil. If not nil, specifies the margins to use.
Shows print dialog and allows user to set printer.

If you only want to print a selection of pages, please only import those pages via ImportPDFPage function. Or use DeletePage to remove the pages you don't want to print.

After this call you can use PrintGetDevNames and PrintGetDevMode to get printer settings.
And before this call you can use PrintSetDevMode and PrintSetDevNames to restore printer settings.

See also:

DynaPDFMBS.PrintPDFPage(PageNumber as Integer, DocName as string, DCHandle as integer, Flags as Integer = 0, Margin as DynaPDFRectMBS = nil, PrintParams as DynaPDFPrintParamsMBS = nil) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 17.2 ❌ No ✅ Yes ❌ No ❌ No All
Prints a page.

See PrintPDFFile for details and options.

See also:

DynaPDFMBS.PrintPDFPage(PageNumber as Integer, DocName as string, PrinterName as String, Flags as Integer = 0, Margin as DynaPDFRectMBS = nil, PrintParams as DynaPDFPrintParamsMBS = nil) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 17.2 ❌ No ✅ Yes ❌ No ❌ No All
Prints a page.

See PrintPDFFile for details and options.

Version 18.4 and newer use device mode set with DynaPDFMBS.PrintSetDevMode method for printer settings.

See also:

DynaPDFMBS.PrintPDFPageWithDialog(PageNumber as Integer, DocName as string, Flags as Integer = 0, Margin as DynaPDFRectMBS = nil, PrintParams as DynaPDFPrintParamsMBS = nil, parentWindow as Window = nil) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 17.2 ❌ No ✅ Yes ❌ No ❌ No Desktop only
Prints a page with dialog.

See PrintPDFFileWithDialog for details and options.

See also:

Some examples using this method:

DynaPDFMBS.PrintPDFPageWithDialog(PageNumber as Integer, DocName as string, Flags as Integer, Margin as DynaPDFRectMBS, PrintParams as DynaPDFPrintParamsMBS, parentWindow as DesktopWindow) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 22.0 ❌ No ✅ Yes ❌ No ❌ No Desktop only
Prints a page with dialog.

See PrintPDFFileWithDialog for details and options.

See also:

DynaPDFMBS.PrintSetDevMode(data as MemoryBlock) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 18.5 ❌ No ✅ Yes ❌ No ❌ No All
Set last print dev mode.

Returns true on success.
This is same data structure as in WindowsDeviceModeMBS class.

See also DynaPDFPrintParamsMBS class for rendering parameters.

See also:

Some examples using this method:

DynaPDFMBS.PrintSetDevMode(data as String) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 17.2 ❌ No ✅ Yes ❌ No ❌ No All
Set last print dev mode.

Returns true on success.
This is same data structure as in WindowsDeviceModeMBS class.

See also DynaPDFPrintParamsMBS class for rendering parameters.

See also:

DynaPDFMBS.PrintSetDevNames(Driver as String, Device as String, Output as String, DefaultFlag as Integer) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 17.2 ❌ No ✅ Yes ❌ No ❌ No All
Sets printer device names.

Driver: File name (without the extension) of the device driver.
Device: Name of the device.
Output: Device name for the physical output medium (output port).
DefaultFlag: 1 if the selected printer is the default one.

Returns true on success or false on failure.

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


The biggest plugin in space...