DynaPDFMBS.GetEmbeddedFile(Handle as Integer, byref FileSpec as DynaPDFFileSpecMBS, Decompress as boolean) as boolean

// new PDF Environment
Var pdf as new MyDynaPDFMBS
call pdf.CreateNewPDF nil

// import PDF file
Var f as FolderItem = SpecialFolder.Desktop.Child("Create PDF with hidden data.pdf")
call pdf.SetImportFlags(pdf.kifImportAll + pdf.kifImportAsPage)
call pdf.OpenImportFile(f)
call pdf.ImportPDFFile(1)

// walk over list of embedded files and get their data
Var c as Integer = pdf.GetEmbeddedFileCount
for i as Integer = 0 to c-1
  Var e as DynaPDFFileSpecMBS
  if pdf.GetEmbeddedFile(i, e, true) then
    Var data as string = e.Buffer
    
    Break
  end if
next

// cleanup
call pdf.CloseFile

Some examples using this method:

• /DynaPDF/Extract embedded files
• /DynaPDF/Extract files from Collection PDF
• /DynaPDF/ZUGFeRD/Extract XML

See also GetEmbeddedFile function in DynaPDF manual.

DynaPDFMBS.GetEmbeddedFileCount as Integer

// new PDF Environment
Var pdf as new MyDynaPDFMBS
call pdf.CreateNewPDF nil

// import PDF file
Var f as FolderItem = SpecialFolder.Desktop.Child("Create PDF with hidden data.pdf")
call pdf.SetImportFlags(pdf.kifImportAll + pdf.kifImportAsPage)
call pdf.OpenImportFile(f)
call pdf.ImportPDFFile(1)

// walk over list of embedded files and get their data
Var c as Integer = pdf.GetEmbeddedFileCount
for i as Integer = 0 to c-1
  Var e as DynaPDFFileSpecMBS
  if pdf.GetEmbeddedFile(i, e, true) then
    Var data as string = e.Buffer
    
    Break
  end if
next

// cleanup
call pdf.CloseFile

Some examples using this method:

• /DynaPDF/Extract embedded files
• /DynaPDF/Extract files from Collection PDF
• /DynaPDF/ZUGFeRD/Extract XML

See also GetEmbeddedFileCount function in DynaPDF manual.

DynaPDFMBS.GetEMFPatternDistance as Double

See also GetEMFPatternDistance function in DynaPDF manual.

DynaPDFMBS.GetErrLogMessage(index as Integer) as DynaPDFErrorMBS

Index from 0 to GetErrLogMessageCount-1.

Some examples using this method:

• /DynaPDF/Table with Listbox auto width
• /DynaPDF/Tables/Table Images
• /DynaPDF/Tables/Table showing all fonts
• /DynaPDF/Tables/Table Templates
• /DynaPDF/Tables/Table Text
• /DynaPDF/Tables/Table with Listbox

See also GetErrLogMessage function in DynaPDF manual.

DynaPDFMBS.GetErrLogMessageCount as Integer

Some examples using this method:

• /DynaPDF/Table with Listbox auto width
• /DynaPDF/Tables/Table Images
• /DynaPDF/Tables/Table showing all fonts
• /DynaPDF/Tables/Table Templates
• /DynaPDF/Tables/Table Text
• /DynaPDF/Tables/Table with Listbox

See also GetErrLogMessageCount function in DynaPDF manual.

DynaPDFMBS.GetErrorMessage as string

Some examples using this method:

• /DynaPDF/Font Test

See also GetErrorMessage function in DynaPDF manual.

DynaPDFMBS.GetErrorMode as Integer

See also GetErrorMode function in DynaPDF manual.

DynaPDFMBS.GetField(index as Integer) as DynaPDFFieldMBS   Deprecated

See also GetField function in DynaPDF manual.

DynaPDFMBS.GetFieldBackColor as Integer

See also GetFieldBackColor function in DynaPDF manual.

DynaPDFMBS.GetFieldBorderColor as Integer

See also GetFieldBorderColor function in DynaPDF manual.

DynaPDFMBS.GetFieldBorderStyle(Field as Integer) as Integer

See also GetFieldBorderStyle function in DynaPDF manual.

DynaPDFMBS.GetFieldBorderWidth(aField as Integer) as Double

See also GetFieldBorderWidth function in DynaPDF manual.

DynaPDFMBS.GetFieldCalcOrder as UInt32()

Retrieves the calculation order of form fields which contain an action in the OnCalc event (see AddActionToObj() for further information). This is the order in which their values will be recalculated when the value of any field changes. The retrieved array values are field handles.

To change the calculation order of a specific field call SetFieldCalcOrder().

See also GetFieldCalcOrder function in DynaPDF manual.

DynaPDFMBS.GetFieldChoiceValue(Field as Integer, ValIndex as Integer) as DynaPDFChoiceValueMBS

See also GetFieldChoiceValue function in DynaPDF manual.

DynaPDFMBS.GetFieldColor(Field as Integer, ColorType as Integer, byref ColorSpace as Integer, byref ColorValue as Integer) as Integer

See also GetFieldColor function in DynaPDF manual.

DynaPDFMBS.GetFieldCount as Integer

See also GetFieldCount function in DynaPDF manual.

DynaPDFMBS.GetFieldEx(index as Integer) as DynaPDFFieldExMBS

Var pdf as new MyDynaPDFMBS

pdf.SetLicenseKey "Lite" // For this example you can use a Lite, Pro or Enterprise License

call pdf.CreateNewPDF(nil)
call pdf.SetImportFlags(BitwiseOr(pdf.kifImportAll, pdf.kifImportAsPage))

Var filePath as FolderItem=SpecialFolder.Desktop.Child("acroform.pdf")
if (pdf.OpenImportFile(filePath, pdf.kptOpen, "") < 0) then
  MsgBox "Input file """+filePath.name+""" not found!"
  quit
end if

// import all pages
Var r as Integer = pdf.ImportPDFFile( 1, 1.0, 1.0)

// now check all fields
Var n as Integer = pdf.GetFieldCount
for i as Integer = 0 to n-1
  Var f as DynaPDFFieldExMBS = pdf.GetFieldEx(i)
  
  break // inspect in debugger
next

See dynapdf_help.pdf for more details.

Some examples using this method:

• /DynaPDF/acroform/Fill value
• /DynaPDF/Display Form Fields
• /DynaPDF/Object Actions
• /DynaPDF/Show Javascript

See also GetFieldEx function in DynaPDF manual.

DynaPDFMBS.GetFieldExpValCount(Field as Integer) as Integer

Some examples using this method:

• /DynaPDF/Display Form Fields

See also GetFieldExpValCount function in DynaPDF manual.

DynaPDFMBS.GetFieldExpValue(Field as Integer) as string

Some examples using this method:

• /DynaPDF/Display Form Fields

See also GetFieldExpValue function in DynaPDF manual.

DynaPDFMBS.GetFieldExpValueEx(Field as Integer, ValIndex as Integer, byref Value as string, byref ExpValue as string, byref Selected as boolean) as Boolean

See also GetFieldExpValueEx function in DynaPDF manual.

DynaPDFMBS.GetFieldFlags(Field as Integer) as Integer

See also GetFieldFlags function in DynaPDF manual.

DynaPDFMBS.GetFieldGroupType(Field as Integer) as Integer

See also GetFieldGroupType function in DynaPDF manual.

DynaPDFMBS.GetFieldHighlightMode(Field as Integer) as Integer

See also GetFieldHighlightMode function in DynaPDF manual.

DynaPDFMBS.GetFieldIndex(Field as Integer) as Integer

See also GetFieldIndex function in DynaPDF manual.

DynaPDFMBS.GetFieldMapName(Field as Integer) as string

The result string is in unicode or ASCII encoding.

See also GetFieldMapName function in DynaPDF manual.

DynaPDFMBS.GetFieldName(Field as Integer) as string

Some examples using this method:

• /DynaPDF/acroform/Fill value
• /DynaPDF/Display Form Fields

See also GetFieldName function in DynaPDF manual.

DynaPDFMBS.GetFieldOrientation(Field as Integer) as Integer

See also GetFieldOrientation function in DynaPDF manual.

DynaPDFMBS.GetFieldTextAlign(Field as Integer) as Integer

See also GetFieldTextAlign function in DynaPDF manual.

DynaPDFMBS.GetFieldTextColor as Integer

See also GetFieldTextColor function in DynaPDF manual.

DynaPDFMBS.GetFieldToolTip(Field as Integer) as string

The result string has either unicode or ascii encoding.

See also GetFieldToolTip function in DynaPDF manual.

DynaPDFMBS.GetFieldType(Field as Integer) as Integer

Some examples using this method:

• /DynaPDF/acroform/Fill value
• /DynaPDF/Display Form Fields

See also GetFieldType function in DynaPDF manual.

DynaPDFMBS.GetFillColor as Integer

See also GetFillColor function in DynaPDF manual.

DynaPDFMBS.GetFontCount as Integer

Some examples using this method:

• /DynaPDF/Font Infos

See also GetFontCount function in DynaPDF manual.

DynaPDFMBS.GetFontEx(index as Integer) as DynaPDFFontMBS   Deprecated

// create PDF object with page
Var pdf as new DynaPDFMBS
call pdf.CreateNewPDF(nil)
call pdf.Append

// draw some text
call pdf.SetFont "Times", pdf.kfsItalic, 40.0, true, pdf.kcp1252
call pdf.WriteFText pdf.ktaCenter, "My first Xojo output!"

// and list all fonts:
Var n as Integer = pdf.GetFontCount-1

for i as Integer = 0 to n
  MsgBox pdf.GetFontEx(i).FontName
next

Returns nil on any error.
Index from 0 to GetFontCount-1.

See also GetFontEx function in DynaPDF manual.

DynaPDFMBS.GetFontInfoEx(index as Integer) as DynaPDFFontInfoMBS

This function accepts a font handle instead. A font handle is a simple array index. To enumerate all fonts of a document execute the function in a loop from zero to GetFontCount - 1.

If the function succeeds the return value is font info object. If the function fails the return value is nil.

Some examples using this method:

• /DynaPDF/Create PDF with Glyphs
• /DynaPDF/Font Infos

See also GetFontInfoEx function in DynaPDF manual.

DynaPDFMBS.GetFontMetrics(FontHandle as Integer) as DynaPDFFontMetricsMBS

See also GetFontMetrics function in DynaPDF manual.

DynaPDFMBS.GetFontOrigin as Integer

See also GetFontOrigin function in DynaPDF manual.

DynaPDFMBS.GetFontSearchOrder as Integer()

The values in the array use this constants:

kfbtTrueType	TrueType, TrueType Collections, or OpenType fonts with TrueType outlines
kfbtType1	Type1 font
kfbtOpenType	OpenType font with Postscript outlines
kfbtStdFont	PDF Standard font
kfbtDisabled	This value can be used to disable a specific font format.

The array has 4 values.

See also GetFontSearchOrder function in DynaPDF manual.

DynaPDFMBS.GetFontSelMode as Integer

See also GetFontSelMode function in DynaPDF manual.

DynaPDFMBS.GetFontSize as Double

The function returns the font size, a value greater zero on success, or a negative error code on failure.

See also GetFontSize function in DynaPDF manual.

DynaPDFMBS.GetFontWeight as Integer

See also GetFontWeight function in DynaPDF manual.

DynaPDFMBS.GetFTextHeight(Align as Integer, aText as string) as Double

The text parameter is converted to unicode.

Some examples using this method:

• /DynaPDF/Create PDF with object2d

See also GetFTextHeight function in DynaPDF manual.

DynaPDFMBS.GetFTextHeightAnsi(Align as Integer, aText as string) as Double   Deprecated

The text parameter is converted to ANSI.

See also GetFTextHeight function in DynaPDF manual.

DynaPDFMBS.GetFTextHeightEx(Width as Double, Align as Integer, aText as string) as Double

The text parameter is converted to unicode.

See also GetFTextHeightEx function in DynaPDF manual.

DynaPDFMBS.GetFTextHeightExAnsi(Width as Double, Align as Integer, aText as string) as Double   Deprecated

The text parameter is converted to ANSI.

See also GetFTextHeightEx function in DynaPDF manual.

DynaPDFMBS.GetGlyphIndex(Index as UInt32) as Integer

How Index must be defined depends on the code page with which the font was loaded. For example, if the font was loaded with a 8 bit code page, then indexes below 256 are treated as index into the code page table. Higher indexes are treated as Unicode value in this case. Note that all Unicode encoded glyphs of the font are accessible in this case, also if the font was loaded with a 8 bit code page!

At time of publication the function does not support CJK code pages which require a conversion to Unicode, e.g. cpCJK_Big5_Uni, cpCJK_EUC_JP_Uni, and so on.

If the function succeeds the return value is greater or equal zero. If the function fails the return value is a negative error code.

Some examples using this method:

• /DynaPDF/GlyphOutline

See also GetGlyphIndex function in DynaPDF manual.

DynaPDFMBS.GetGlyphOutline(Index as UInt32) as DynaPDFGlyphOutlineMBS

Note that not all glyphs have an outline. A space character, for example, has no outline and therefore the size can be zero. The function returns normalized outlines scaled to a font size of 1000 units.

Please see dynapdf_help.pdf and our example project on how to process the outline data.

Some examples using this method:

• /DynaPDF/GlyphOutline

See also GetGlyphOutline function in DynaPDF manual.

DynaPDFMBS.GetGoToAction(index as Integer, Decompress as Boolean = false, ImageParseFlags as Integer = &h00000080) as DynaPDFGoToActionMBS

Index is from 0 to GetActionCount-1.

If Decompress is true, all file specification containing compressed data are uncompressed.
And ImageParseFlags defines how GetImageObj is called internally to decompress image. Default is to only get image info, but you can pass other values to actually get image data.

See also GetGoToAction function in DynaPDF manual.

DynaPDFMBS.GetGoToRAction(index as Integer, Decompress as Boolean = false, ImageParseFlags as Integer = &h00000080) as DynaPDFGoToActionMBS

Index is from 0 to GetActionCount-1.

If Decompress is true, all file specification containing compressed data are uncompressed.
And ImageParseFlags defines how GetImageObj is called internally to decompress image. Default is to only get image info, but you can pass other values to actually get image data.

See also GetGoToRAction function in DynaPDF manual.

DynaPDFMBS.GetGStateFlags as Integer

See also GetGStateFlags function in DynaPDF manual.