Xojo Conferences
XDCMay2019MiamiUSA

Platforms to show: All Mac Windows Linux Cross-Platform

Previous items Next items

DynaPDFMBS.GetTemplWidth(Handle 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: A new function in dynapdf which is not documented.

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 8.0 Yes Yes Yes Yes No
Function: The function returns the text draw mode. Se draw modes are described in detail under SetTextDrawMode().

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.

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.

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.

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.

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 8.0 Yes Yes Yes Yes No
Function: The function retrieves the bounding rectangle to output formatted text.

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 8.0 Yes Yes Yes Yes No
Function: The function returns the current text rise used to output text.

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 8.0 Yes Yes Yes Yes No
Function: The function returns the current value of horizontal text scaling.

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 8.0 Yes Yes Yes Yes No
Function: The function calculates the width of a string.
Notes: The text parameter is converted to unicode.

See also:

See also GetTextWidth function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetTextWidthAnsi(aText as string) as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.3 Yes Yes Yes Yes No
Function: The function calculates the width of a string.
Notes: The text parameter is converted to ANSI.

See also GetTextWidth function in DynaPDF manual.

Feedback, Comments & Corrections

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

See also GetTransparentColor function in DynaPDF manual.

Feedback, Comments & Corrections

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

See also GetTrapped function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetURIAction(index as Integer) as DynaPDFURIActionMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 17.0 Yes Yes Yes Yes No
Function: Queries details for an URI action.
Notes: Index is from 0 to GetActionCount-1.

See also GetURIAction function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetUseExactPwd 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: 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.

Feedback, Comments & Corrections

DynaPDFMBS.GetUseGlobalImpFiles 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 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.

Feedback, Comments & Corrections

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

See also GetUserRights function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetUserUnit as single
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 11.3 Yes Yes Yes Yes No
Function: The function returns the user unit of the current open page.
Notes:
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.

See also GetUserUnit function in DynaPDF manual.

Feedback, Comments & Corrections

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

See also GetUseStdFonts function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetUsesTransparency(Page as Integer = -1) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 18.2 Yes Yes Yes Yes No
Function: Checks whether a page or the entire document uses transparency.
Notes:
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.

Feedback, Comments & Corrections

DynaPDFMBS.GetUseSystemFonts 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 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.

Feedback, Comments & Corrections

DynaPDFMBS.GetUseTransparency 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 property specifies whether images should get a transparent background.

See also GetUseTransparency function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetUseVisibleCoords 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 property specifies whether DynaPDF should consider the crop box to calculate to position of an object.

See also GetUseVisibleCoords function in DynaPDF manual.

Feedback, Comments & Corrections

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

See also GetViewerPreferences function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetViewport(Page as UInt32, index as Integer) as DynaPDFViewportMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 15.0 Yes Yes Yes Yes No
Function: Returns a viewport that is associated with a page.
Notes:
A viewport is a rectangular region of a page, that specifies usually a measure coordinate system or points in a geospatical coordinate system.
Since viewports might overlap, to determine the viewport to use for any point on a page, the viewports in the array shall be examined, starting with the last one and iterating in reverse, and the first one whose BBox entry contains the point shall be chosen.
To determine how viewports and measure dictionaries can be used, please have a look into the PDF Reference 2.0, ISO/DIS 32000-2, Section Measurement properties.
Returns nil on any error.

See also GetViewport function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetViewportCount(Page as UInt32) as Integer
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 number of viewports which are associated with a page.
Notes:
The first page has the page number 1.
If the function succeeds the return value is the number of viewports, a number greater or equal zero. If the function fails the return value is a negative error code. The function can only fail if the page number is invalid.

See also GetViewportCount function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetWMFDefExtent(byref width as Integer, byref height as Integer) 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 default size which is used to convert non portable WMF files to EMF.

See also GetWMFDefExtent function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetWMFPixelPerInch 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 pixels per inch of the y-axis which are used to convert portable WMF files to EMF.

See also GetWMFPixelPerInch function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.GetWordSpacing 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 current word spacing.

See also GetWordSpacing 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