GetTextHeight(String,Single) Method

In This Topic

Calculates the height of the font you have specified, expressed in the current units used in the loaded PDF document, without respecting the font boundary box.

You can use the GetMeasurementUnit method to determine the currently defined units and you can also use the SetMeasurementUnit method to reset the units according to your preference.

Syntax

Visual Basic
C#
Delphi
JScript
Managed Extensions for C++
C++/CLI

'Declaration
 
Public Overloads Function GetTextHeight( _
   ByVal FontResName As String, _
   ByVal TextSize As Single _
) As Single

public float GetTextHeight( 
   string FontResName,
   float TextSize
)

public function GetTextHeight( 
    FontResName: String;
    TextSize: Single
): Single;

public function GetTextHeight( 
   FontResName : String,
   TextSize : float
) : float;

public: float GetTextHeight( 
   string* FontResName,
   float TextSize
)

public:
float GetTextHeight( 
   String^ FontResName,
   float TextSize
)

Parameters

FontResName: The resource name of the font you prefer.
You can easily obtain this name using the AddStandardFont method or any of the AddTrueTypeFont...() methods. For further assistance, please see the section Fonts of the GdPicturePDF class in the Reference Guide.
TextSize: The size of the text (the font size actually), in points.

Return Value

The height of the specified font, expressed in the current units specified by the SetMeasurementUnit method, not respecting the font boundary box.

The GetStat method can be subsequently used to determine if this method has been successful.

Remarks

This method is only allowed for use with non-encrypted documents.

It is recommend to use the GetStat method to identify the specific reason for the method's failure, if any. For example, if the currently loaded PDF document does not contain any page, this method will fail.

Just to remind you that 1 point is equivalent to 1/72 of an inch.

Example

How to determine the height of the standard Times-Roman font.

VB.NET
C#

Dim caption As String = "Example: GetTextHeight"
Dim gdpicturePDF As New GdPicturePDF()
Dim status As GdPictureStatus = gdpicturePDF.LoadFromFile("test.pdf", False)
If status = GdPictureStatus.OK Then
    gdpicturePDF.SetMeasurementUnit(PdfMeasurementUnit.PdfMeasurementUnitCentimeter)
    status = gdpicturePDF.GetStat()
    If status = GdPictureStatus.OK Then
        Dim fontName As String = gdpicturePDF.AddStandardFont(PdfStandardFont.PdfStandardFontTimesRoman)
        If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
            Dim height As Single = gdpicturePDF.GetTextHeight(fontName, 20)
            status = gdpicturePDF.GetStat()
            If status = GdPictureStatus.OK Then
                MessageBox.Show("The height of the Times-Roman font with the size 20 is " + height.ToString() + " centimeters.", caption)
            Else
                MessageBox.Show("The GetTextHeight() method has failed with the status: " + status.ToString(), caption)
            End If
        Else
            MessageBox.Show("The AddStandardFont() method has failed with the status: " + status.ToString(), caption)
        End If
    Else
        MessageBox.Show("Units can't be set correctly.", caption)
    End If
Else
    MessageBox.Show("The file can't be loaded.", caption)
End If
gdpicturePDF.Dispose()

string caption = "Example: GetTextHeight";
GdPicturePDF gdpicturePDF = new GdPicturePDF();
GdPictureStatus status = gdpicturePDF.LoadFromFile("test.pdf", false);
if (status == GdPictureStatus.OK)
{
    gdpicturePDF.SetMeasurementUnit(PdfMeasurementUnit.PdfMeasurementUnitCentimeter);
    status = gdpicturePDF.GetStat();
    if (status == GdPictureStatus.OK)
    {
        string fontName = gdpicturePDF.AddStandardFont(PdfStandardFont.PdfStandardFontTimesRoman);
        if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
        {
            float height = gdpicturePDF.GetTextHeight(fontName, 20);
            status = gdpicturePDF.GetStat();
            if (status == GdPictureStatus.OK)
                MessageBox.Show("The height of the Times-Roman font with the size 20 is " + height.ToString() + " centimeters.", caption);
            else
                MessageBox.Show("The GetTextHeight() method has failed with the status: " + status.ToString(), caption);
        }
        else
            MessageBox.Show("The AddStandardFont() method has failed with the status: " + status.ToString(), caption);
    }
    else
        MessageBox.Show("Units can't be set correctly.", caption);
}
else
    MessageBox.Show("The file can't be loaded.", caption);
gdpicturePDF.Dispose();

Reference

GdPicturePDF Class
GdPicturePDF Members
Overload List
GetTextWidth Method
DrawText Method
AddStandardFont Method
AddTrueTypeFont Method
SetMeasurementUnit Method
SetOrigin Method