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/DynaPDF Threaded Render Job
• /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 (happens automatically in DynaPDFImageMBS destructor).
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

Var pdf as new MyDynaPDFMBS

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

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

Some examples using this method:

• /DynaPDF/Create numbered pages
• /DynaPDF/DynaPDF Graphics/Create numbered pages
• /DynaPDF/Parser/Text Positions with parser
• /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

Var 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

Var count as integer = p.GetInDocInfoCount
for i as integer = 0 to count-1
  
  Var DInfo as integer
  Var key   as string
  Var value as string
  if p.GetInDocInfoEx(i, DInfo, key, value) >= 0 then
    
    Var 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.GetInEncryptionInfo as DynaPDFEncryptInfoMBS

It is not meaningful to call this function on an unencrypted file. Therefore, call GetInIsEncrypted() beforehand to determine whether the file is encrypted.

See also GetInEncryptionInfo 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 Boolean

Changed to boolean in version 24.4. Used to be integer.

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.

DynaPDFMBS.GetInIsTaggedPDF as integer

The PDF file must be opened beforehand with OpenImportFile() or OpenImportBuffer().
The return value is a set flags indicating the tagging status of the file.

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

See also GetInIsTaggedPDF function in DynaPDF manual.

DynaPDFMBS.GetInIsTrapped as Integer

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

See also GetInIsTrapped function in DynaPDF manual.

DynaPDFMBS.GetInIsXFAForm as Integer

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

See also GetInIsXFAForm function in DynaPDF manual.

DynaPDFMBS.GetInMetadata(PageNum as Integer) as String

Metadata streams are in XMP format that is a superset of XML. The PDF file must be opened with OpenImportImportFile or OpenImportBuffer beforehand.
Although the global XMP stream does usually exist in todays PDF files, metadata streams are optional and maybe not present. The function returns true if no error occurs, also if no metadata stream is present.

See also GetInMetadata function in DynaPDF manual.

DynaPDFMBS.GetInOrientation(PageNum as Integer) as Integer

Some examples using this method:

• /DynaPDF/Rotate rotated PDF back

See also GetInOrientation function in DynaPDF manual.

DynaPDFMBS.GetInPageCount as Integer

Some examples using this method:

• /DynaPDF/Create numbered pages
• /DynaPDF/DynaPDF Graphics/Create numbered pages
• /DynaPDF/Interlace PDFs
• /DynaPDF/Print PDF
• /DynaPDF/Raster/DynaPDF Threaded Render Job
• /DynaPDF/Raster/updatewindow event/Display PDF
• /DynaPDF/Split PDF
• /DynaPDF/Split PDF in memory
• /DynaPDF/Tables/Table Templates
• /DynaPDF/Web Edition/WebPDF Web

See also GetInPageCount function in DynaPDF manual.

DynaPDFMBS.GetInPDFVersion as Integer

See also GetInPDFVersion function in DynaPDF manual.

DynaPDFMBS.GetInPDFVersionEx as DynaPDFVersionInfoMBS

See also GetInPDFVersionEx function in DynaPDF manual.

DynaPDFMBS.GetInPrintSettings as DynaPDFPrintSettingsMBS

This is a PDF 1.7 extension.

See also GetInPrintSettings function in DynaPDF manual.

DynaPDFMBS.GetInRepairMode as Integer

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

See also GetInRepairMode function in DynaPDF manual.

DynaPDFMBS.GetIsFixedPitch as Integer

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

See also GetIsFixedPitch function in DynaPDF manual.

DynaPDFMBS.GetIsTaggingEnabled as boolean

See also GetIsTaggingEnabled function in DynaPDF manual.

DynaPDFMBS.GetItalicAngle as Double

See also GetItalicAngle function in DynaPDF manual.

DynaPDFMBS.GetJavaScript(Handle as Integer) as string

The result text string has either unicode or ASCII encoding.

You can use JavaScriptEngineMBS class to execute JavaScript without HTMLViewer in our own cross platform JavaScript engine.

If the JavaScript is attached to a field, please use GetFieldEx functions to get the action handle (DynaPDFFieldExMBS.Action) and then use GetJavaScriptAction instead.

See also GetJavaScript function in DynaPDF manual.

DynaPDFMBS.GetJavaScriptAction(Handle as Integer) as string   Deprecated

May return an unicode string.

See also:

• GetJavaScriptAction(ObjType as Integer, ObjHandle as Integer, ActIndex as Integer, byref ObjEvent as Integer) as string

See also GetJavaScriptAction function in DynaPDF manual.

DynaPDFMBS.GetJavaScriptAction(ObjType as Integer, ObjHandle as Integer, ActIndex as Integer, byref ObjEvent as Integer) as string   Deprecated

May return an unicode string.

The ObjEvent parameter was added in plugin version 9.3 and contains a value from the koe* constants.

See also:

• GetJavaScriptAction(Handle as Integer) as string

See also GetJavaScriptAction function in DynaPDF manual.

DynaPDFMBS.GetJavaScriptActionEx(index as Integer) as DynaPDFJavaScriptActionMBS

Index is from 0 to GetActionCount-1.

Some examples using this method:

• /DynaPDF/Show Javascript

See also GetJavaScriptActionEx function in DynaPDF manual.

DynaPDFMBS.GetJavaScriptCount as Integer

Some examples using this method:

• /DynaPDF/Show Javascript

See also GetJavaScriptCount function in DynaPDF manual.

DynaPDFMBS.GetJavaScriptEx(Name as string) as string

The result string is an unicode or an ASCII string.

You can use JavaScriptEngineMBS class to execute JavaScript without HTMLViewer in our own cross platform JavaScript engine.

If the JavaScript is attached to a field, please use GetFieldEx functions to get the action handle (DynaPDFFieldExMBS.Action) and then use GetJavaScriptAction instead.

Some examples using this method:

• /DynaPDF/Show Javascript

See also GetJavaScriptEx function in DynaPDF manual.

DynaPDFMBS.GetJavaScriptName(Handle as Integer) as string

The result string has either unicode or ASCII encoding.

Some examples using this method:

• /DynaPDF/Show Javascript

See also GetJavaScriptName function in DynaPDF manual.

DynaPDFMBS.GetJPEGQuality as Integer

See also GetJPEGQuality function in DynaPDF manual.

DynaPDFMBS.GetLanguage as string

See also GetLanguage function in DynaPDF manual.

DynaPDFMBS.GetLastTextOffset as UInt32

This lets you know how much text is left to write when you get a page break event.

Some examples using this method:

• /DynaPDF/Create PDF with text block2

DynaPDFMBS.GetLastTextPosX as Double

Some examples using this method:

• /DynaPDF/DynaPDF Database Invoice Example
• /DynaPDF/Million pages test/DynaPDF Database Invoice Example with 1000000 pages

DynaPDFMBS.GetLastTextPosXAbs as double

This function returns the absolute end position of the last drawn text after applying coordinate transformations, if any. The relative end point before applying coordinate transformations is returned by GetLastTextPosX() / GetLastTextPosY().

The y-coordinate is the position of the text's baseline measured in bottom-up coordinates.
Note that the reference point of WriteFText() is the baseline plus font size, independent of the current coordinate system. In contrast, the reference point of WriteText() is the baseline if bottom up coordinates are active and the baseline plus font size if top down coordinates are active (see SetPageCoords() for further information).

If the function succeeds the return value is the x- or y-coordinate. This value can be negative depending on the coordinate where the string was placed. If the function fails the return value is a negative error code. An error code is smaller than -33554531.0.