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.GetPageNum 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 page number of the currently open page.
Notes: Also check the dynapdf manual on the pdfGetPageNum function.

See also GetPageNum function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetPageText(stack as DynaPDFStackMBS) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.7 Yes Yes Yes Yes No
Function: This function can be used to extract the text of a page or template, or to find a specific text that should be replaced or deleted with the function ReplacePageText() or ReplacePageTextEx().
Notes:
InitStack must be called before you use GetPageText.

Also check the dynapdf manual on the pdfGetPageText function.

If you have problems with asian characters, please make sure you use SetCMapDir and load the CMAPs.
Requires DynaPDF Pro license.

See also GetPageText function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetPageWidth 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 width of the currently open page.
Notes: Also check the dynapdf manual on the pdfGetPageWidth function.

See also GetPageWidth function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetPDFVersion 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 minor version of the output PDF file as Integer value.
Notes:
Zero stand for PDF 1.0, one for PDF 1.1 and so on.
Also check the dynapdf manual on the pdfGetPDFVersion function.

See also GetPDFVersion function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetPrintSettings as DynapdfPrintSettingsMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.7 Yes Yes Yes Yes No
Function: Queries the print settings for the current document.
Notes: This is a PDF 1.7 extension.

See also GetPrintSettings function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetResetAction(Handle as UInt32) as DynaPDFResetFormActionMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 15.3 Yes Yes Yes Yes No
Function: The function returns the properties of a Reset Form Action.

See also GetResetAction function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetResolution 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 resolution in DPI (Dots per Inch), in which images are stored by DynaPDF.
Notes: Also check the dynapdf manual on the pdfGetResolution function.

See also GetResolution function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetSaveNewImageFormat as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: If false, images are not downscaled if necessary.
Notes: Also check the dynapdf manual on the pdfGetSaveNewImageFormat function.

See also GetSaveNewImageFormat function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetSeparationInfo(byref Colorant as string, byref ColorSpace as Integer) as boolean
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 separation info stored in the current open page.
Notes: Also check the dynapdf manual on the pdfGetSeparationInfo function.

See also GetSeparationInfo function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetStrokeColor 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 current stroke color.
Notes: Also check the dynapdf manual on the pdfGetStrokeColor function.

See also GetStrokeColor function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetSubmitAction(Handle as UInt32) as DynaPDFSubmitFormActionMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 15.3 Yes Yes Yes Yes No
Function: The function returns the properties of a Submit Form Action.
Notes: Returns nil in case of an error.

See also GetSubmitAction function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetSysFontInfo as DynaPDFSysFontMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 15.0 Yes Yes Yes Yes No
Function: Returns the most important properties of a system font.
Example:
// list all fonts
dim d as new DynaPDFMBS

dim f as DynaPDFSysFontMBS = d.GetSysFontInfo
while f<>nil
Listbox1.AddRow f.FamilyName

f = f.NextFont
wend
Notes:
The function returns the fonts in the current font search order. That means if the search order is {fbtTrueType, fbtOpenType, fbtType1, fbtStdFont}, for example, then the function returns first all TrueType fonts sorted in ascending order, then all OpenType fonts, and so on.
Since standard fonts are no system fonts, these fonts are not returned.

See also:

See also GetSysFontInfo function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetSysFontInfo(PostscriptName as String) as DynaPDFSysFontMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 17.2 Yes Yes Yes Yes No
Function: Queries system font with given postscript name.
Example:
dim d as new DynaPDFMBS

// find one font with postscript name
dim font as DynaPDFSysFontMBS = d.GetSysFontInfo("Verdana-BoldItalic")

// find all with family name
dim fonts() as DynaPDFSysFontMBS = d.GetSysFontInfos("Verdana")

Break // see in debugger
Notes: Returns nil if font is not found.

See also:

See also GetSysFontInfo function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetSysFontInfos as DynaPDFSysFontMBS()
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 16.1 Yes Yes Yes Yes No
Function: Returns an array with the most important properties of system fonts.
Example:
dim pdf as new MyDynaPDFMBS

// get all fonts
dim fonts() as DynaPDFSysFontMBS = pdf.GetSysFontInfos

// add one row for each font
for each f as DynaPDFSysFontMBS in fonts

dim name as string = f.FamilyName

if f.BaseType = pdf.kfbtOpenType and f.CIDOrdering = "" then
// This font cannot be used with Unicode

else
// Anything is ok
end if

next
Notes:
The function returns the fonts in the current font search order. That means if the search order is {fbtTrueType, fbtOpenType, fbtType1, fbtStdFont}, for example, then the function returns first all TrueType fonts sorted in ascending order, then all OpenType fonts, and so on.
Since standard fonts are no system fonts, these fonts are not returned.

See also:

Feedback, Comments & Corrections

DynaPDFMBS.GetSysFontInfos(Name as String) as DynaPDFSysFontMBS()
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 17.2 Yes Yes Yes Yes No
Function: Returns an array with the most important properties of system fonts.
Example:
dim d as new DynaPDFMBS

// find one font with postscript name
dim font as DynaPDFSysFontMBS = d.GetSysFontInfo("Verdana-BoldItalic")

// find all with family name
dim fonts() as DynaPDFSysFontMBS = d.GetSysFontInfos("Verdana")

Break // see in debugger
Notes:
Matchs fonts by family name, full name or Postscript name.

The function returns the fonts in the current font search order. That means if the search order is {fbtTrueType, fbtOpenType, fbtType1, fbtStdFont}, for example, then the function returns first all TrueType fonts sorted in ascending order, then all OpenType fonts, and so on.
Since standard fonts are no system fonts, these fonts are not returned.

See also:

Feedback, Comments & Corrections

DynaPDFMBS.GetTabLen 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 tabulator length in spaces that is used to emulate tabulators during text formatting (see WriteFText() for further information).
Notes: Also check the dynapdf manual on the pdfGetTabLen function.

See also GetTabLen function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetTemplCount 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 templates used by a page.
Notes: Also check the dynapdf manual on the pdfGetTemplCount function.

See also GetTemplCount function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetTemplHandle 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 current open template or a negative error code on failure.
Notes: Also check the dynapdf manual on the pdfGetTemplHandle function.

See also GetTemplHandle function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetTemplHeight(Handle as Integer) 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 height of a template.
Notes: Also check the dynapdf manual on the pdfGetTemplHeight function.

See also GetTemplHeight function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetTemplWidth(Handle as Integer) 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: A new function in dynapdf which is not documented.
Notes: Also check the dynapdf manual on the pdfGetTemplWidth function.

See also GetTemplWidth function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetTextDrawMode 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 text draw mode. Se draw modes are described in detail under SetTextDrawMode().
Notes: Also check the dynapdf manual on the pdfGetTextDrawMode function.

See also GetTextDrawMode function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetTextFieldValue(Field as Integer, byref Value as string, byref DefValue as string) as Boolean
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 text of a field.
Notes: The strings may be ANSI or Unicode encoded.

See also GetTextFieldValue function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetTextHeight(Align as Integer, aText as string) as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 13.3 Yes Yes Yes Yes No
Function: The function measures the height of a formatted text block.
Example:
dim pdf as DynaPDFMBS // your PDF instance

dim text as string = "Hello \ul#World"

dim h1 as Integer = pdf.GetTextHeight(pdf.ktaLeft, text)
dim h2 as Integer = pdf.GetFTextHeight(pdf.ktaLeft, text)

dim h3 as Integer = pdf.GetTextHeightEx(150, pdf.ktaLeft, text)
dim h4 as Integer = pdf.GetFTextHeightEx(150, pdf.ktaLeft, text)

// see different heights in debugger.
Notes:
GetTextHeight does escape backslashes so no formatting commands are taken from the string.
The text parameter is converted to unicode.
Also check the dynapdf manual on the pdfGetFTextHeightW function.

Feedback, Comments & Corrections

DynaPDFMBS.GetTextHeightAnsi(Align as Integer, aText as string) as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 13.3 Yes Yes Yes Yes No
Function: The function measures the height of a formatted text block.
Notes:
GetTextHeightAnsi does escape backslashes so no formatting commands are taken from the string.

The text parameter is converted to ANSI.
Also check the dynapdf manual on the pdfGetFTextHeightA function.

Feedback, Comments & Corrections

DynaPDFMBS.GetTextHeightEx(Width as Double, Align as Integer, aText as string) as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 13.3 Yes Yes Yes Yes No
Function: The function measures the height of a formatted text block.
Example:
dim pdf as new MyDynapdfMBS

call pdf.CreateNewPDF nil
call pdf.Append

call pdf.SetFont("Helvetica", pdf.kfsnone, 12, true, pdf.kcpUnicode)

dim h as Double = pdf.GetTextHeightEx(100, pdf.ktaLeft, "Hello World. Just a test string.")

MsgBox "height: "+str(h)

call pdf.EndPage
call pdf.CloseFile
Notes:
GetTextHeightEx does escape backslashes so no formatting commands are taken from the string.
The text parameter is converted to unicode.
Also check the dynapdf manual on the pdfGetFTextHeightExW function.

Feedback, Comments & Corrections

DynaPDFMBS.GetTextHeightExAnsi(Width as Double, Align as Integer, aText as string) as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 13.3 Yes Yes Yes Yes No
Function: The function measures the height of a formatted text block.
Notes:
GetTextHeightExAnsi does escape backslashes so no formatting commands are taken from the string.
The text parameter is converted to ANSI.
Also check the dynapdf manual on the pdfGetFTextHeightExA function.

Feedback, Comments & Corrections

DynaPDFMBS.GetTextRect(byref PosX as Double, byref PosY as Double, byref Width as Double, byref Height as Double) as Boolean
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 retrieves the bounding rectangle to output formatted text.
Notes: Also check the dynapdf manual on the pdfGetTextRect function.

See also GetTextRect function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetTextRise 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 text rise used to output text.
Notes: Also check the dynapdf manual on the pdfGetTextRise function.

See also GetTextRise function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetTextScaling 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 value of horizontal text scaling.
Notes: Also check the dynapdf manual on the pdfGetTextScaling function.

See also GetTextScaling function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetTextWidth(aText as string) 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 calculates the width of a string.
Notes:
The text parameter is converted to unicode.
Also check the dynapdf manual on the pdfGetTextWidthExW function.

See also GetTextWidth 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 tutorial videos