Platforms to show: All Mac Windows Linux Cross-Platform

Back to DynaPDFMBS class.

Previous items Next items

DynaPDFMBS.GetPageMode 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 page mode that is used when opening the document with Adobe's Acrobat.

See also GetPageMode function in DynaPDF manual.

DynaPDFMBS.GetPageNum 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 page number of the currently open page.

See also GetPageNum function in DynaPDF manual.

DynaPDFMBS.GetPageText(stack as DynaPDFStackMBS) as boolean

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

InitStack must be called before you use GetPageText.


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

Some examples using this method:

See also GetPageText function in DynaPDF manual.

DynaPDFMBS.GetPDFVersion 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 minor version of the output PDF file as Integer value.

Zero stand for PDF 1.0, one for PDF 1.1 and so on.

See also GetPDFVersion function in DynaPDF manual.

DynaPDFMBS.GetPDFVersionEx as DynaPDFVersionInfoMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 21.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Retrieves the major and minor version of the PDF document as well as the underlying PDF standard, if any.
Example
Var d As New DynaPDFMBS
Var v As DynaPDFVersionInfoMBS = d.GetPDFVersionEx

Break // check in debugger

Result includes:
MajorPDF major version, e.g. 1
MinorPDF minor version, e.g. 7
MainVerSet only if the file conforms to a specific PDF standard, e.g. "PDF/X // 1a:2003", "PDF/A 3b", and so on.
SubVere.g. "ZUGFeRD 2.0", "Factur-X", and so on

Returns nil in case of an error.

See also GetPDFVersionEx function in DynaPDF manual.

DynaPDFMBS.GetPrintSettings as DynaPDFPrintSettingsMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.7 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Queries the print settings for the current document.

This is a PDF 1.7 extension.

See also GetPrintSettings function in DynaPDF manual.

DynaPDFMBS.GetResetAction(Handle as UInt32) as DynaPDFResetFormActionMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 15.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the properties of a Reset Form Action.

See also GetResetAction function in DynaPDF manual.

DynaPDFMBS.GetResolution 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 resolution in DPI (Dots per Inch), in which images are stored by DynaPDF.

See also GetResolution function in DynaPDF manual.

DynaPDFMBS.GetSaveNewImageFormat as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
If false, images are not downscaled if necessary.

See also GetSaveNewImageFormat function in DynaPDF manual.

DynaPDFMBS.GetSeparationInfo(byref Colorant as string, byref ColorSpace as Integer) 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 returns the separation info stored in the current open page.

See also GetSeparationInfo function in DynaPDF manual.

DynaPDFMBS.GetStrokeColor 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 stroke color.

See also GetStrokeColor function in DynaPDF manual.

DynaPDFMBS.GetSubmitAction(Handle as UInt32) as DynaPDFSubmitFormActionMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 15.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the properties of a Submit Form Action.

Returns nil in case of an error.

See also GetSubmitAction function in DynaPDF manual.

DynaPDFMBS.GetSysFontInfo as DynaPDFSysFontMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 15.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Returns the most important properties of a system font.
Example
// list all fonts
Var d as new DynaPDFMBS

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

f = f.NextFont
wend

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:

Some examples using this method:

See also GetSysFontInfo function in DynaPDF manual.

DynaPDFMBS.GetSysFontInfo(PostscriptName as String) as DynaPDFSysFontMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 17.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Queries system font with given postscript name.
Example
Var d as new DynaPDFMBS

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

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

Break // see in debugger

Returns nil if font is not found.

See also:

See also GetSysFontInfo function in DynaPDF manual.

DynaPDFMBS.GetSysFontInfos as DynaPDFSysFontMBS()

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 16.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Returns an array with the most important properties of system fonts.
Example
Var pdf as new MyDynaPDFMBS

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

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

Var name as string = f.FamilyName

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

else
// Everything is ok
end if

next

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:

Some examples using this method:

DynaPDFMBS.GetSysFontInfos(Name as String) as DynaPDFSysFontMBS()

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 17.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Returns an array with the most important properties of system fonts.
Example
Var d as new DynaPDFMBS

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

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

Break // see in debugger

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:

DynaPDFMBS.GetTabLen 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 tabulator length in spaces that is used to emulate tabulators during text formatting (see WriteFText() for further information).

See also GetTabLen function in DynaPDF manual.

DynaPDFMBS.GetTemplCount 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 templates used by a page.

Some examples using this method:

See also GetTemplCount function in DynaPDF manual.

DynaPDFMBS.GetTemplHandle 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 handle of the current open template or a negative error code on failure.

Some examples using this method:

See also GetTemplHandle function in DynaPDF manual.

DynaPDFMBS.GetTemplHeight(Handle 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 height of a template.

Some examples using this method:

See also GetTemplHeight function in DynaPDF manual.

DynaPDFMBS.GetTemplWidth(Handle 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
Returns the width of a template. The parameter Handle must be a valid template handle.

If the function succeeds the return value is the width of the template. If the function fails the return value is a negative error code.

Some examples using this method:

See also GetTemplWidth function in DynaPDF manual.

DynaPDFMBS.GetTextBBox(Text as String) as DynaPDFRectMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 24.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Calculates the exact bounding box of a text string.
Example
Var pdf As New DynaPDFMBS

Call pdf.CreateNewPDF(Nil)
Call pdf.Append

Var Text As String = "Hello World"
Var rect As DynaPDFRectMBS = pdf.GetTextBBox(Text)

MessageBox rect.Left.ToString+"/"+rect.Top.ToString+" "+rect.Right.ToString+"/"+rect.Bottom.ToString

The bounding box is computed from the outline of every glyph. However, the function does not consider the current text draw mode or bold or italic font style emulation.
Returns nil in case of an error.

See also GetTextBBox function in DynaPDF manual.

DynaPDFMBS.GetTextDrawMode 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 text draw mode. Se draw modes are described in detail under SetTextDrawMode().

See also GetTextDrawMode function in DynaPDF manual.

DynaPDFMBS.GetTextFieldValue(Field as Integer, byref Value as string, byref DefValue as string) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Queries the text of a field.

The strings may be ANSI or Unicode encoded.

See also GetTextFieldValue function in DynaPDF manual.

DynaPDFMBS.GetTextHeight(Align as Integer, aText as string) as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 13.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function measures the height of a formatted text block.
Example
Var pdf as DynaPDFMBS // your PDF instance

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

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

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

// see different heights in debugger.

GetTextHeight does escape backslashes so no formatting commands are taken from the string.
The text parameter is converted to unicode.

DynaPDFMBS.GetTextHeightAnsi(Align as Integer, aText as string) as Double   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 13.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This item is deprecated and should no longer be used. You can use the non ANSI function instead.
The function measures the height of a formatted text block.

GetTextHeightAnsi does escape backslashes so no formatting commands are taken from the string.

The text parameter is converted to ANSI.

DynaPDFMBS.GetTextHeightEx(Width as Double, Align as Integer, aText as string) as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 13.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function measures the height of a formatted text block.
Example
Var pdf as new MyDynaPDFMBS

call pdf.CreateNewPDF nil
call pdf.Append

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

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

MsgBox "height: "+str(h)

call pdf.EndPage
call pdf.CloseFile

GetTextHeightEx does escape backslashes so no formatting commands are taken from the string.
The text parameter is converted to unicode.

Some examples using this method:

DynaPDFMBS.GetTextHeightExAnsi(Width as Double, Align as Integer, aText as string) as Double   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 13.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This item is deprecated and should no longer be used. You can use the non ANSI function instead.
The function measures the height of a formatted text block.

GetTextHeightExAnsi does escape backslashes so no formatting commands are taken from the string.
The text parameter is converted to ANSI.

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 iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function retrieves the bounding rectangle to output formatted text.

Some examples using this method:

See also GetTextRect function in DynaPDF manual.

DynaPDFMBS.GetTextRise 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 text rise used to output text.

See also GetTextRise function in DynaPDF manual.

DynaPDFMBS.GetTextScaling 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 value of horizontal text scaling.

See also GetTextScaling function in DynaPDF manual.

DynaPDFMBS.GetTextWidthAnsi(aText as string) as Double   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This item is deprecated and should no longer be used. You can use the non ANSI function instead.
The function calculates the width of a string.

The text parameter is converted to ANSI.

See also GetTextWidth function in DynaPDF manual.

DynaPDFMBS.GetTransparentColor 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 transparent color value that is used for newly inserted images.

See also GetTransparentColor function in DynaPDF manual.

DynaPDFMBS.GetTrapped 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 returns the trapped key of the document.

See also GetTrapped function in DynaPDF manual.

DynaPDFMBS.GetTypoLeading as double

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 21.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Returns the typographic leading or line height of a font.

This is sTypoAscender – sTypoDescender + sTypoLineGap of the OS/2 table of TrueType and OpenType fonts. The value is scaled to the current font size. Type1 fonts do not support these metrics.

The function can be called after a font was activated in the graphics state, e.g. with SetFont(), SetFontEx(), SetCIDFont(), or ChangeFont().

If typographic metrics are not available the return value is Ascent – Descent. If the value is smaller than the font size then the font size is returned.

If the function succeeds the return value is the typographic leading of the active font, this is a value greater zero. If the function fails the return value is a negative error code.

Some examples using this method:

See also GetTypoLeading function in DynaPDF manual.

DynaPDFMBS.GetURIAction(index as Integer) as DynaPDFURIActionMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 17.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Queries details for an URI action.

Index is from 0 to GetActionCount-1.

See also GetURIAction function in DynaPDF manual.

DynaPDFMBS.GetUseExactPwd as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
If the property UseExactPwd is false, an encrypted PDF file can always be decrypted, if either the open or owner password in the file is an empty string.

See also GetUseExactPwd function in DynaPDF manual.

DynaPDFMBS.GetUseGlobalImpFiles as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The property specifies whether import files should be loaded permanent into memory, e.g. to enable splitting of large PDF files.

See also GetUseGlobalImpFiles function in DynaPDF manual.

DynaPDFMBS.GetUserRights 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 encryption flags of an imported PDF file or -1 if the imported PDF file was not encrypted.

See also GetUserRights function in DynaPDF manual.

DynaPDFMBS.GetUserUnit as single

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 11.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function returns the user unit of the current open page.

A user unit acts like a scaling factor. The page format and all page coordinates are multiplied with this factor in a viewer application. The default size of a PDF unit is 1/72 inch and the default user unit is 1.0. User units can be useful if the page format would be too large to be expressed in standard PDF units. The largest page format in PDF is limited to 14400 units or 200 inches. This limit can be extended with the user unit.
The largest value that is supported is 75.0 which results in a maximum page format of 15,000 x 15,000 inches or 1,800,000 units.

Use EditPage() to open a page if needed to inspect.

See also GetUserUnit function in DynaPDF manual.

DynaPDFMBS.GetUseStdFonts 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 returns 1 (true) if the 14 standard fonts are enabled.

See also GetUseStdFonts function in DynaPDF manual.

DynaPDFMBS.GetUsesTransparency(Page as Integer = -1) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Checks whether a page or the entire document uses transparency.

This is no quick check as GetDocUsesTransparency() applies. The function parses the page or pages to determine whether transparent objects are relly used.
To check whether a specific page uses transparency set the parameter PageNum to the wished page number. The first page is denoted by 1. To check the entire PDF file set PageNum to -1.

The return value is a bit mask on success (a positive integer value), or a negative error code on failure.
The following flags are defined

  • 0: The page or document uses no transparency.
  • 1: The content stream of a page contains transparent objects.
  • 2: A page defines the blending color space (Group dictionary).
  • 4: A page contains transparent annotations or form fields.
The above values can occur in any combination. To check whether a specific flag was set use a binary and operator: BitwiseAnd(value, flag)

See also GetUsesTransparency function in DynaPDF manual.

DynaPDFMBS.GetUseSystemFonts as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The property specifies whether the %Windows%/Fonts directory should be added automatically to the list of available font search paths.

See also GetUseSystemFonts function in DynaPDF manual.

DynaPDFMBS.GetUseTransparency as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The property specifies whether images should get a transparent background.

See also GetUseTransparency function in DynaPDF manual.

DynaPDFMBS.GetUseVisibleCoords as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The property specifies whether DynaPDF should consider the crop box to calculate to position of an object.

See also GetUseVisibleCoords function in DynaPDF manual.

DynaPDFMBS.GetViewerPreferences(byref Preference as Integer, byref AddVal as Integer) 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 viewer preferences specified in the document.

See also GetViewerPreferences 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...