DynaPDFMBS.EnumHostFontsEx as Integer   Deprecated

Calls the EnumHostFontEx event.

See also EnumHostFontsEx function in DynaPDF manual.

DynaPDFMBS.EnumHostFontsExCount as Integer   Deprecated

Returns the number of fonts found. Does not call the event.

DynaPDFMBS.ExchangeBookmarks(Bmk1 as Integer, Bmk2 as Integer) as Boolean

See also ExchangeBookmarks function in DynaPDF manual.

DynaPDFMBS.ExchangePages(first as Integer, second as Integer) as Boolean

See also ExchangePages function in DynaPDF manual.

DynaPDFMBS.ExtractPageText(RemoveText as boolean = false) as String

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.

Deprecated in favor of newer ExtractText function.

Some examples using this method:

• /DynaPDF/Extract page Text

DynaPDFMBS.ExtractPageTextRect(Left as Double, Top as Double, Right as Double, Bottom as Double, RemoveText as boolean = false) as String

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.

Deprecated in favor of newer ExtractText function.

Some examples using this method:

• /DynaPDF/Extract page Text area

DynaPDFMBS.ExtractText(PageNum as Integer, Flags as Integer, rect as DynaPDFRectMBS = nil, byref text as string) as Boolean

dim pdf as DynaPDFMBS

dim Page as Integer = 1 // first page
dim Flags as Integer = ktefDefault
dim text as string
dim ok as boolean = pdf.ExtractText(Page, Flags, text)

if ok then
  msgbox text
end if

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.

See also ExtractText function in DynaPDF manual.

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

On Windows, the Desc and the Author parameters are converted to unicode.

Some examples using this method:

• /DynaPDF/Create PDF with Annotations

See also FileAttachAnnot function in DynaPDF manual.

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

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:

• 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

See also FileAttachAnnotEx function in DynaPDF manual.

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

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:

• 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

See also FileAttachAnnotEx function in DynaPDF manual.

DynaPDFMBS.FileLink(PosX as Double, PosY as Double, Width as Double, Height as Double, FileLink as string) as Integer

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.

Some examples using this method:

• /DynaPDF/Create PDF with FileLink
• /DynaPDF/Create PDF with Image FileLink
• /DynaPDF/Show Annotations
• /DynaPDF/Show Links

See also FileLink function in DynaPDF manual.

DynaPDFMBS.FileLinkAnsi(PosX as Double, PosY as Double, Width as Double, Height as Double, FileLink as string) as Integer   Deprecated

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.

DynaPDFMBS.FindBookmark(DestPage as Integer, Text as string) as Integer

The text parameter is converted to unicode.

See also FindBookmark function in DynaPDF manual.

DynaPDFMBS.FindBookmarkAnsi(DestPage as Integer, Text as string) as Integer   Deprecated

The text parameter is converted to ANSI.

See also FindBookmark function in DynaPDF manual.

DynaPDFMBS.FindEmbeddedFile(Name as string) as Integer

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.

DynaPDFMBS.FindField(Name as string) as Integer

The Name parameter is converted to unicode.

Some examples using this method:

• /DynaPDF/acroform/Fill value

See also FindField function in DynaPDF manual.

DynaPDFMBS.FindFieldAnsi(Name as string) as Integer   Deprecated

The Name parameter is converted to ANSI.

See also FindField function in DynaPDF manual.

DynaPDFMBS.FindLinkAnnot(URL as string) as Integer

See also FindLinkAnnot function in DynaPDF manual.

DynaPDFMBS.FindNextBookmark as Integer

See also FindNextBookmark function in DynaPDF manual.

DynaPDFMBS.FinishSignature(PKCS7 as Memoryblock) as boolean

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:

• FinishSignature(PKCS7 as string) as boolean

Some examples using this method:

• /DynaPDF/Create PDF with Custom Signature

See also FinishSignature function in DynaPDF manual.

DynaPDFMBS.FinishSignature(PKCS7 as string) as boolean

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:

• FinishSignature(PKCS7 as Memoryblock) as boolean

See also FinishSignature function in DynaPDF manual.

DynaPDFMBS.FlattenAnnotOrField(AnnotationOrFieldHandle as Integer, AnnotFlattenFlags as Integer) as Boolean

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

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.

Some examples using this method:

• /DynaPDF/PDF-A/Combine PDF files to PDFA
• /DynaPDF/Text extraction

See also FlattenAnnots function in DynaPDF manual.

DynaPDFMBS.FlattenForm as Boolean

Requires DynaPDF Pro license.

Some examples using this method:

• /DynaPDF/PDF-A/Combine PDF files to PDFA
• /DynaPDF/Text extraction

See also FlattenForm function in DynaPDF manual.

DynaPDFMBS.FlushPageContent(stack as DynaPDFStackMBS) as boolean

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.

Some examples using this method:

• /DynaPDF/text editing/delete text
• /DynaPDF/text editing/replace text

See also FlushPageContent function in DynaPDF manual.

DynaPDFMBS.FlushPages(Flags as Integer = 0) as boolean

Do not use FlushPages and SetUseSwapFile together. Use one function.

Some examples using this method:

• /DynaPDF/Create PDF with over 2 GB size
• /DynaPDF/Million pages test/DynaPDF Database Invoice Example with 1000000 pages
• /DynaPDF/Tables/Table Images

See also FlushPages function in DynaPDF manual.

DynaPDFMBS.FlushPagesEx(Flags as integer, LastPage as Integer) as boolean

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

Some examples using this method:

• /DynaPDF/Create Previews for folder
• /DynaPDF/Web Edition/WebPDF Web

See also FreeImageBuffer function in DynaPDF manual.

DynaPDFMBS.FreeImageObj(Handle as UInt32) as boolean

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

Some examples using this method:

• /DynaPDF/Create Previews for folder
• /DynaPDF/PDF Color Analyze
• /DynaPDF/PDF Color Analyze per Page
• /DynaPDF/Raster/Search and show PDF files
• /DynaPDF/Rotate rotated PDF back
• /DynaPDF/Show Differences
• /DynaPDF/Split PDF in memory

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

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

The Name and Author parameters are converted to unicode.

Some examples using this method:

• /DynaPDF/Create PDF with Annotations

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   Deprecated

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

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

See also GetActionCount function in DynaPDF manual.

DynaPDFMBS.GetActionHandle(ObjType as Integer, ObjHandle as UInt32, ActIndex as UInt32) as Integer

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

See also GetActionType function in DynaPDF manual.

DynaPDFMBS.GetActionTypeEx(ObjType as Integer, ObjHandle as Integer, ActIndex as Integer) as Integer

See also GetActionTypeEx function in DynaPDF manual.

DynaPDFMBS.GetActiveFont as Integer

See also GetActiveFont function in DynaPDF manual.

DynaPDFMBS.GetAllocBy as Integer

See also GetAllocBy function in DynaPDF manual.

DynaPDFMBS.GetAnnot(ahandle as Integer) as DynaPDFAnnotationMBS   Deprecated

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

See also GetAnnot function in DynaPDF manual.

DynaPDFMBS.GetAnnotBBox(ahandle as Integer) as DynaPDFRectMBS

See also GetAnnotBBox function in DynaPDF manual.

DynaPDFMBS.GetAnnotCount as Integer

Some examples using this method:

• /DynaPDF/Object Actions
• /DynaPDF/PDF Viewer Example with links
• /DynaPDF/Raster/DynaPDF Display PDF with Links
• /DynaPDF/Show Annotations
• /DynaPDF/Show Javascript
• /DynaPDF/Show Links

See also GetAnnotCount function in DynaPDF manual.

DynaPDFMBS.GetAnnotEx(ahandle as Integer) as DynaPDFAnnotationExMBS

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

Some examples using this method:

• /DynaPDF/Object Actions
• /DynaPDF/PDF Viewer Example with links
• /DynaPDF/Raster/DynaPDF Display PDF with Links
• /DynaPDF/Show Annotations
• /DynaPDF/Show Links

See also GetAnnotEx function in DynaPDF manual.

DynaPDFMBS.GetAnnotFlags as Integer

See also GetAnnotFlags function in DynaPDF manual.

DynaPDFMBS.GetAnnotLink(Handle as Integer) as string

See also GetAnnotLink function in DynaPDF manual.

DynaPDFMBS.GetAnnotType(Handle as Integer) as Integer

See also GetAnnotType function in DynaPDF manual.

DynaPDFMBS.GetAscent as Double

See also GetAscent function in DynaPDF manual.

DynaPDFMBS.GetBBox(boundary as Integer) as DynaPDFRectMBS

// Just set the trim box to the same value as the media box as an example

dim r as DynaPDFRectMBS = pdf.GetBBox(pdf.kpbMediaBox)
call pdf.SetBBox(pdf.kpbTrimBox, r.Left, r.Bottom, r.Right, r.Top)

Some examples using this method:

• /DynaPDF/Create PDF with demo string
• /DynaPDF/Create PDFX
• /DynaPDF/PDF-A/Create PDFA

See also GetBBox function in DynaPDF manual.

DynaPDFMBS.GetBidiMode as Integer

Useful constants:

kbmLeftToRight	0	Apply the bidi algorithm in Left to Right layout
kbmRightToLeft	1	Apply the bidi algorithm in Right to Left layout
kbmNone	2	Default -> do not apply the bidi algorithm

See also GetBidiMode function in DynaPDF manual.

DynaPDFMBS.GetBookmark(ahandle as Integer) as DynaPDFBookmarkMBS

See also GetBookmark function in DynaPDF manual.