Xojo Developer Conference
25/27th April 2018 in Denver.
MBS Xojo Conference
6/7th September 2018 in Munich, Germany.

Platforms to show: All Mac Windows Linux Cross-Platform

Previous items Next items

DynaPDFMBS.GetActionHandle(ObjType as Integer, ObjHandle as UInt32, ActIndex as UInt32) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 15.3 Yes Yes Yes Yes No
Function: Returns the handle of an action.
Notes:
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.

Feedback, Comments & Corrections

DynaPDFMBS.GetActionType(ActHandle as Integer) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: The function returns the type of an annotation.
Notes: Also check the dynapdf manual on the pdfGetActionType function.

See also GetActionType function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetActionTypeEx(ObjType as Integer, ObjHandle as Integer, ActIndex as Integer) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: The function returns the action type of an action used by a specific PDF object.
Notes: Also check the dynapdf manual on the pdfGetActionTypeEx function.

See also GetActionTypeEx function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetActiveFont as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: The function returns the handle of the active font or 1 if no font is set.
Notes: Also check the dynapdf manual on the pdfGetActiveFont function.

See also GetActiveFont function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetAllocBy as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: The function returns the pre allocated buffer size of page content streams in bytes.
Notes: Also check the dynapdf manual on the pdfGetAllocBy function.

See also GetAllocBy function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetAnnot(ahandle as Integer) as DynaPDFAnnotationMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: This function retrieves the most important properties of an annotation.
Example:
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
This item is deprecated and should no longer be used. You can use GetAnnotEx instead.
Notes: Also check the dynapdf manual on the pdfGetAnnot function.

Feedback, Comments & Corrections

DynaPDFMBS.GetAnnotBBox(ahandle as Integer) as DynaPDFRectMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: This function retrieves the bounding box of an annotation measured in bottom up coordinates.
Notes: Also check the dynapdf manual on the pdfGetAnnotBBox function.

See also GetAnnotBBox function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetAnnotCount as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: The function returns the number of annotations currently used in the document.
Notes: Also check the dynapdf manual on the pdfGetAnnotCount function.

See also GetAnnotCount function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetAnnotEx(ahandle as Integer) as DynaPDFAnnotationExMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.6 Yes Yes Yes Yes No
Function: This function retrieves the most important properties of an annotation.
Example:
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
Notes: Also check the dynapdf manual on the pdfGetAnnot function.

See also GetAnnotEx function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetAnnotFlags as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: The function returns the default flags used for newly created annotations.
Notes: Also check the dynapdf manual on the pdfGetAnnotFlags function.

See also GetAnnotFlags function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetAnnotLink(Handle as Integer) as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: This function returns the URL or file path of a file link annotation.
Notes: Also check the dynapdf manual on the pdfGetAnnotLink function.

See also GetAnnotLink function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetAnnotType(Handle as Integer) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: The function returns the type of a specific annotation.
Notes: Also check the dynapdf manual on the pdfGetAnnotType function.

See also GetAnnotType function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetAscent as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: The function returns the ascender of the active font.
Notes: Also check the dynapdf manual on the pdfGetAscent function.

See also GetAscent function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetBBox(boundary as Integer) as DynaPDFRectMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: The function returns a bounding box of a PDF page.
Notes: Also check the dynapdf manual on the pdfGetBBox function.

See also GetBBox function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetBidiMode as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: A new function in dynapdf which is not documented.
Notes: Also check the dynapdf manual on the pdfGetBidiMode function.

See also GetBidiMode function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetBookmark(ahandle as Integer) as DynaPDFBookmarkMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: This function returns the properties of a bookmark.
Notes: Also check the dynapdf manual on the pdfGetBookmark function.

See also GetBookmark function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetBookmarkCount as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: The function returns the number of bookmarks defined in the document.
Notes: Also check the dynapdf manual on the pdfGetBookmarkCount function.

See also GetBookmarkCount function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetBorderStyle as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: The function returns the global border style which is used for newly created Interactive Form fields.
Notes: Also check the dynapdf manual on the pdfGetBorderStyle function.

See also GetBorderStyle function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetBuffer as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: The function returns a pointer to the buffer of a memory based PDF file.
Notes:
Also check the dynapdf manual on the pdfGetBuffer function.
The result string has no encoding set.

See also GetBuffer function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetBufferMemory as Memoryblock
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 13.0 Yes Yes Yes Yes No
Function: The function returns a pointer to the buffer of a memory based PDF file.
Notes:
Also check the dynapdf manual on the pdfGetBuffer function.
The result string has no encoding set.

Feedback, Comments & Corrections

DynaPDFMBS.GetCapHeight as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: The function returns the cap height of the active font.
Notes: Also check the dynapdf manual on the pdfGetCapHeight function.

See also GetCapHeight function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetCharacterSpacing as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: The function returns the current character spacing.
Notes: Also check the dynapdf manual on the pdfGetCharacterSpacing function.

See also GetCharacterSpacing function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetCheckBoxChar as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: The function returns the character used for newly created check boxes.
Notes: Also check the dynapdf manual on the pdfGetCheckBoxChar function.

See also GetCheckBoxChar function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetCheckBoxCharEx(Field as Integer) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 9.3 Yes Yes Yes Yes No
Function: Queries the check box character for the given field.

See also GetCheckBoxCharEx function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetCheckBoxDefState(Field as Integer) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: This function returns the default state of a check box, that is 1 == checked or 0 == unchecked.
Notes: Also check the dynapdf manual on the pdfGetCheckBoxDefState function.

See also GetCheckBoxDefState function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetCMap(index as Integer) as DynapdfCMapMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 10.1 Yes Yes Yes Yes No
Function: Returns the CMap object with the given index.

See also GetCMap function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetCMapCount as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 10.1 Yes Yes Yes Yes No
Function: Returns the number of character maps.

See also GetCMapCount function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetColorSpace as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: The function returns the active color space.
Notes: Also check the dynapdf manual on the pdfGetColorSpace function.

See also GetColorSpace function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetColorSpaceCount as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 9.3 Yes Yes Yes Yes No
Function: The number of color spaces.
Example:
Sub DrawSomething(pdf as DynaPDFMBS)
// draw all colorants with their own color
Dim 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
dim Colorcount as Integer = pdf.GetColorSpaceCount

For j as Integer = 0 to Colorcount-1
MyX = 10
dim MyColourSpace as DynapdfColorSpaceMBS = PDF.GetColorSpaceObj(j)
dim ColorantsCount as Integer = MyColourSpace.ColorantsCount
dim 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
dim values() as Double
redim values(c-1)
values(i) = 1.0

// get name
dim 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

See also GetColorSpaceCount function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetColorSpaceObj(index as Integer) as DynaPDFColorSpaceMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 9.3 Yes Yes Yes Yes No
Function: Queries a ColorSync Profile for the given index.
Notes: Index from 0 to GetColorSpaceCount-1.

See also GetColorSpaceObj function in DynaPDF manual.

Feedback, Comments & Corrections

Previous items Next items

The items on this page are in the following plugins: MBS DynaPDF Plugin.




Links
MBS FileMaker tutorial videos