Xojo Conferences
| MBS | Oct | 2019 | Cologne | DE |
Platforms to show: All Mac Windows Linux Cross-Platform
DynaPDFMBS.CaretAnnotAnsi(PosX as Double, PosY as Double, Width as Double, Height as Double, ColorValue as UInt32, ColorSpace as Integer, Author as string, Subject as string, Content as string) as Integer
Function:
Creates a caret annotation.
Notes:
This type of annotation is typically used to mark a position on a page where a user should add or edit text.
If the coordinate system is bottom-up the point PosX, PosY defines the lower left corner of the bounding rectangle. If the coordinate system is top-down it defines the upper left corner.
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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 15.3 | Yes | Yes | Yes | Yes | No |
Notes:
This type of annotation is typically used to mark a position on a page where a user should add or edit text.
If the coordinate system is bottom-up the point PosX, PosY defines the lower left corner of the bounding rectangle. If the coordinate system is top-down it defines the upper left corner.
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 CaretAnnot function in DynaPDF manual.
DynaPDFMBS.ChangeAnnotName(Handle as Integer, Name as string) as boolean
Function:
This function changes or deletes the optional name of an annotation.
Notes: The Name 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 Name parameter is converted to unicode.
See also ChangeAnnotName function in DynaPDF manual.
DynaPDFMBS.ChangeAnnotNameAnsi(Handle as Integer, Name as string) as boolean
Function:
This function changes or deletes the optional name of an annotation.
Notes: The Name 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 Name parameter is converted to ANSI.
See also ChangeAnnotName function in DynaPDF manual.
DynaPDFMBS.ChangeAnnotPos(Handle as Integer, PosX as Double, PosY as Double, Width as Double, Height as Double) as boolean
Function:
This function changes the position and size of an annotation.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | No |
See also ChangeAnnotPos function in DynaPDF manual.
DynaPDFMBS.ChangeBookmark(ABmk as Integer, Text as string, Parent as Integer, DestPage as Integer, Open as Boolean) as boolean
Function:
This function changes an existing bookmark.
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 ChangeBookmark function in DynaPDF manual.
DynaPDFMBS.ChangeBookmarkAnsi(ABmk as Integer, Text as string, Parent as Integer, DestPage as Integer, Open as Boolean) as boolean
Function:
This function changes an existing bookmark.
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 ChangeBookmark function in DynaPDF manual.
DynaPDFMBS.ChangeFont(Handle as Integer) as Boolean
Function:
This function changes or sets the font to the one defined by the parameter AHandle.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | No |
See also ChangeFont function in DynaPDF manual.
DynaPDFMBS.ChangeFontSize(size as Double) as Boolean
Function:
This function changes the font size of the current font.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | No |
See also ChangeFontSize function in DynaPDF manual.
DynaPDFMBS.ChangeFontStyle(Style as Integer) as Boolean
Function:
This function changes the style of the current font.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | No |
See also ChangeFontStyle function in DynaPDF manual.
DynaPDFMBS.ChangeFontStyleEx(Style as Integer) as Boolean
Function:
The function changes the font style of a font like ChangeFontStyle() but it accepts also the font styles fsBold and fsItalic.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | No |
See also ChangeFontStyleEx function in DynaPDF manual.
DynaPDFMBS.ChangeJavaScript(Handle as Integer, Text as string) as Boolean
Function:
The function replaces a global JavaScript with a new one.
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 ChangeJavaScript function in DynaPDF manual.
DynaPDFMBS.ChangeJavaScriptAction(Handle as Integer, Text as string) as Boolean
Function:
The function replaces the script of a JavaScript action with a new one.
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 ChangeJavaScriptAction function in DynaPDF manual.
DynaPDFMBS.ChangeJavaScriptActionAnsi(Handle as Integer, Text as string) as Boolean
Function:
The function replaces the script of a JavaScript action with a new one.
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 ChangeJavaScriptAction function in DynaPDF manual.
DynaPDFMBS.ChangeJavaScriptAnsi(Handle as Integer, Text as string) as Boolean
Function:
The function replaces a global JavaScript with a new one.
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 ChangeJavaScript function in DynaPDF manual.
DynaPDFMBS.ChangeJavaScriptName(Handle as Integer, Text as string) as Boolean
Function:
This function changes the name of a global JavaScript.
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 ChangeJavaScriptName function in DynaPDF manual.
DynaPDFMBS.ChangeJavaScriptNameAnsi(Handle as Integer, Text as string) as Boolean
Function:
This function changes the name of a global JavaScript.
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 ChangeJavaScriptName function in DynaPDF manual.
DynaPDFMBS.ChangeLinkAnnot(Handle as Integer, URL as string) as Boolean
Function:
This function changes the link of a file link or web link annotation.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | No |
See also ChangeLinkAnnot function in DynaPDF manual.
DynaPDFMBS.ChangeSeparationColor(CSHandle as UInt32, NewColor as UInt32, AlternateExtColorSpace as Integer, AltHandle as Integer = -1) as boolean
Function:
The function changes the color of a separation color space.
Example:
Notes:
The new color value must be defined in the alternate color space. The alternate color space can be any device or ICC based color space including Lab. If a non-device color space is used, the parameter AltHandle must be set to the color space handle of the alternate color space.
Returns true on success or false on failure.
CSHandle is the index in the colorspace table, not the reference to the C++ object. So do not pass handle property from DynaPDFColorSpaceMBS, but the Index property.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 13.4 | Yes | Yes | Yes | Yes | No |
Example:
// your instance
dim pdf as DynaPDFMBS
// Create new separation color
dim ColorSpaceHandle as Integer = pdf.CreateSeparationCS("test",DynaPDFMBS.kcsDeviceCMYK,-1,DynapdfMBS.CMYK(0,0,0,100))
call pdf.SetExtColorSpace(ColorSpaceHandle)
// draw something
call pdf.SetfillColor(255) // 100% of the separation color test
call pdf.DrawCircle(193,389,66, pdf.kfmFill)
// change it to red
call pdf.ChangeSeparationColor(ColorSpaceHandle, 255, DynaPDFMBS.kcsDeviceRGB, -1)
The new color value must be defined in the alternate color space. The alternate color space can be any device or ICC based color space including Lab. If a non-device color space is used, the parameter AltHandle must be set to the color space handle of the alternate color space.
Returns true on success or false on failure.
CSHandle is the index in the colorspace table, not the reference to the C++ object. So do not pass handle property from DynaPDFColorSpaceMBS, but the Index property.
See also ChangeSeparationColor function in DynaPDF manual.
DynaPDFMBS.CheckCollection as Boolean
Function:
The function checks whether user defined data fields in embedded files are consistently defined with
collection fields.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | No |
The function checks whether user defined data fields in embedded files are consistently defined with
collection fields.
See also CheckCollection function in DynaPDF manual.
DynaPDFMBS.CheckConformance(ConformanceType as Integer, CheckOptions as Integer) as Integer
Function:
The functions checks whether the PDF file is compatible to a specific PDF standard or PDF version depending the parameter Type and modifies anything that is required to get the file compatible to the standard depending on the check options.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | No |
See also CheckConformance function in DynaPDF manual.
DynaPDFMBS.CheckFieldNames as Integer
Function:
This function checks all currently defined interactive form fields for invalid duplicate field names.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | No |
See also CheckFieldNames function in DynaPDF manual.
DynaPDFMBS.CircleAnnot(PosX as Double, PosY as Double, Width as Double, Height as Double, LineWidth as Double, FillColor as UInt32, StrokeColor as UInt32, ColorSpace as Integer, Author as string, Subject as string, Comment as string) as Integer
Function:
The function draws a circle annotation on the current open page.
Notes:
If the parameters Width and Height are equal the function draws a circle, an ellipse otherwise. If the annotation should be drawn without a border, set the parameter LineWidth zo zero or StrokeColor to the special constant kNO_COLOR.
If the interior should be transparent set FillColor to the special constant kNO_COLOR.
Although the line width can be set to any positive floating point value, Adobe's Acrobat or Reader restrict the line width to 0 through 12 units. The line width should be restricted in the same way to avoid issues in Adobe viewer products.
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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 13.5 | Yes | Yes | Yes | Yes | No |
Notes:
If the parameters Width and Height are equal the function draws a circle, an ellipse otherwise. If the annotation should be drawn without a border, set the parameter LineWidth zo zero or StrokeColor to the special constant kNO_COLOR.
If the interior should be transparent set FillColor to the special constant kNO_COLOR.
Although the line width can be set to any positive floating point value, Adobe's Acrobat or Reader restrict the line width to 0 through 12 units. The line width should be restricted in the same way to avoid issues in Adobe viewer products.
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 CircleAnnot function in DynaPDF manual.
DynaPDFMBS.CircleAnnotAnsi(PosX as Double, PosY as Double, Width as Double, Height as Double, LineWidth as Double, FillColor as UInt32, StrokeColor as UInt32, ColorSpace as Integer, Author as string, Subject as string, Comment as string) as Integer
Function:
The function draws a circle annotation on the current open page.
Notes:
If the parameters Width and Height are equal the function draws a circle, an ellipse otherwise. If the annotation should be drawn without a border, set the parameter LineWidth zo zero or StrokeColor to the special constant kNO_COLOR.
If the interior should be transparent set FillColor to the special constant kNO_COLOR.
Although the line width can be set to any positive floating point value, Adobe's Acrobat or Reader restrict the line width to 0 through 12 units. The line width should be restricted in the same way to avoid issues in Adobe viewer products.
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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 13.5 | Yes | Yes | Yes | Yes | No |
Notes:
If the parameters Width and Height are equal the function draws a circle, an ellipse otherwise. If the annotation should be drawn without a border, set the parameter LineWidth zo zero or StrokeColor to the special constant kNO_COLOR.
If the interior should be transparent set FillColor to the special constant kNO_COLOR.
Although the line width can be set to any positive floating point value, Adobe's Acrobat or Reader restrict the line width to 0 through 12 units. The line width should be restricted in the same way to avoid issues in Adobe viewer products.
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 CircleAnnot function in DynaPDF manual.
DynaPDFMBS.ClearAutoTemplates as Boolean
Function:
This function deletes the array of templates which are automatically added to newly created pages.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | No |
See also ClearAutoTemplates function in DynaPDF manual.
DynaPDFMBS.ClearErrorLog
Function:
Clears the error log.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 11.2 | Yes | Yes | Yes | Yes | No |
See also ClearErrorLog function in DynaPDF manual.
DynaPDFMBS.ClearHostFonts as Boolean
Function:
This function deletes the array of fonts included in all currently defined font search paths.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | No |
See also ClearHostFonts function in DynaPDF manual.
DynaPDFMBS.ClearPageGraphics
Function:
Clears the page graphics objects.
Notes:
This method clears graphics object.
As the graphics object keeps a reference to DynaPDFMBS object and the DynaPDF object references the graphics object, this call may be required to make sure the circular reference is cleared.
Automatically called in Append, EndPage, CloseFile, ImportPDFFile, ImportPDFPage and CloseFileEx.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 19.2 | Yes | Yes | Yes | Yes | No |
Notes:
This method clears graphics object.
As the graphics object keeps a reference to DynaPDFMBS object and the DynaPDF object references the graphics object, this call may be required to make sure the circular reference is cleared.
Automatically called in Append, EndPage, CloseFile, ImportPDFFile, ImportPDFPage and CloseFileEx.
DynaPDFMBS.ClipPath(ClipMode as Integer, FillMode as Integer) as Boolean
Function:
This function marks the current path as clipping path.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | No |
See also ClipPath function in DynaPDF manual.
DynaPDFMBS.CloseAndSignFile(CertFile as folderitem, Password as string, Reason as string, Location as string) as Boolean
Function:
This function finishes the PDF file, digitally signs it, and frees all used resources if the file was not created in memory.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | No |
See also CloseAndSignFile function in DynaPDF manual.
DynaPDFMBS.CloseAndSignFileEx(OpenPwd as string, OwnerPwd as string, KeyLen as Integer, Restrict as Integer, CertFile as folderitem, Password as string, Reason as string, Location as string) as Boolean
Function:
This function finishes the PDF file, encrypts it, digitally signs it, and frees all used resources if the file was not created in memory.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | No |
See also CloseAndSignFileEx function in DynaPDF manual.
The items on this page are in the following plugins: MBS DynaPDF Plugin.
Links
MBS Xojo Plugins
