Platforms to show: All Mac Windows Linux Cross-Platform
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
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 | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 13.3 | Yes | Yes | Yes | Yes | All |
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.
DynaPDFMBS.AddObjectToLayer(OCG as UInt32, ObjType as Integer, Handle as Integer) as boolean
Function:
The function adds an object to an Optional Content Group (OCG) or Optional Content Membership dictionary (OCMD).
Notes:
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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 10.5 | Yes | Yes | Yes | Yes | All |
Notes:
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.
See also AddObjectToLayer function in DynaPDF manual.
DynaPDFMBS.AddOCGToAppEvent(Handle as UInt32, Events as Integer, Categories as Integer) as Boolean
Function:
Adds an Optional Content Group (OCG) to an application event.
Notes: See dynapdf_help.pdf manual for details.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 15.0 | Yes | Yes | Yes | Yes | All |
Notes: See dynapdf_help.pdf manual for details.
See also AddOCGToAppEvent function in DynaPDF manual.
DynaPDFMBS.AddOutputIntent(ICCFile as folderitem) as Integer
Function:
This function adds an ICC color profile to the PDF file that should be used to render device dependent colors.
Notes:
This function was named AddRenderingIntent before.
Requires DynaPDF Lite license.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
Notes:
This function was named AddRenderingIntent before.
Requires DynaPDF Lite license.
See also AddOutputIntent function in DynaPDF manual.
DynaPDFMBS.AddOutputIntentEx(buffer as Memoryblock) as Integer
Function:
This function adds an ICC color profile to the PDF file that should be used to render device dependent colors.
Notes:
This function was named AddRenderingIntentEx before.
Requires DynaPDF Lite license.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 13.0 | Yes | Yes | Yes | Yes | All |
Notes:
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
Function:
This function adds an ICC color profile to the PDF file that should be used to render device dependent colors.
Notes:
This function was named AddRenderingIntentEx before.
Requires DynaPDF Lite license.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 10.4 | Yes | Yes | Yes | Yes | All |
Notes:
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
Function:
The function creates a page label object.
Notes: The Value string is converted to Unicode internally.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 10.1 | Yes | Yes | Yes | Yes | All |
Notes: 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
Function:
The function creates a page label object.
| 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 Non ANSI function. instead.
Notes:
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
Function:
This function adds a value to a choice field.
Notes: The Value string is converted to Unicode.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
Notes: The Value string is converted to Unicode.
See also AddValToChoiceField function in DynaPDF manual.
DynaPDFMBS.Append as Boolean
Function:
This function appends an empty page to the document.
Example:
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
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.ApplyAppEvent(TOCAppEvent as Integer, SaveResult as Boolean) as boolean
Function:
The visibility state of optional content groups (OCGs) can be dynamically changed in application events like Export, View, or Print.
Notes:
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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 16.0 | Yes | Yes | Yes | Yes | All |
Notes:
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
Function:
This function sets a tiling pattern as current fill, stroke or fill, and stroke color.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also ApplyPattern function in DynaPDF manual.
DynaPDFMBS.ApplyShading(ShadHandle as Integer) as boolean
Function:
This function applies a shading to the current clipping path, or if no clipping is active, to the entire page.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also ApplyShading function in DynaPDF manual.
DynaPDFMBS.AssociateEmbFile(DestObject as Integer, DestHandle as Integer, Relationship as Integer, EmbFile as UInt32) as boolean
Function:
The function associates an embedded file with a PDF object.
Notes:
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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 13.5 | Yes | Yes | Yes | Yes | All |
Notes:
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.
See also AssociateEmbFile function in DynaPDF manual.
DynaPDFMBS.AttachFile(File as folderitem, Description as string, Compress as boolean) as Integer
Function:
The function attaches a file to the document.
Notes: On Windows, the description parameter is converted to unicode.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
Notes: On Windows, the description parameter is converted to unicode.
See also AttachFile function in DynaPDF manual.
DynaPDFMBS.AttachFileEx(Buffer as Memoryblock, Filename as string, Description as string, Compress as boolean) as Integer
Function:
The function attaches a file to the document in the same way as AttachFile() but accepts a file buffer instead of a file path.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 13.0 | Yes | Yes | Yes | Yes | All |
See also:
See also AttachFileEx function in DynaPDF manual.
DynaPDFMBS.AttachFileEx(Buffer as string, Filename as string, Description as string, Compress as boolean) as Integer
Function:
The function attaches a file to the document in the same way as AttachFile() but accepts a file buffer instead of a file path.
Example:
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
Example:
dim pdf as DynaPDFMBS // your dynapdf object
// add embedded file to PDF
const Compressed = true
call pdf.AttachFileEx("This is hidden text in an attached file.", "attachment.txt", "", Compressed)
See also:
See also AttachFileEx function in DynaPDF manual.
DynaPDFMBS.AutoTemplate(Templ as Integer, PosX as Double, PosY as Double, Width as Double, Height as Double) as boolean
Function:
To insert a template automatically on newly created pages, use the function AutoTemplate().
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also AutoTemplate function in DynaPDF manual.
DynaPDFMBS.BeginContinueText(PosX as Double, PosY as Double) as boolean
Function:
This function prepares the output of multiple text lines which use the graphics state parameter Leading as line height, or the font size if Leading is not set.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also BeginContinueText function in DynaPDF manual.
DynaPDFMBS.BeginLayer(OCG as UInt32) as boolean
Function:
The function opens a layer in the current open page or template.
Notes:
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 | 10.5 | Yes | Yes | Yes | Yes | All |
Notes:
If the function succeeds the return value is true. If the function fails the return value is false.
See also BeginLayer function in DynaPDF manual.
DynaPDFMBS.BeginPageTemplate(Name as String, UseAutoTemplates as boolean) as boolean
Function:
Creates a new page template with given name.
Notes:
This function creates or opens a page template for editing. Page templates are hidden pages which can be added to the document or overlaid on existing pages via JavaScript.
The usage of the function is like Append() or EditPage(). If the template does already exist then it will be opened for editing. Page templates support form fields and annotations but it is not allowed to add article beads to them.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 12.4 | Yes | Yes | Yes | Yes | All |
Notes:
This function creates or opens a page template for editing. Page templates are hidden pages which can be added to the document or overlaid on existing pages via JavaScript.
The usage of the function is like Append() or EditPage(). If the template does already exist then it will be opened for editing. Page templates support form fields and annotations but it is not allowed to add article beads to them.
See also BeginPageTemplate function in DynaPDF manual.
DynaPDFMBS.BeginPattern(PatternType as Integer, TilingType as Integer, Width as Double, Height as Double) as Integer
Function:
This function creates a new tiling pattern.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also BeginPattern function in DynaPDF manual.
DynaPDFMBS.BeginTemplate(Width as Double, Height as Double) as Integer
Function:
Begins a new template
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also BeginTemplate function in DynaPDF manual.
DynaPDFMBS.BeginTemplateEx(BBox as DynaPDFRectMBS, Matrix as DynaPDFMatrixMBS) as Integer
Function:
Begins a new template
Notes: The plugin passes nil to the library for the bbox or the matrix parameter if they are nil.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
Notes: The plugin passes nil to the library for the bbox or the matrix parameter if they are nil.
DynaPDFMBS.BeginTransparencyGroup(x1 as Double, y1 as Double, x2 as Double, y2 as Double, Isolated as Boolean, Knockout as Boolean, CS as Integer, CSHandle as Int32) as Int32
Function:
Begins a new transparency group.
Notes:
CS: color space, pass kes* constants.
Requires DynaPDF Pro license.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 11.3 | Yes | Yes | Yes | Yes | All |
Notes:
CS: color space, pass kes* constants.
Requires DynaPDF Pro license.
See also BeginTransparencyGroup function in DynaPDF manual.
DynaPDFMBS.Bezier_1_2_3(x1 as Double, y1 as Double, x2 as Double, y2 as Double, x3 as Double, y3 as Double) as boolean
Function:
Adds a bezier path to the pdf.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also Bezier_1_2_3 function in DynaPDF manual.
DynaPDFMBS.Bezier_1_3(x1 as Double, y1 as Double, x3 as Double, y3 as Double) as boolean
Function:
Adds a bezier path to the pdf.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also Bezier_1_3 function in DynaPDF manual.
DynaPDFMBS.Bezier_2_3(x2 as Double, y2 as Double, x3 as Double, y3 as Double) as boolean
Function:
Adds a bezier path to the pdf.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also Bezier_2_3 function in DynaPDF manual.
DynaPDFMBS.CalcWidthHeight(OrgWidth as Double, OrgHeight as Double, ScaledWidth as Double, ScaledHeight as Double) as Double
Function:
This function calculates the scaled width or height of a given size in the same way as InsertImage() or PlaceTemplate().
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also CalcWidthHeight function in DynaPDF manual.
DynaPDFMBS.CaretAnnot(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 | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 15.3 | Yes | Yes | Yes | Yes | All |
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.
The items on this page are in the following plugins: MBS DynaPDF Plugin.
Links
MBS Xojo PDF Plugins
