Platforms to show: All Mac Windows Linux Cross-Platform

Back to DynaPDFMBS class.

Previous items Next items

DynaPDFMBS.GetBookmarkCount as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the number of bookmarks defined in the document.

Some examples using this method:

See also GetBookmarkCount function in DynaPDF manual.

DynaPDFMBS.GetBorderStyle as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the global border style which is used for newly created Interactive Form fields.

See also GetBorderStyle function in DynaPDF manual.

DynaPDFMBS.GetBuffer as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns a pointer to the buffer of a memory based PDF file.

The result string has no encoding set.

See also GetBuffer function in DynaPDF manual.

DynaPDFMBS.GetBufferMemory as Memoryblock

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 13.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns a pointer to the buffer of a memory based PDF file.

The result string has no encoding set.

DynaPDFMBS.GetCapHeight as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the cap height of the active font.

Some examples using this method:

See also GetCapHeight function in DynaPDF manual.

DynaPDFMBS.GetCharacterSpacing as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the current character spacing.

See also GetCharacterSpacing function in DynaPDF manual.

DynaPDFMBS.GetCheckBoxChar as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the character used for newly created check boxes.

See also GetCheckBoxChar function in DynaPDF manual.

DynaPDFMBS.GetCheckBoxCharEx(Field as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Queries the check box character for the given field.

See also GetCheckBoxCharEx function in DynaPDF manual.

DynaPDFMBS.GetCheckBoxDefState(Field as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This function returns the default state of a check box, that is 1 == checked or 0 == unchecked.

See also GetCheckBoxDefState function in DynaPDF manual.

DynaPDFMBS.GetCMap(index as Integer) as DynaPDFCMapMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 10.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Returns the CMap object with the given index.

See also GetCMap function in DynaPDF manual.

DynaPDFMBS.GetCMapCount as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 10.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Returns the number of character maps.

See also GetCMapCount function in DynaPDF manual.

DynaPDFMBS.GetColorSpace as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the active color space.

Some examples using this method:

See also GetColorSpace function in DynaPDF manual.

DynaPDFMBS.GetColorSpaceCount as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
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

Some examples using this method:

See also GetColorSpaceCount function in DynaPDF manual.

DynaPDFMBS.GetColorSpaceObj(index as Integer) as DynaPDFColorSpaceMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Queries a ColorSync Profile for the given index.

Index from 0 to GetColorSpaceCount-1.

Some examples using this method:

See also GetColorSpaceObj function in DynaPDF manual.

DynaPDFMBS.GetCompressionFilter as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the standard compression filter for images.

See also GetCompressionFilter function in DynaPDF manual.

DynaPDFMBS.GetCompressionLevel as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the active compression level.

See also GetCompressionLevel function in DynaPDF manual.

DynaPDFMBS.GetContent as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This function returns a pointer to the content stream of the currently open page or template.

The result string has no encoding set.

See also GetContent function in DynaPDF manual.

DynaPDFMBS.GetDefBitsPerPixel as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns default color depth in bits per pixel, which determines whether images should be down sampled.

See also GetDefBitsPerPixel function in DynaPDF manual.

DynaPDFMBS.GetDescent as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the descender of the active font.

See also GetDescent function in DynaPDF manual.

DynaPDFMBS.GetDocInfo(dinfo as Integer) as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function retrieves a document info entry as Unicode string.

The result is an unicode string.

See also GetDocInfo function in DynaPDF manual.

DynaPDFMBS.GetDocInfoCount as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the number of document info entries defined in the document.

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

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns a document info entry.

Key is an ascii string and value an unicode string.

See also GetDocInfoEx function in DynaPDF manual.

DynaPDFMBS.GetDocumentColorSpaces as DynaPDFColorSpaceMBS()

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 16.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Queries Colorspace objects for all colorspaces in the current working document.

Some examples using this method:

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

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 11.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Checks whether this document uses transparency.

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

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the actual draw direction for closed vector graphics such as rectangles, circles, ellipses and so on.

See also GetDrawDirection function in DynaPDF manual.

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

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function retrieves the most important properties of an embedded file as well as a pointer to the file buffer.
Example
// new PDF Environment
dim pdf as new MyDynaPDFMBS
call pdf.CreateNewPDF nil

// import PDF file
dim 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
dim c as Integer = pdf.GetEmbeddedFileCount
for i as Integer = 0 to c-1
dim e as DynaPDFFileSpecMBS
if pdf.GetEmbeddedFile(i, e, true) then
dim data as string = e.Buffer

Break
end if
next

// cleanup
call pdf.CloseFile

Some examples using this method:

See also GetEmbeddedFile function in DynaPDF manual.

DynaPDFMBS.GetEmbeddedFileCount as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the number of embedded files available in the PDF file.
Example
// new PDF Environment
dim pdf as new MyDynaPDFMBS
call pdf.CreateNewPDF nil

// import PDF file
dim 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
dim c as Integer = pdf.GetEmbeddedFileCount
for i as Integer = 0 to c-1
dim e as DynaPDFFileSpecMBS
if pdf.GetEmbeddedFile(i, e, true) then
dim data as string = e.Buffer

Break
end if
next

// cleanup
call pdf.CloseFile

Some examples using this method:

See also GetEmbeddedFileCount function in DynaPDF manual.

DynaPDFMBS.GetEMFPatternDistance as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Returns the distance between lines of standard patterns during EMF conversion.

See also GetEMFPatternDistance function in DynaPDF manual.

DynaPDFMBS.GetErrLogMessage(index as Integer) as DynaPDFErrorMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 11.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Querties the error message details for the given index.

Index from 0 to GetErrLogMessageCount-1.

Some examples using this method:

See also GetErrLogMessage function in DynaPDF manual.

DynaPDFMBS.GetErrLogMessageCount as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 11.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Returns the number of error log messages.

Some examples using this method:

See also GetErrLogMessageCount function in DynaPDF manual.

DynaPDFMBS.GetErrorMessage as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the last error message as a string, or "" if no error occurred.

Some examples using this method:

See also GetErrorMessage function in DynaPDF manual.

DynaPDFMBS.GetErrorMode as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the current error mode.

See also GetErrorMode function in DynaPDF manual.

DynaPDFMBS.GetField(index as Integer) as DynaPDFFieldMBS   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This item is deprecated and should no longer be used. You can use GetFieldEx instead.
The function retrieves the most important properties of a field.

See also GetField function in DynaPDF manual.

DynaPDFMBS.GetFieldBackColor as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the default background color used for newly created interactive form fields.

See also GetFieldBackColor function in DynaPDF manual.

DynaPDFMBS.GetFieldBorderColor as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the default border color used for newly created interactive form fields.

See also GetFieldBorderColor function in DynaPDF manual.

DynaPDFMBS.GetFieldBorderStyle(Field as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the border style of a specific form field.

See also GetFieldBorderStyle function in DynaPDF manual.

DynaPDFMBS.GetFieldBorderWidth(aField as Integer) as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the line width of the border of a field.

See also GetFieldBorderWidth function in DynaPDF manual.

DynaPDFMBS.GetFieldCalcOrder as UInt32()

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 19.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Queries field calculation order.

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

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 10.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Queries the choice values for this field.

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

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function retrieves a specific color of an interactive form field.

See also GetFieldColor function in DynaPDF manual.

DynaPDFMBS.GetFieldCount as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the number of fields contained in the document.

See also GetFieldCount function in DynaPDF manual.

DynaPDFMBS.GetFieldEx(index as Integer) as DynaPDFFieldExMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 10.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the most important properties of a field.
Example
dim 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))

dim 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
dim r as Integer = pdf.ImportPDFFile( 1, 1.0, 1.0)

// now check all fields
dim n as Integer = pdf.GetFieldCount
for i as Integer = 0 to n-1
dim f as DynaPDFFieldExMBS = pdf.GetFieldEx(i)

break // inspect in debugger
next

See dynapdf_help.pdf for more details.

Some examples using this method:

See also GetFieldEx function in DynaPDF manual.

DynaPDFMBS.GetFieldExpValCount(Field as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the number of values/export values which are defined for a field.

Some examples using this method:

See also GetFieldExpValCount function in DynaPDF manual.

DynaPDFMBS.GetFieldExpValue(Field as Integer) as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This function retrieves the export value(s) of a check box, list box, or combo box.

Some examples using this method:

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

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This function can be used to enumerate the choice values of a combo box, list box, or radio button.

See also GetFieldExpValueEx function in DynaPDF manual.

DynaPDFMBS.GetFieldFlags(Field as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the flags of a specific interactive form field.

See also GetFieldFlags function in DynaPDF manual.

DynaPDFMBS.GetFieldGroupType(Field as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the base type of a field group.

See also GetFieldGroupType function in DynaPDF manual.

DynaPDFMBS.GetFieldHighlightMode(Field as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the highlight mode of buttons, checkboxes, and signature fields.

See also GetFieldHighlightMode function in DynaPDF manual.

DynaPDFMBS.GetFieldIndex(Field as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the index or tab order of the field.

See also GetFieldIndex function in DynaPDF manual.

Previous items Next items

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


The biggest plugin in space...