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

Var pdf as DynaPDFMBS // your instance

Var c as Integer = pdf.GetAnnotCount

for i as Integer = 0 to c-1
  Var 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.GetAnnotColor(Handle as UInt32, ColorType as Integer, byref ColorSpace as Integer, byref ColorValue as UInt32) as Boolean

Var pdf As New DynaPDFMBS

Call pdf.CreateNewPDF(Nil)
Call pdf.Append

// make an annotation
Call pdf.SetStrokeColor(pdf.RGB(255, 0, 0))
Var AnnotHandle As Integer = pdf.FreeTextAnnot(10.0, 10, 100, 20, "me", "Hello", pdf.ktaLeft)

// now query color
Var colorValue As UInt32
Var ColorSpace As Integer
Var r As Boolean = pdf.GetAnnotColor(AnnotHandle, pdf.kfcTextColor, ColorSpace, colorValue)

Break

If a color type is not supported by an annotation, the function returns false and passes a warning to the error event if set.

ColorType: The color type to retrieve. Can be kfcBackColor, kfcBorderColor or kfcTextColor.

See also GetAnnotColor 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

Var pdf as DynaPDFMBS // your instance

Var c as Integer = pdf.GetAnnotCount

for i as Integer = 0 to c-1
  Var 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.GetAnnotTextAlign(ahandle as integer) as Integer

At time of publication only FreeText annotations support a text alignment.

See also GetAnnotTextAlign 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

Var 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.

DynaPDFMBS.GetBookmarkCount as Integer

Some examples using this method:

• /DynaPDF/Object Actions
• /DynaPDF/Show Bookmarks
• /DynaPDF/Show Javascript

See also GetBookmarkCount function in DynaPDF manual.

DynaPDFMBS.GetBorderStyle as Integer

See also GetBorderStyle function in DynaPDF manual.

DynaPDFMBS.GetBuffer as string

The result string has no encoding set.

See also GetBuffer function in DynaPDF manual.

DynaPDFMBS.GetBufferMemory as Memoryblock

Var pdf As New DynaPDFMBS

// start new PDF
call pdf.CreateNewPDF

// set flags to import all
Var flags As Integer = Bitwise.BitOr(pdf.kifImportAsPage, pdf.kifImportAll)
Call pdf.SetImportFlags(flags)

// merge two PDF

var Data1 as MemoryBlock // first PDF data
Var Data2 As MemoryBlock // second PDF data

if Data1 <> nil then
  Call pdf.OpenImportBuffer(Data1)
  Call pdf.ImportPDFFile 1
end If

If Data2 <> Nil Then
  Call pdf.OpenImportBuffer(Data2)
  Call pdf.ImportPDFFile pdf.GetPageCount+1
End If

// Close and get new data
call pdf.CloseFile

Var NewPDFData As MemoryBlock = pdf.GetBufferMemory

The result string has no encoding set.

Some examples using this method:

• /DynaPDF/Create PDF with restrictions web

DynaPDFMBS.GetCapHeight as Double

Some examples using this method:

• /DynaPDF/Create PDF with demo string

See also GetCapHeight function in DynaPDF manual.

DynaPDFMBS.GetCharacterSpacing as Double

See also GetCharacterSpacing function in DynaPDF manual.

DynaPDFMBS.GetCheckBoxChar as Integer

See also GetCheckBoxChar function in DynaPDF manual.

DynaPDFMBS.GetCheckBoxCharEx(Field as Integer) as Integer

See also GetCheckBoxCharEx function in DynaPDF manual.

DynaPDFMBS.GetCheckBoxDefState(Field as Integer) as Integer

See also GetCheckBoxDefState function in DynaPDF manual.

DynaPDFMBS.GetCMap(index as Integer) as DynaPDFCMapMBS

See also GetCMap function in DynaPDF manual.

DynaPDFMBS.GetCMapCount as Integer

See also GetCMapCount function in DynaPDF manual.

DynaPDFMBS.GetColorSpace as Integer

Some examples using this method:

• /DynaPDF/Image to PDF/Image to pdf
• /DynaPDF/Image to PDF/Multi Tiff to PDF

See also GetColorSpace function in DynaPDF manual.

DynaPDFMBS.GetColorSpaceCount as Integer

Sub DrawSomething(pdf as DynaPDFMBS)
  // draw all colorants with their own color
  Var MyX, MyY as Double
  
  MyX = 10
  MyY = 100
  
  // set a font
  call pdf.SetFont "Times", pdf.kfsItalic, 10.0, true, pdf.kcp1252
  
  // loop over all color spaces
  Var Colorcount as Integer = pdf.GetColorSpaceCount
  
  For j as Integer = 0 to Colorcount-1
    MyX = 10
    Var MyColourSpace as DynaPDFColorSpaceMBS = PDF.GetColorSpaceObj(j)
    Var ColorantsCount as Integer = MyColourSpace.ColorantsCount
    Var c as Integer = MyColourSpace.NumInComponents
    Call pdf.SetExtColorSpace j
    
    // draw name of each colorant
    for i as Integer = 0 to c-1
      
      // build array with colors and set 100% for the one color we need
      Var values() as Double
      redim values(c-1)
      values(i) = 1.0
      
      // get name
      Var name as string = "#"+str(i)
      if i <= ColorantsCount then
        name = MyColourSpace.Colorants(i)
      end if
      
      // seaw name
      Call pdf.SetFillColor(values)
      call pdf.WriteText(MyX,MyY, name)
      
      // next
      MyX = MyX + pdf.GetTextWidth(name) + 20
    next
    
    // next
    MyY = MyY+20
  Next
End Sub

Some examples using this method:

• /DynaPDF/PDF Color Analyze
• /DynaPDF/PDF Color Analyze per Page

See also GetColorSpaceCount function in DynaPDF manual.

DynaPDFMBS.GetColorSpaceObj(index as Integer) as DynaPDFColorSpaceMBS

Index from 0 to GetColorSpaceCount-1.

Some examples using this method:

• /DynaPDF/PDF Color Analyze
• /DynaPDF/PDF Color Analyze per Page

See also GetColorSpaceObj function in DynaPDF manual.

DynaPDFMBS.GetCompressionFilter as Integer

See also GetCompressionFilter function in DynaPDF manual.

DynaPDFMBS.GetCompressionLevel as Integer

See also GetCompressionLevel function in DynaPDF manual.

DynaPDFMBS.GetContent as string

The result string has no encoding set.

See also GetContent function in DynaPDF manual.

DynaPDFMBS.GetDefBitsPerPixel as Integer

See also GetDefBitsPerPixel function in DynaPDF manual.

DynaPDFMBS.GetDescent as Double

See also GetDescent function in DynaPDF manual.

DynaPDFMBS.GetDocInfo(dinfo as Integer) as string

The result is an unicode string.

See also GetDocInfo function in DynaPDF manual.

DynaPDFMBS.GetDocInfoCount as Integer

See also GetDocInfoCount function in DynaPDF manual.

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

Key is an ascii string and value an unicode string.

See also GetDocInfoEx function in DynaPDF manual.

DynaPDFMBS.GetDocumentColorSpaces as DynaPDFColorSpaceMBS()

Some examples using this method:

• /DynaPDF/Show ColorSpaces

DynaPDFMBS.GetDocUsesTransparency(Flags as UInt32 = 0) as boolean

Checks whether a PDF file uses native PDF Transparency (PDF 1.4). The file uses transparency when it contains soft masks, blend modes other than Normal, or fill or stroke alpha values smaller than 1.0.
The function checks all pages, templates, extended graphics states, images, annotations, and form fields.
If the file uses transparency the return value is true. If it uses no transparency the return value is false.

See also GetDocUsesTransparency function in DynaPDF manual.

DynaPDFMBS.GetDrawDirection as Integer

See also GetDrawDirection function in DynaPDF manual.