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.GetColorSpace as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 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

DynaPDFMBS.GetCompressionFilter as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function returns the standard compression filter for images.
Notes: Also check the dynapdf manual on the pdfGetCompressionFilter function.

See also GetCompressionFilter function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetCompressionLevel as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function returns the active compression level.
Notes: Also check the dynapdf manual on the pdfGetCompressionLevel function.

See also GetCompressionLevel function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetContent as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: This function returns a pointer to the content stream of the currently open page or template.
Notes:
The result string has no encoding set.
Also check the dynapdf manual on the pdfGetContent function.

See also GetContent function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetDefBitsPerPixel as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function returns default color depth in bits per pixel, which determines whether images should be down sampled.
Notes: Also check the dynapdf manual on the pdfGetDefBitsPerPixel function.

See also GetDefBitsPerPixel function in DynaPDF manual.

Feedback, Comments & Corrections

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

See also GetDescent function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetDocInfo(dinfo as Integer) as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function retrieves a document info entry as Unicode string.
Notes:
Also check the dynapdf manual on the pdfGetDocInfo function.
The result is an unicode string.

See also GetDocInfo function in DynaPDF manual.

Feedback, Comments & Corrections

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

See also GetDocInfoCount function in DynaPDF manual.

Feedback, Comments & Corrections

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 Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function returns a document info entry.
Notes:
Also check the dynapdf manual on the pdfGetDocInfoEx function.
Key is an ascii string and value an unicode string.

See also GetDocInfoEx function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetDocumentColorSpaces as DynaPDFColorSpaceMBS()
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 16.0 Yes Yes Yes Yes No
Function: Queries Colorspace objects for all colorspaces in the current working document.

Feedback, Comments & Corrections

DynaPDFMBS.GetDocUsesTransparency(Flags as UInt32) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 11.1 Yes Yes Yes Yes No
Function: Whether this document uses transparency.
Notes: Also check the dynapdf manual on the pdfGetDocUsesTransparency function.

See also GetDocUsesTransparency function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetDrawDirection as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function returns the actual draw direction for closed vector graphics such as rectangles, circles, ellipses and so on.
Notes: Also check the dynapdf manual on the pdfGetDrawDirection function.

See also GetDrawDirection function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetEmbeddedFile(Handle as Integer, byref FileSpec as dynapdfFileSpecMBS, Decompress as boolean) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: 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
Notes: Also check the dynapdf manual on the pdfGetEmbeddedFile function.

See also GetEmbeddedFile function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetEmbeddedFileCount as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: 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
Notes: Also check the dynapdf manual on the pdfGetEmbeddedFileCount function.

See also GetEmbeddedFileCount function in DynaPDF manual.

Feedback, Comments & Corrections

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

See also GetEMFPatternDistance function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetErrLogMessage(index as Integer) as DynaPDFErrorMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 11.1 Yes Yes Yes Yes No
Function: Querties the error message details for the given index.
Notes: Index from 0 to GetErrLogMessageCount-1.

See also GetErrLogMessage function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetErrLogMessageCount as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 11.1 Yes Yes Yes Yes No
Function: Returns the number of error log messages.

See also GetErrLogMessageCount function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetErrorMessage as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function returns the last error message as a string, or "" if no error occurred.
Notes: Also check the dynapdf manual on the pdfGetErrorMessage function.

See also GetErrorMessage function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetErrorMode as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function returns the current error mode.
Notes: Also check the dynapdf manual on the pdfGetErrorMode function.

See also GetErrorMode function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetField(index as Integer) as DynaPDFFieldMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function retrieves the most important properties of a field.
This item is deprecated and should no longer be used. You can use GetFieldEx instead.
Notes: Also check the dynapdf manual on the pdfGetField function.

Feedback, Comments & Corrections

DynaPDFMBS.GetFieldBackColor as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function returns the default background color used for newly created interactive form fields.
Notes: Also check the dynapdf manual on the pdfGetFieldBackColor function.

See also GetFieldBackColor function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetFieldBorderColor as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function returns the default border color used for newly created interactive form fields.
Notes: Also check the dynapdf manual on the pdfGetFieldBorderColor function.

See also GetFieldBorderColor function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetFieldBorderStyle(Field as Integer) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function returns the border style of a specific form field.
Notes: Also check the dynapdf manual on the pdfGetFieldBorderStyle function.

See also GetFieldBorderStyle function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetFieldBorderWidth(aField as Integer) as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function returns the line width of the border of a field.
Notes: Also check the dynapdf manual on the pdfGetFieldBorderWidth function.

See also GetFieldBorderWidth function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetFieldChoiceValue(Field as Integer, ValIndex as Integer) as DynaPDFChoiceValueMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 10.5 Yes Yes Yes Yes No
Function: Queries the choice values for this field.

See also GetFieldChoiceValue function in DynaPDF manual.

Feedback, Comments & Corrections

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 Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function retrieves a specific color of an interactive form field.
Notes: Also check the dynapdf manual on the pdfGetFieldColor function.

See also GetFieldColor function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetFieldCount as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function returns the number of fields contained in the document.
Notes: Also check the dynapdf manual on the pdfGetFieldCount function.

See also GetFieldCount function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetFieldEx(index as Integer) as DynaPDFFieldExMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 10.1 Yes Yes Yes Yes No
Function: 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
Notes: See dynapdf_help.pdf for more details.

See also GetFieldEx 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 Xojo Plugins