Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

DynaPDF.GetFTextHeight

The function measures the height of a formatted text block.

Component Version macOS Windows Linux Server iOS SDK
DynaPDF 3.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "DynaPDF.GetFTextHeight"; PDF; Align; Text )   More

Parameters

Parameter Description Example
PDF The PDF reference returned from DynaPDF.New. $pdf
Align The text alignment. Can be left, center, right or justify. "left"
Text The text to write. "Hello World"

Result

Returns height or error message.

Description

The function measures the height of a formatted text block.
Before calling this function a font (see DynaPDF.SetFont) and the output rectangle must be set with the function DynaPDF.SetTextRect. The parameter Height of DynaPDF.SetTextRect should be set to -1 to avoid page breaks. Otherwise the height of the first text block is returned that fits into the given height of the rectangle.
The parameter AText must contain the same text (incl. format tags if any) as which should be printed later with DynaPDF.WriteFText.

See also DynaPDF.GetFTextHeightEx.

See also GetFTextHeight function in DynaPDF manual.

Examples

Place text centered on page:

# top down coordinates
Set Variable [ $r ; Value: MBS("DynaPDF.SetPageCoords"; $pdf; "TopDown") ]
# get the styled text to place
Set Variable [ $FileMakerText ; Value: Create Text::Text ]
# convert to Formatted Text for DynaPDF
Set Variable [ $FText ; Value: MBS( "DynaPDF.ConvertStyledText"; $pdf; $FileMakerText ) ]
# measure
Set Variable [ $Width ; Value: 400 ]
Set Variable [ $Height ; Value: MBS( "DynaPDF.GetFTextHeight"; $PDF; "left"; $FText ) ]
# lookup page size
Set Variable [ $PageWidth ; Value: MBS( "DynaPDF.GetPageWidth"; $PDF ) ]
Set Variable [ $PageHeight ; Value: MBS( "DynaPDF.GetPageHeight"; $PDF ) ]
# now center text on page
Set Variable [ $r ; Value: MBS("DynaPDF.SetTextRect"; $pdf; ($PageWidth - $Width) / 2; ($PageHeight - $Height) / 2; $Width; $Height) ]
Set Variable [ $r ; Value: MBS("DynaPDF.WriteFText"; $pdf; "left"; $FText) ]

See also

This function checks for a license.

Created 18th August 2014, last changed 3th January 2021


DynaPDF.GetEmbeddedFilesAsJSON - DynaPDF.GetFTextHeightEx