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
dim 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:
dim 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.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.

DynaPDFMBS.GetHideAction(index as Integer) as DynaPDFHideActionMBS

Index is from 0 to GetActionCount-1.

See also GetHideAction function in DynaPDF manual.

DynaPDFMBS.GetIconColor as Integer

See also GetIconColor function in DynaPDF manual.

DynaPDFMBS.GetImageBuffer as string

Some examples using this method:

• /DynaPDF/Create Previews for folder
• /DynaPDF/Raster/RenderPageToImage test
• /DynaPDF/Raster/RenderPageToImage with color management
• /DynaPDF/Web Edition/WebPDF Web
• /DynaPDF/Web Edition/WebPicture from PDF Page Web

See also GetImageBuffer function in DynaPDF manual.

DynaPDFMBS.GetImageBufferMemory as memoryblock

Some examples using this method:

• /DynaPDF/List Images

DynaPDFMBS.GetImageCount(File as folderitem) as Integer

See also:

• GetImageCount(Path as string) as Integer

Some examples using this method:

• /DynaPDF/Image to PDF/Batch Image to PDF
• /DynaPDF/Image to PDF/Batch Image to PDF console
• /DynaPDF/Image to PDF/Multi Tiff to PDF

See also GetImageCount function in DynaPDF manual.

DynaPDFMBS.GetImageCount(Path as string) as Integer

See also:

• GetImageCount(File as folderitem) as Integer

See also GetImageCount function in DynaPDF manual.

DynaPDFMBS.GetImageCountEx(Buffer as Memoryblock) as Integer

See also:

• GetImageCountEx(Buffer as string) as Integer

See also GetImageCountEx function in DynaPDF manual.

DynaPDFMBS.GetImageCountEx(Buffer as string) as Integer

See also:

• GetImageCountEx(Buffer as Memoryblock) as Integer

See also GetImageCountEx function in DynaPDF manual.

DynaPDFMBS.GetImageHeight(Handle as Integer) as Integer

See also GetImageHeight function in DynaPDF manual.

DynaPDFMBS.GetImageObj(Handle as UInt32, Flags as Integer = 0) as DynaPDFImageMBS

For the flags use the constants: kpfNone, kpfDecomprAllImages, kpfNoJPXDecode, kpfDitherImagesToBW, kpfConvImagesToGray, kpfConvImagesToRGB, kpfConvImagesToCMYK or kpfImageInfoOnly.

By default all images are returned decompressed, with exception of image types which are already stored in a valid file format like JPEG and JPEG 2000 images.
If all image types should be decompressed set the flag kpfDecompressAllImages.
This function allocates memory that should be released with FreeImageObj when finish.
Image handles are simple array indexes. The number of image objects can be determined with GetImageObjCount. Note that this array does not include inline images which are stored in content streams. Such images can only be accessed with ParseContent().

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

Some examples using this method:

• /DynaPDF/Extract image objects
• /DynaPDF/Extract images
• /DynaPDF/List Images

See also GetImageObj function in DynaPDF manual.

DynaPDFMBS.GetImageObjCount as Integer

The images can be accessed with GetImageObj().
The return value is the number of image objects. This function cannot fail.

Some examples using this method:

• /DynaPDF/Extract image objects
• /DynaPDF/List Images

See also GetImageObjCount function in DynaPDF manual.

DynaPDFMBS.GetImageWidth(Handle as Integer) as Integer

See also GetImageWidth function in DynaPDF manual.

DynaPDFMBS.GetImportDataAction(index as Integer, Decompress as Boolean = false, ImageParseFlags as Integer = &h00000080) as DynaPDFImportDataActionMBS

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 GetImportDataAction function in DynaPDF manual.

DynaPDFMBS.GetImportFlags as Integer

See also GetImportFlags function in DynaPDF manual.

DynaPDFMBS.GetImportFlags2 as Integer

See also GetImportFlags2 function in DynaPDF manual.

DynaPDFMBS.GetInBBox(PageNum as Integer, Boundary as Integer) as DynaPDFRectMBS

dim pdf as new MyDynaPDFMBS

// open some PDF
call pdf.CreateNewPDF(nil)
call pdf.OpenImportFile(file, 0, "")

// query page size
dim bounds as DynaPDFRectMBS = pdf.GetInBBox(1, pdf.kpbMediaBox)

Some examples using this method:

• /DynaPDF/Create numbered pages
• /DynaPDF/DynaPDF Graphics/Create numbered pages
• /DynaPDF/place centered/place centered
• /DynaPDF/place centered/place centered and rotate
• /DynaPDF/Raster/Batch Convert PDF to JPG

See also GetInBBox function in DynaPDF manual.

DynaPDFMBS.GetInDocInfo(DInfo as Integer, byref value as string) as Integer

Some examples using this method:

• /DynaPDF/Change PDF Metadata
• /DynaPDF/Show metadata of folder of PDF files

See also GetInDocInfo function in DynaPDF manual.

DynaPDFMBS.GetInDocInfoCount as Integer

Some examples using this method:

• /DynaPDF/Document Info

See also GetInDocInfoCount function in DynaPDF manual.

DynaPDFMBS.GetInDocInfoEx(index as Integer, byref DInfo as Integer, byref key as string, byref value as string) as Integer

dim p as new DynaPDFMBS

call p.CreateNewPDF(nil)

// Skip anything that is not required
call p.SetImportFlags p.kifImportAll+p.kifImportAsPage

// From which PDF file do you want to extract the information?
call p.OpenImportFile(file, p.kptOpen, "")

// lookup all document information

dim count as integer = p.GetInDocInfoCount
for i as integer = 0 to count-1
  
  dim DInfo as integer
  dim key   as string
  dim value as string
  if p.GetInDocInfoEx(i, DInfo, key, value) >= 0 then
    
    dim Type as string
    select case dinfo
    case p.kdiAuthor
      type = "Author"
    case p.kdiCreator
      type = "Creator"
    case p.kdiKeywords
      type = "Keywords"
    case p.kdiProducer
      type = "Producer"
    case p.kdiSubject
      type = "Subject"
    case p.kdiTitle
      type = "Title"
    case p.kdiCompany
      type = "Company"
    case p.kdiPDFX_Ver
      type = "PDF/X Version"
    case p.kdiCustom
      type = "Custom"
    case p.kdiPDFX_Conf
      type = "PDF/X Config"
    case p.kdiCreationDate
      type = "Creation Date"
    case p.kdiModDate
      type = "Modification Date"
    else
      Break
      type = "?"
    end Select
    
    List.AddRow type, key, value
  end if
  
next

// close import file
call p.CloseImportFile

The key result is an ASCII string.
The value result is an ASCII or Unicode string.

Some examples using this method:

• /DynaPDF/Document Info

See also GetInDocInfoEx function in DynaPDF manual.

DynaPDFMBS.GetInEncryptionFlags as Integer

See also GetInEncryptionFlags function in DynaPDF manual.

DynaPDFMBS.GetInFieldCount as Integer

See also GetInFieldCount function in DynaPDF manual.

DynaPDFMBS.GetInIsCollection as Integer

Changed to integer in order to allow returning error codes besides 0 for false and 1 for true.

Some examples using this method:

• /DynaPDF/Extract files from Collection PDF

See also GetInIsCollection function in DynaPDF manual.

DynaPDFMBS.GetInIsEncrypted as Integer

Changed to integer in order to allow returning error codes besides 0 for false and 1 for true.

See also GetInIsEncrypted function in DynaPDF manual.

DynaPDFMBS.GetInIsSigned as Integer

Changed to integer in order to allow returning error codes besides 0 for false and 1 for true.

See also GetInIsSigned function in DynaPDF manual.