Platforms to show: All Mac Windows Linux Cross-Platform
DynaPDFMBS.FindField(Name as string) as Integer
Function:
This function searches for an interactive form field by using the fully qualified field name.
Notes: The Name 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: The Name parameter is converted to unicode.
See also FindField function in DynaPDF manual.
DynaPDFMBS.FindFieldAnsi(Name as string) as Integer
Function:
This function searches for an interactive form field by using the fully qualified field name.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.3 | Yes | Yes | Yes | Yes | All |
This item is deprecated and should no longer be used.
You can use Non ANSI function. instead.
Notes:
The Name parameter is converted to ANSI.See also FindField function in DynaPDF manual.
DynaPDFMBS.FindLinkAnnot(URL as string) as Integer
Function:
This function searches for a file link or web link annotation.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also FindLinkAnnot function in DynaPDF manual.
DynaPDFMBS.FindNextBookmark as Integer
Function:
The function searches for the next bookmark with the same search parameters which were used by a previous call of FindBookmark().
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also FindNextBookmark function in DynaPDF manual.
DynaPDFMBS.FinishSignature(PKCS7 as Memoryblock) as boolean
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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 13.0 | Yes | Yes | Yes | Yes | All |
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.
DynaPDFMBS.FinishSignature(PKCS7 as string) as boolean
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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 10.2 | Yes | Yes | Yes | Yes | All |
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.
DynaPDFMBS.FlattenAnnotOrField(AnnotationOrFieldHandle as Integer, AnnotFlattenFlags as Integer) as Boolean
Function:
Draws an annotation or form field on the current open page.
Notes:
Form fields are annotations of type atWidget. The annotations of a page can be enumerated with GetPageAnnotEx() / GetPageAnnotCount().
The annotation or form field is deleted from the page's annotation array after it was flattened. 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 | 20.0 | Yes | Yes | Yes | Yes | All |
Notes:
Form fields are annotations of type atWidget. The annotations of a page can be enumerated with GetPageAnnotEx() / GetPageAnnotCount().
The annotation or form field is deleted from the page's annotation array after it was flattened. If the function succeeds the return value is true. If the function fails the return value is false.
See also FlattenAnnotOrField function in DynaPDF manual.
DynaPDFMBS.FlattenAnnots(AnnotFlattenFlags as Integer = 0) as Integer
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:
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.6 | Yes | Yes | Yes | Yes | All |
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:
| kaffNone | 0 | Printable annotations independent of the type |
| kaffUseViewState | 1 | If set, annotations which are visible in a viewer become flattened. |
| kaffMarkupAnnots | 2 | If 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.
DynaPDFMBS.FlattenForm as Boolean
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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
Notes: Requires DynaPDF Pro license.
See also FlattenForm function in DynaPDF manual.
DynaPDFMBS.FlushPageContent(stack as DynaPDFStackMBS) as boolean
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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 7.7 | Yes | Yes | Yes | Yes | All |
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.
DynaPDFMBS.FlushPages(Flags as Integer = 0) as boolean
Function:
Flushes pages.
Notes: Do not use FlushPages and SetUseSwapFile together. Use one function.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 11.1 | Yes | Yes | Yes | Yes | All |
Notes: Do not use FlushPages and SetUseSwapFile together. Use one function.
See also FlushPages function in DynaPDF manual.
DynaPDFMBS.FlushPagesEx(Flags as integer, LastPage as Integer) as boolean
Function:
Writes the pages in memory to the PDF file exactly like FlushPages().
Notes: The only difference is that the last page can be specified. The function calls FlushPages() if LastPage is smaller than 1.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 20.3 | Yes | Yes | Yes | Yes | All |
Notes: The only difference is that the last page can be specified. The function calls FlushPages() if LastPage is smaller than 1.
See also FlushPagesEx function in DynaPDF manual.
DynaPDFMBS.FreeImageBuffer
Function:
Frees the current image buffer.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.6 | Yes | Yes | Yes | Yes | All |
See also FreeImageBuffer function in DynaPDF manual.
DynaPDFMBS.FreeImageObj(Handle as UInt32) as boolean
Function:
The function releases memory that was allocated by GetImageObj to decompress the image.
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 | 14.0 | 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 FreeImageObj function in DynaPDF manual.
DynaPDFMBS.FreePDF as Boolean
Function:
The function frees all used resources except the font cache.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also FreePDF function in DynaPDF manual.
DynaPDFMBS.FreeTextAnnot(PosX as Double, PosY as Double, Width as Double, Height as Double, Author as string, Text as string, Align as Integer) as Integer
Function:
This function creates a free text annotation.
Example:
Notes:
The Name and Author parameters are converted to unicode.
| 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 instance
// edit page 1
call pdf.EditPage(1)
// set a font
call pdf.SetFont( "Times New Roman",pdf.kfsNone,46,True,pdf.kcp1252 )
// set a color
call pdf.SetFillColor(0)
// now add a text annotation
call pdf.FreeTextAnnot( 100, 100, 100, 100, "author", "test", 0 )
// end page
call pdf.EndPage
See also FreeTextAnnot function in DynaPDF manual.
DynaPDFMBS.FreeTextAnnotAnsi(PosX as Double, PosY as Double, Width as Double, Height as Double, Author as string, Text as string, Align as Integer) as Integer
Function:
This function creates a free text annotation.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.3 | Yes | Yes | Yes | Yes | All |
This item is deprecated and should no longer be used.
You can use Non ANSI function. instead.
Notes:
The Name and Author parameters are converted to ANSI.See also FreeTextAnnot function in DynaPDF manual.
DynaPDFMBS.Get3DAnnotStream(Annot as UInt32, byref Data as String, byref SubType as String) as Boolean
Function:
Retrieves the data stream of a 3D annotation.
Notes:
At time of publication, PDF supports U3D and PRC files. Check the value of the string SubType to determine the file type. The default format is U3D. SubType can be "" in this case. For PRC files, SubType is required to be present.
Returns true on success and false on failure.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 18.3 | Yes | Yes | Yes | Yes | All |
Notes:
At time of publication, PDF supports U3D and PRC files. Check the value of the string SubType to determine the file type. The default format is U3D. SubType can be "" in this case. For PRC files, SubType is required to be present.
Returns true on success and false on failure.
See also Get3DAnnotStream function in DynaPDF manual.
DynaPDFMBS.GetActionCount as Integer
Function:
The function returns the number of actions contained in a document.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetActionCount function in DynaPDF manual.
DynaPDFMBS.GetActionHandle(ObjType as Integer, ObjHandle as UInt32, ActIndex as UInt32) as Integer
Function:
Returns the handle of an action.
Notes:
To determine the number of available actions of a specific object call GetObjActionCount. Since the Catalog object contains no handle, the parameter ObjHandle will be ignored for this object type.
If the function succeeds the return value is the action 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:
To determine the number of available actions of a specific object call GetObjActionCount. Since the Catalog object contains no handle, the parameter ObjHandle will be ignored for this object type.
If the function succeeds the return value is the action handle, a value greater or equal zero. If the function fails the return value is a negative error code.
See also GetActionHandle function in DynaPDF manual.
DynaPDFMBS.GetActionType(ActHandle as Integer) as Integer
Function:
The function returns the type of an annotation.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetActionType function in DynaPDF manual.
DynaPDFMBS.GetActionTypeEx(ObjType as Integer, ObjHandle as Integer, ActIndex as Integer) as Integer
Function:
The function returns the action type of an action used by a specific PDF object.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetActionTypeEx function in DynaPDF manual.
DynaPDFMBS.GetActiveFont as Integer
Function:
The function returns the handle of the active font or -1 if no font is set.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetActiveFont function in DynaPDF manual.
DynaPDFMBS.GetAllocBy as Integer
Function:
The function returns the pre allocated buffer size of page content streams in bytes.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetAllocBy function in DynaPDF manual.
DynaPDFMBS.GetAnnot(ahandle as Integer) as DynaPDFAnnotationMBS
Function:
This function retrieves the most important properties of an annotation.
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 instance
dim c as Integer = pdf.GetAnnotCount
for i as Integer = 0 to c-1
dim a as DynaPDFAnnotationMBS = pdf.GetAnnot(i)
MsgBox str(a.Type)
next
This item is deprecated and should no longer be used.
You can use GetAnnotEx instead.
DynaPDFMBS.GetAnnotBBox(ahandle as Integer) as DynaPDFRectMBS
Function:
This function retrieves the bounding box of an annotation measured in bottom up coordinates.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetAnnotBBox function in DynaPDF manual.
DynaPDFMBS.GetAnnotCount as Integer
Function:
The function returns the number of annotations currently used in the document.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetAnnotCount function in DynaPDF manual.
DynaPDFMBS.GetAnnotEx(ahandle as Integer) as DynaPDFAnnotationExMBS
Function:
This function retrieves the most important properties of an annotation.
Example:
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.6 | Yes | Yes | Yes | Yes | All |
Example:
dim pdf as DynaPDFMBS // your instance
dim c as Integer = pdf.GetAnnotCount
for i as Integer = 0 to c-1
dim a as DynaPDFAnnotationExMBS = pdf.GetAnnotEx(i)
MsgBox str(a.Type)
next
See also GetAnnotEx function in DynaPDF manual.
DynaPDFMBS.GetAnnotFlags as Integer
Function:
The function returns the default flags used for newly created annotations.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetAnnotFlags function in DynaPDF manual.
DynaPDFMBS.GetAnnotLink(Handle as Integer) as string
Function:
This function returns the URL or file path of a file link annotation.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetAnnotLink function in DynaPDF manual.
The items on this page are in the following plugins: MBS DynaPDF Plugin.
Links
MBS Xojo tutorial videos
