Xojo Developer Conference
25/27th April 2018 in Denver.
MBS Xojo Conference
6/7th September 2018 in Munich, Germany.

Platforms to show: All Mac Windows Linux Cross-Platform

Previous items Next items

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 Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 13.3 Yes Yes Yes Yes No
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.

See also:

See also AddMaskImage function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.AddObjectToLayer(OCG as UInt32, ObjType as Integer, Handle as Integer) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 10.5 Yes Yes Yes Yes No
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.

Also check the dynapdf manual on the pdfAddObjectToLayer function.

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

See also AddObjectToLayer function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.AddOCGToAppEvent(Handle as UInt32, Events as Integer, Categories as Integer) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 15.0 Yes Yes Yes Yes No
Function: Adds an Optional Content Group (OCG) to an application event.
Notes: See dynapdf_help.pdf manual for details.

See also AddOCGToAppEvent function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.AddOutputIntent(ICCFile as folderitem) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: This function adds an ICC color profile to the PDF file that should be used to render device dependent colors.
Notes:
Also check the dynapdf manual on the pdfAddOutputIntentA function (pdfAddOutputIntentW on Windows).
This function was named AddRenderingIntent before.
Requires DynaPDF Lite license.

See also AddOutputIntent function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.AddOutputIntentEx(buffer as Memoryblock) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 13.0 Yes Yes Yes Yes No
Function: This function adds an ICC color profile to the PDF file that should be used to render device dependent colors.
Notes:
Also check the dynapdf manual on the pdfAddOutputIntentEx function.
This function was named AddRenderingIntentEx before.
Requires DynaPDF Lite license.

See also:

See also AddOutputIntentEx function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.AddOutputIntentEx(buffer as string) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 10.4 Yes Yes Yes Yes No
Function: This function adds an ICC color profile to the PDF file that should be used to render device dependent colors.
Notes:
Also check the dynapdf manual on the pdfAddOutputIntentEx function.
This function was named AddRenderingIntentEx before.
Requires DynaPDF Lite license.

See also:

See also AddOutputIntentEx function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.AddPageLabel(StartRange as UInt32, PageLabelFormat as Integer, Value as string, FirstPageNum as Int32) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 10.1 Yes Yes Yes Yes No
Function: The function creates a page label object.
Notes:
The Value string is converted to Unicode internally.
Also check the dynapdf manual on the pdfAddPageLabel function.

See also AddPageLabel function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.AddPageLabelAnsi(StartRange as UInt32, PageLabelFormat as Integer, Value as string, FirstPageNum as Int32) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 10.1 Yes Yes Yes Yes No
Function: The function creates a page label object.
Notes:
The Value string is converted to Windows ANSI internally.
Also check the dynapdf manual on the pdfAddPageLabel function.

Feedback, Comments & Corrections

DynaPDFMBS.AddValToChoiceField(Field as Integer, ExpValue as string, Value as string, Selected as Boolean) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: This function adds a value to a choice field.
Notes:
The Value string is converted to Unicode.
Also check the dynapdf manual on the pdfAddValToChoiceFieldW function.

See also AddValToChoiceField function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.Append as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: 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
Notes: Also check the dynapdf manual on the pdfAppend function.

See also Append function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.ApplyAppEvent(TOCAppEvent as Integer, SaveResult as Boolean) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 16.0 Yes Yes Yes Yes No
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.

Also check the dynapdf manual on the pdfApplyAppEvent function.

See also ApplyAppEvent function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.ApplyPattern(PattHandle as Integer, ColorMode as Integer, ColorValue as Integer) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: This function sets a tiling pattern as current fill, stroke or fill, and stroke color.
Notes: Also check the dynapdf manual on the pdfApplyPattern function.

See also ApplyPattern function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.ApplyShading(ShadHandle as Integer) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: This function applies a shading to the current clipping path, or if no clipping is active, to the entire page.
Notes: Also check the dynapdf manual on the pdfApplyShading function.

See also ApplyShading function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.AssociateEmbFile(DestObject as Integer, DestHandle as Integer, Relationship as Integer, EmbFile as UInt32) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 13.5 Yes Yes Yes Yes No
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.

See also AssociateEmbFile function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.AttachFile(File as folderitem, Description as string, Compress as boolean) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: The function attaches a file to the document.
Notes:
On Windows, the description parameter is converted to unicode.
Also check the dynapdf manual on the pdfAttachFileA function (pdfAttachFileW on Windows).

See also AttachFile function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.AttachFileEx(Buffer as Memoryblock, Filename as string, Description as string, Compress as boolean) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 13.0 Yes Yes Yes Yes No
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.
Notes: Also check the dynapdf manual on the pdfAttachFileA function (pdfAttachFileExW on Windows).

See also:

See also AttachFileEx function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.AttachFileEx(Buffer as string, Filename as string, Description as string, Compress as boolean) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
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:
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)
Notes: Also check the dynapdf manual on the pdfAttachFileA function (pdfAttachFileExW on Windows).

See also:

See also AttachFileEx function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.AutoTemplate(Templ as Integer, PosX as Double, PosY as Double, Width as Double, Height as Double) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: To insert a template automatically on newly created pages, use the function AutoTemplate().
Notes: Also check the dynapdf manual on the pdfAutoTemplate function.

See also AutoTemplate function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.BeginContinueText(PosX as Double, PosY as Double) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
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.
Notes: Also check the dynapdf manual on the pdfBeginContinueText function.

See also BeginContinueText function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.BeginLayer(OCG as UInt32) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 10.5 Yes Yes Yes Yes No
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.

Also check the dynapdf manual on the pdfBeginLayer function.

See also BeginLayer function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.BeginPageTemplate(Name as String, UseAutoTemplates as boolean) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 12.4 Yes Yes Yes Yes No
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.

See also BeginPageTemplate function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.BeginPattern(PatternType as Integer, TilingType as Integer, Width as Double, Height as Double) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: This function creates a new tiling pattern.
Notes: Also check the dynapdf manual on the pdfBeginPattern function.

See also BeginPattern function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.BeginTemplate(Width as Double, Height as Double) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: Begins a new template
Notes: Also check the dynapdf manual on the pdfBeginTemplate function.

See also BeginTemplate function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.BeginTemplateEx(BBox as DynaPDFRectMBS, Matrix as DynapdfMatrixMBS) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: Begins a new template
Notes:
The plugin passes nil to the library for the bbox or the matrix parameter if they are nil.
Also check the dynapdf manual on the pdfBeginTemplateEx function.

Feedback, Comments & Corrections

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
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 11.3 Yes Yes Yes Yes No
Function: Begins a new transparency group.
Notes:
CS: color space, pass kes* constants.

Also check the dynapdf manual on the pdfBeginTransparencyGroup function.
Requires DynaPDF Pro license.

See also BeginTransparencyGroup function in DynaPDF manual.

Feedback, Comments & Corrections

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
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: Adds a bezier path to the pdf.
Notes: Also check the dynapdf manual on the pdfBezier_1_2_3 function.

See also Bezier_1_2_3 function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.Bezier_1_3(x1 as Double, y1 as Double, x3 as Double, y3 as Double) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: Adds a bezier path to the pdf.
Notes: Also check the dynapdf manual on the pdfBezier_1_3 function.

See also Bezier_1_3 function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.Bezier_2_3(x2 as Double, y2 as Double, x3 as Double, y3 as Double) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: Adds a bezier path to the pdf.
Notes: Also check the dynapdf manual on the pdfBezier_2_3 function.

See also Bezier_2_3 function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.CalcWidthHeight(OrgWidth as Double, OrgHeight as Double, ScaledWidth as Double, ScaledHeight as Double) as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: This function calculates the scaled width or height of a given size in the same way as InsertImage() or PlaceTemplate().
Notes: Also check the dynapdf manual on the pdfCalcWidthHeight function.

See also CalcWidthHeight function in DynaPDF manual.

Feedback, Comments & Corrections

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
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 15.3 Yes Yes Yes Yes No
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.

See also CaretAnnot function in DynaPDF manual.

Feedback, Comments & Corrections

Previous items Next items

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




Links
MBS Xojo Plugins