Xojo Conferences
MBSSep2018MunichDE
XDCMay2019MiamiUSA

Platforms to show: All Mac Windows Linux Cross-Platform

Previous items Next items

DynaPDFMBS.EndTemplate 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: This function closes an open template that was opened by BeginTemplate(), EditTemplate() or EditTemplate2().

See also EndTemplate function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.EnumDocFonts 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 enumerates all fonts used in the current PDF document.
Notes: Will call the EnumDocFont event.

See also EnumDocFonts function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.EnumDocFontsCount as Integer
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 enumerates all fonts used in the current PDF document and returns the count.
Notes: Returns the number of fonts found. Does not call the event.

Feedback, Comments & Corrections

DynaPDFMBS.EnumHostFonts 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 enumerates all fonts found in the search directories by passing the font names to a callback function.
This item is deprecated and should no longer be used. You can use GetSysFontInfos instead.
Notes: Calls the EnumHostFont event.

See also EnumHostFonts function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.EnumHostFontsCount as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.7 Yes Yes Yes Yes No
Function: This function enumerates all fonts found in the search directories.
This item is deprecated and should no longer be used. You can use GetSysFontInfos instead.
Notes: Returns the number of fonts found. Does not call the event.

Feedback, Comments & Corrections

DynaPDFMBS.EnumHostFontsEx 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 enumerates all fonts found in the search directories in the same way as EnumHostFonts().
This item is deprecated and should no longer be used. You can use GetSysFontInfos instead.
Notes: Calls the EnumHostFontEx event.

See also EnumHostFontsEx function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.EnumHostFontsExCount as Integer
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 enumerates all fonts found in the search directories in the same way as EnumHostFontsCount().
This item is deprecated and should no longer be used. You can use GetSysFontInfos instead.
Notes: Returns the number of fonts found. Does not call the event.

Feedback, Comments & Corrections

DynaPDFMBS.ExchangeBookmarks(Bmk1 as Integer, Bmk2 as Integer) 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: This function exchanges two bookmarks.

See also ExchangeBookmarks function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.ExchangePages(first as Integer, second as Integer) 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 exchanges two pages.

See also ExchangePages function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.ExtractPageText(RemoveText as boolean = false) as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 12.5 Yes Yes Yes Yes No
Function: Extracts text of current open page.
Notes:
This is a convenience function so you don't need to use DynaPDFStackMBS class yourself.
Returns the text of the page. Use EditPage() to open a page and than EndPage() to close it.

If you have problems with asian characters, please make sure you use SetCMapDir and load the CMAPs.
Requires DynaPDF Pro license.

Feedback, Comments & Corrections

DynaPDFMBS.ExtractPageTextRect(Left as Double, Top as Double, Right as Double, Bottom as Double, RemoveText as boolean = false) as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 16.2 Yes Yes Yes Yes No
Function: Extracts text of current open page within given rectangle.
Notes:
Text that starts within the given rectangle is captured.
Be aware that PDF coordinates start on bottom left of page with 0/0.

This is a convenience function so you don't need to use DynaPDFStackMBS class yourself.
Returns the text of the page. Use EditPage() to open a page and than EndPage() to close it.

If you have problems with asian characters, please make sure you use SetCMapDir and load the CMAPs.
Requires DynaPDF Pro license.

Feedback, Comments & Corrections

DynaPDFMBS.ExtractText(PageNum as Integer, Flags as Integer, rect as DynaPDFRectMBS = nil, byref text as string) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 18.0 Yes Yes Yes Yes No
Function: Extracts the text of the page PageNum.
Notes:
The first page is denoted by 1.

Text lines can be sorted in x- and y-direction. The flag ktefDeleteOverlappingText causes that identical text records which are placed on the same position (with a tolerance of 2 units) will be deleted. The records must occur one after the other in order to detect them.

The optional parameter Area can be set to restrict the text extraction to that rectangle. The rectangle must be defined according to the current coordinate system. That means either in bottom up or top down coordinates, see SetPageCoords() for further information. Note also that the function considers the orientation of the page. The width and height of the rectangle must be exchanged if the orientation is 90, -90, 270, or -270 degrees.

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

Feedback, Comments & Corrections

DynaPDFMBS.FileAttachAnnot(PosX as Double, PosY as Double, Icon as Integer, Author as string, Desc as string, File as folderitem, Compress as boolean) 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 file attachment annotation on the current open page.
Notes:
On Windows, the Desc and the Author parameters are converted to unicode.
Also check the dynapdf manual on the pdfFileAttachAnnotA function (pdfFileAttachAnnotW on Windows).

See also FileAttachAnnot function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.FileAttachAnnotEx(PosX as double, PosY as double, Icon as integer, Author as string, Desc as string, Filename as String, FileBuffer as MemoryBlock, Compress as boolean) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 18.0 Yes Yes Yes Yes No
Function: Creates a file attachment annotation exactly in the same way as FileAttachAnnot() but accepts a file buffer as input.
Notes:
See FileAttachAnnot() for further information. The parameter FileName is required. It should contain the file name including extension, e.g. "MyImage.jpg".

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:

Feedback, Comments & Corrections

DynaPDFMBS.FileAttachAnnotEx(PosX as double, PosY as double, Icon as integer, Author as string, Desc as string, Filename as String, FileBuffer as String, Compress as boolean) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 18.0 Yes Yes Yes Yes No
Function: Creates a file attachment annotation exactly in the same way as FileAttachAnnot() but accepts a file buffer as input.
Notes:
See FileAttachAnnot() for further information. The parameter FileName is required. It should contain the file name including extension, e.g. "MyImage.jpg".

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:

Feedback, Comments & Corrections

DynaPDFMBS.FileLink(PosX as Double, PosY as Double, Width as Double, Height as Double, FileLink as string) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 12.0 Yes Yes Yes Yes No
Function: The function creates a file link annotation.
Notes: Here you can pass a string which may be a relative file path like simply the file name of other pdf file in same folder.

See also FileLink function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.FileLinkAnsi(PosX as Double, PosY as Double, Width as Double, Height as Double, FileLink as string) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 12.0 Yes Yes Yes Yes No
Function: The function creates a file link annotation.
Notes: Here you can pass a string which may be a relative file path like simply the file name of other pdf file in same folder.

Feedback, Comments & Corrections

DynaPDFMBS.FindBookmark(DestPage as Integer, Text as string) 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 searches for a bookmark in the document outline tree.
Notes: The text parameter is converted to unicode.

See also FindBookmark function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.FindBookmarkAnsi(DestPage as Integer, Text as string) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.3 Yes Yes Yes Yes No
Function: This function searches for a bookmark in the document outline tree.
Notes: The text parameter is converted to ANSI.

Feedback, Comments & Corrections

DynaPDFMBS.FindEmbeddedFile(Name as string) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 16.3 Yes Yes Yes Yes No
Function: Searches for the embedded file Name and returns the handle of it when it can be found.
Notes:
The file can then be extracted with GetEmbeddedFile().

If the function succeeds the return value is an embedded file handle, a value greater or equal zero. If the file cannot be found the return value is -1.

See also FindEmbeddedFile function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.FindField(Name as string) 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 searches for an interactive form field by using the fully qualified field name.
Notes: The Name parameter is converted to unicode.

See also FindField function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.FindFieldAnsi(Name as string) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.3 Yes Yes Yes Yes No
Function: This function searches for an interactive form field by using the fully qualified field name.
Notes: The Name parameter is converted to ANSI.

Feedback, Comments & Corrections

DynaPDFMBS.FindLinkAnnot(URL as string) 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 searches for a file link or web link annotation.

See also FindLinkAnnot function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.FindNextBookmark 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 searches for the next bookmark with the same search parameters which were used by a previous call of FindBookmark().

See also FindNextBookmark function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.FinishSignature(PKCS7 as Memoryblock) as boolean
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 writes the PKCS#7 signature object to the PDF file and writes finally the finish PDF file to disk and frees all used resources if the file was not created in memory.
Notes:
If the file was created in memory GetBuffer() can now be called to obtain the finish PDF buffer.
CloseAndSignFileExt() must be called prior this function can be called.

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

See also:

See also FinishSignature function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.FinishSignature(PKCS7 as string) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 10.2 Yes Yes Yes Yes No
Function: The function writes the PKCS#7 signature object to the PDF file and writes finally the finish PDF file to disk and frees all used resources if the file was not created in memory.
Notes:
If the file was created in memory GetBuffer() can now be called to obtain the finish PDF buffer.
CloseAndSignFileExt() must be called prior this function can be called.

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

See also:

See also FinishSignature function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.FlattenAnnots(AnnotFlattenFlags as Integer = 0) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.6 Yes Yes Yes Yes No
Function: Flattens the annotations.
Notes:
By default all annotations which have an appearance stream and which have the print flag set are flattened.
All annotations are deleted when the function returns with the exception of file attachment annotations.
If you want to flatten the view state then set the flag affUseViewState.

Annotation flags:
kaffNone0Printable annotations independent of the type
kaffUseViewState1If set, annotations which are visible in a viewer become flattened.
kaffMarkupAnnots2If set, markup annotations are flattened only. Link, Sound, or FileAttach annotations are no markup annotations. These types will be left intact.

See also FlattenAnnots function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.FlattenForm 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 converts all fields of an Interactive Form to native PDF vector graphics and deletes the form after all fields are converted, incl. all JavaScript actions which are connected with form fields, pages, or the catalog object, and global JavaScript functions.
Notes: Requires DynaPDF Pro license.

See also FlattenForm function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.FlushPageContent(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 replaces the content stream of a page or template that was changed with the function ReplacePageText() or ReplacePageTextEx() beforehand.
Notes:
The function must be called after all changes are made. See GetPageText() for an example application.

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

See also FlushPageContent function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.FlushPages(Flags as Integer = 0) 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: Flushes pages.
Notes: Do not use FlushPages and SetUseSwapFile together. Use one function.

See also FlushPages 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 tutorial videos