Xojo Conferences
XDCMay2019MiamiUSA

Platforms to show: All Mac Windows Linux Cross-Platform

Previous items Next items

DynaPDFMBS.GetXFAStreamCount as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 16.5 Yes Yes Yes Yes No
Function: Returns the number of available XFA streams.
Notes:
XFA streams are available after a PDF file was imported.
If the function succeeds the return value is the number of available XFA streams. If the function fails the return value is a negative error code.

See also GetXFAStreamCount function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.HaveOpenDoc as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: If an error occurred it is not always clear whether the PDF file was already deleted or if it is still in memory.

See also HaveOpenDoc function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.HaveOpenPage as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 11.1 Yes Yes Yes Yes No
Function: Whether a page is open.

See also HaveOpenPage function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.HighlightAnnot(SubType as Integer, PosX as Double, PosY as Double, Width as Double, Height as Double, ColorValue as Integer, Author as string, Subject as string, Comment as string) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.7 Yes Yes Yes Yes No
Function: Adds a highlight annotation with unicode text.

See also HighlightAnnot function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.HighlightAnnotAnsi(SubType as Integer, PosX as Double, PosY as Double, Width as Double, Height as Double, ColorValue as Integer, Author as string, Subject as string, Comment as string) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.7 Yes Yes Yes Yes No
Function: Adds a highlight annotation with ANSI text.

See also HighlightAnnot function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.HighlightOnAllPages(SearchText as string, ColorValue as Color, CaseInsenitive as boolean = false) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 14.0 Yes Yes Yes Yes No
Function: Highlights text on all pages of the current document.
Notes:
If CaseInsenitive is true, the case of letters is ignored (also umlauts and accents)
Searches on all pages in the document.
Returns number of times the text was found.

Feedback, Comments & Corrections

DynaPDFMBS.HighlightOnCurrentPage(SearchText as string, ColorValue as Color, CaseInsenitive as boolean = false) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 14.0 Yes Yes Yes Yes No
Function: Highlights text on all pages of the current page.
Notes:
If CaseInsenitive is true, the case of letters is ignored (also umlauts and accents)
Use EditPage function to open the page before you search on it.
Returns number of times the text was found.

Feedback, Comments & Corrections

DynaPDFMBS.ImportBookmarks as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: This function imports the outline tree of the currently opened import file (see OpenImportFile() or OpenImportBuffer()).

See also ImportBookmarks function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.ImportCatalogObjects as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function imports global objects of the currently opened import file such as bookmarks, JavaScripts, embedded files, open actions, invisible page templates, rendering intents, the document info entries, and certain other global properties such as the page mode or page layout.

See also ImportCatalogObjects function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.ImportDocInfo as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function imports the document info entries from the currently opened import file.

See also ImportDocInfo function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.ImportEncryptionSettings as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 17.0 Yes Yes Yes Yes No
Function: Imports the encryption settings from the currently open import file (see OpenImportFile() or OpenImportBuffer() for further information).
Notes:
If the PDF file is not encrypted, the function does nothing. To determine whether the open PDF file is encrypted call GetInIsEncrypted().
The encryption settings should be imported to make sure that the PDF file can be saved with the same settings after it was edited. The user rights should be considered if the file was opened with the open password, also if the password was just an empty string. See GetUserRights() for further information.
If the file was opened with the owner password, then all editing rights should be grated. The PDF file must be closed with CloseFile() or CloseAndSignFile() for example. Don't use
CloseFileEx() for example since this function would override the encryption settings.
If the file should be saved unencrypted call ResetEncryptionSettings() before closing the file. Return values:
If the function succeeds the return value is true. If the function fails the return value is false.

See also ImportEncryptionSettings function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.ImportOCProperties as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 17.5 Yes Yes Yes Yes No
Function: Imports the global Optional Content Properties of the curent open import file.
Notes:
OC properties are normally automatically imported by functions like ImportPDFFile() or when importing a page that contains layers. However, a viewer application must be able to access the OC properties right after the PDF file was opened so that the layer configuration and the layer tree can be loaded (see LoadLayerConfig() and GetOCUINode() for further information).
The function can be called multiple times without causing unwanted side effects.

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

See also ImportOCProperties function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.ImportPage(PageNum as Integer) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function imports a page of an external PDF file and converts this page to a template.
Notes: Requires DynaPDF Pro license.

See also ImportPage function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.ImportPageEx(PageNum as Integer, ScaleX as Double = 1.0, ScaleY as Double = 1.0) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function imports a PDF page of an external PDF file incl. interactive objects such as annotations, form fields and so on, if any.
Notes: Requires DynaPDF Pro license.

See also ImportPageEx function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.ImportPDFFile(DestPage as Integer, ScaleX as Double = 1.0, ScaleY as Double = 1.0) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function imports an external PDF file incl. interactive objects such as annotations, bookmarks, form fields and so on.
Notes:
Scaling factor is ignored if importing as pages (not templates).

This function returns the page number of the last page imported. It does not return how many pages are imported. If you need number of imported pages, please use returned value minus DestPage.

See also ImportPDFFile function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.ImportPDFPage(PageNum as Integer, ScaleX as Double = 1.0, ScaleY as Double = 1.0) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 15.1 Yes Yes Yes Yes No
Function: Imports a PDF page.
Notes:
If a page is open, this function calls EndPage.
Than it appends a new page, calls ImportPageEx and Endpage.

On success the return value is zero. If the function fails the return value is a negative error code.

Feedback, Comments & Corrections

DynaPDFMBS.InitColorManagement(profiles as DynaPDFColorProfilesMBS, DestSpace as Integer, Flags as Integer) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 11.3 Yes Yes Yes Yes No
Function: Initializes color management with the given default profiles.
Notes:
Pass nil for profiles to disable color management.
DestSpace can be kcsDeviceRGB, kcsDeviceCMYK or kcsDeviceGray.
Flags can be kicmDefault or kicmBPCompensation for:
Black point compensation preserves the black point when converting CMYK colors to different color spaces.

See also InitColorManagement function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.InitColorManagementEx(profiles as DynaPDFColorProfilesExMBS, DestSpace as Integer, Flags as Integer) 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: Initialize color management.
Notes:
The function enables color management in the functions RenderPage(), RenderPageEx(), RenderPageToImage(), and RenderPDFFile() exactly like InitColorManagement() but accepts ICC profile buffers instead of file paths. See InitColorManagement() for further information.

To disable color management set the parameter Profiles to nil.

Initializing the color management requires a considerable amount of processing time. It is strongly recommended to use one PDF instance as long as possible so that it must not be initialized again when another PDF file will be rendered.
The color management can be initialized right after the PDF instance was created.

Returns true on succes or false on failure.

See also InitColorManagementEx function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.InitStack(byref stack as DynaPDFStackMBS) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.7 Yes Yes Yes Yes No
Function: The function initializes the variable Stack with default values and prepares the editing of a content stream.
Example:
dim s as DynaPDFStackMBS
dim pdf as DynaPDFMBS // get your DynaPDF object

call pdf.InitStack(s)
Notes:
If stack is nil, a new one will be created and stored in the variable.

Return values:
If the function succeeds the return value is true. If the function fails the return value is false.

See also InitStack function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.InkAnnot(points() as DynaPDFPointMBS, LineWidth 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 an Ink annotation.
Notes:
An ink annotation (PDF 1.3) represents a freehand "scribble" composed of one or more disjoint paths. The parameter Points represents a stroked path. More paths can be added with AddInkList.
The points are interpreted in currect user space. Any transformation that was applied on the coordinate system will be taken into account.
The points are connected with bezier curves to achieve a smooth transition between points. If the points should be connected with straight lines, then create a PolyLine annotation instead (see PolyLineAnnot).
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 InkAnnot function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.InkAnnotAnsi(points() as DynaPDFPointMBS, LineWidth 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 an Ink annotation.
Notes:
An ink annotation (PDF 1.3) represents a freehand "scribble" composed of one or more disjoint paths. The parameter Points represents a stroked path. More paths can be added with AddInkList.
The points are interpreted in currect user space. Any transformation that was applied on the coordinate system will be taken into account.
The points are connected with bezier curves to achieve a smooth transition between points. If the points should be connected with straight lines, then create a PolyLine annotation instead (see PolyLineAnnot).
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 InkAnnot function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.InsertBMPFromBuffer(PosX as Double, PosY as Double, ScaleWidth as Double, ScaleHeight as Double, 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: The function inserts a Device Independent Bitmap from a file buffer.
This item is deprecated and should no longer be used. You can use InsertImageFromBuffer instead.

See also:

Feedback, Comments & Corrections

DynaPDFMBS.InsertBMPFromBuffer(PosX as Double, PosY as Double, ScaleWidth as Double, ScaleHeight as Double, Buffer as string) 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 inserts a Device Independent Bitmap from a file buffer.
This item is deprecated and should no longer be used. You can use InsertImageFromBuffer instead.

See also:

Feedback, Comments & Corrections

DynaPDFMBS.InsertBMPFromBuffer(PosX as Double, PosY as Double, ScaleWidth as Double, ScaleHeight as Double, BufferAddress as Integer) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function inserts a Device Independent Bitmap from a file buffer.
This item is deprecated and should no longer be used. You can use InsertImageFromBuffer instead.

See also:

Feedback, Comments & Corrections

DynaPDFMBS.InsertBMPFromHandle(PosX as Double, PosY as Double, ScaleWidth as Double, ScaleHeight as Double, hBitmap as Integer) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: This function inserts a bitmap in the same way as InsertImage() but accepts a HBITMAP handle as input.

See also InsertBMPFromHandle function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.InsertBookmark(title as String, parent as Integer, DestPage as Integer, Open as boolean, AddChildren as boolean) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 11.2 Yes Yes Yes Yes No
Function: This function inserts a bookmark to the global outline tree of the document.
Notes: The title parameter is converted to unicode.

See also InsertBookmark function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.InsertBookmarkAnsi(title as String, parent as Integer, DestPage as Integer, Open as boolean, AddChildren as boolean) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 11.2 Yes Yes Yes Yes No
Function: This function inserts a bookmark to the global outline tree of the document.
Notes: The title parameter is converted to ANSI.

See also InsertBookmark function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.InsertBookmarkEx(title as String, parent as Integer, NamedDest as Integer, Open as boolean, AddChildren as boolean) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 11.2 Yes Yes Yes Yes No
Function: This function inserts a bookmark to the global outline tree of the document.
Notes: The title parameter is converted to unicode.

See also InsertBookmarkEx function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.InsertBookmarkExAnsi(title as String, parent as Integer, NamedDest as Integer, Open as boolean, AddChildren as boolean) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 11.2 Yes Yes Yes Yes No
Function: This function inserts a bookmark to the global outline tree of the document.
Notes: The title parameter is converted to ANSI.

See also InsertBookmarkEx function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.InsertImage(PosX as Double, PosY as Double, ScaleWidth as Double, ScaleHeight as Double, File as folderitem) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function inserts an image from a file.
Example:
dim pdf as DynaPDFMBS

// ... add page

// use transparency from image
call pdf.SetUseTransparency(False)

// max 300 dpi for recompressed images
call pdf.SetResolution(300)

// use JPEG when compressing new pictures
call pdf.SetCompressionFilter(pdf.kcfJPEG)

// pass through JPEGs if possible
call pdf.SetSaveNewImageFormat(false)

// insert image
dim source as FolderItem = SpecialFolder.Desktop.Child("test.jpg")
call pdf.InsertImage(0, 0, 300, 200, source)
This item is deprecated and should no longer be used. You can use InsertImage instead.
Notes:
Please call SetUseTransparency(false) before inserting image if you don't like one of the colors (default white) to become transparent.

DynaPDF 3.0 adds support for pictures with alpha channel for this function.

Feedback, Comments & Corrections

Previous items Next items

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




Links
MBS Xojo tutorial videos