SetTextRise Method (GdPicturePDF)

In This Topic

Set the text rise to be used when drawing text onto the currently loaded PDF document. The text rise parameter specifies the distance, in unscaled text space units (points), to move the baseline up (positive values) or down (negative values) from its default location. Adjustments to the baseline are useful for drawing superscripts or subscripts. The initial value (the default location of the baseline) is set to 0.

The text rise parameter is one of the text state parameters, that only affect text. The text state parameters are initialized to their default values at the beginning of each page (see PDF Reference, Section "Text State Parameters and Operators").

Syntax

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

'Declaration

 

Public Function SetTextRise( _

   ByVal Rise As Single _

) As GdPictureStatus

public GdPictureStatus SetTextRise( 

   float Rise

)

public function SetTextRise( 

    Rise: Single

): GdPictureStatus;

public function SetTextRise( 

   Rise : float

) : GdPictureStatus;

public: GdPictureStatus SetTextRise( 

   float Rise

)

public:

GdPictureStatus SetTextRise( 

   float Rise

)

Parameters

Rise: The new value for the text rise. Initial value is 0.
This value is defined for use with any font you choose.

Return Value

A member of the GdPictureStatus enumeration. If the method has been successfully followed, then the return value is GdPictureStatus.OK.

We strongly recommend always checking this status first.

Remarks

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

The text rise always applies to the vertical coordinate in text space, regardless of the writing mode.

As being noticed above, be aware that the text state parameters are initialized to their default values at the beginning of each page.

Example

How to use the text rise parameter to draw superscripted and subscripted text within the PDF document.

VB.NET
C#

Dim caption As String = "Example: SetTextRise"

Dim gdpicturePDF As New GdPicturePDF()

Dim status As GdPictureStatus = gdpicturePDF.NewPDF()

If status = GdPictureStatus.OK Then

    If gdpicturePDF.NewPage(PdfPageSizes.PdfPageSizeA4) = GdPictureStatus.OK Then

        Dim fontName As String = gdpicturePDF.AddStandardFont(PdfStandardFont.PdfStandardFontHelvetica)

        If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

            Dim width As Single = gdpicturePDF.GetTextWidth(fontName, 20, "GdPicture.NET")

            If (gdpicturePDF.GetStat() = GdPictureStatus.OK) AndAlso

               (gdpicturePDF.SetTextSize(20) = GdPictureStatus.OK) AndAlso

               (gdpicturePDF.DrawText(fontName, 100, 500, "GdPicture.NET") = GdPictureStatus.OK) AndAlso

               (gdpicturePDF.SetTextSize(15) = GdPictureStatus.OK) AndAlso

               (gdpicturePDF.SetTextRise(20 * 2 / 3) = GdPictureStatus.OK) AndAlso

               (gdpicturePDF.DrawText(fontName, 100 + width, 500, "superscripted") = GdPictureStatus.OK) AndAlso

               (gdpicturePDF.SetTextRise(-20 * 1 / 3) = GdPictureStatus.OK) AndAlso

               (gdpicturePDF.DrawText(fontName, 100 + width, 500, "subscripted") = GdPictureStatus.OK) AndAlso

               (gdpicturePDF.SetTextRise(0) = GdPictureStatus.OK) Then 'Resetting to the initial value.

                status = gdpicturePDF.SaveToFile("test_SetTextRise.pdf")

                If status = GdPictureStatus.OK Then

                    MessageBox.Show("The text has been successfully drawn and the file has been saved.", caption)

                Else

                    MessageBox.Show("The text has been successfully drawn," + vbCrLf + "but the file can't be saved. Status: " + status.ToString(), caption)

                End If

            Else

                MessageBox.Show("The example has not been followed successfully." + vbCrLf + "The last known status is " + gdpicturePDF.GetStat().ToString(), caption)

            End If

        Else

            MessageBox.Show("The AddStandardFont() method has failed with the status: " + status.ToString(), caption)

        End If

    Else

        MessageBox.Show("The NewPage() method has failed with the status: " + status.ToString(), caption)

    End If

Else

    MessageBox.Show("The NewPDF() method has failed with the status: " + status.ToString(), caption)

End If

gdpicturePDF.Dispose()

string caption = "Example: SetTextRise";

GdPicturePDF gdpicturePDF = new GdPicturePDF();

GdPictureStatus status = gdpicturePDF.NewPDF();

if (status == GdPictureStatus.OK)

{

    if (gdpicturePDF.NewPage(PdfPageSizes.PdfPageSizeA4) == GdPictureStatus.OK)

    {

        string fontName = gdpicturePDF.AddStandardFont(PdfStandardFont.PdfStandardFontHelvetica);

        if (gdpicturePDF.GetStat() == GdPictureStatus.OK)

        {

            float width = gdpicturePDF.GetTextWidth(fontName, 20, "GdPicture.NET");

            if ((gdpicturePDF.GetStat() == GdPictureStatus.OK) &&

                (gdpicturePDF.SetTextSize(20) == GdPictureStatus.OK) &&

                (gdpicturePDF.DrawText(fontName, 100, 500, "GdPicture.NET") == GdPictureStatus.OK) &&

                (gdpicturePDF.SetTextSize(15) == GdPictureStatus.OK) &&

                (gdpicturePDF.SetTextRise(20 * 2/3) == GdPictureStatus.OK) &&

                (gdpicturePDF.DrawText(fontName, 100 + width, 500, "superscripted") == GdPictureStatus.OK) &&

                (gdpicturePDF.SetTextRise(-20 * 1/3) == GdPictureStatus.OK) &&

                (gdpicturePDF.DrawText(fontName, 100 + width, 500, "subscripted") == GdPictureStatus.OK) &&

                (gdpicturePDF.SetTextRise(0) == GdPictureStatus.OK)) //Resetting to the initial value.

            {

                status = gdpicturePDF.SaveToFile("test_SetTextRise.pdf");

                if (status == GdPictureStatus.OK)

                    MessageBox.Show("The text has been successfully drawn and the file has been saved.", caption);

                else

                    MessageBox.Show("The text has been successfully drawn,\nbut the file can't be saved. Status: " + status.ToString(), caption);

            }

            else

                MessageBox.Show("The example has not been followed successfully.\nThe last known status is " + gdpicturePDF.GetStat().ToString(), caption);

        }

        else

            MessageBox.Show("The AddStandardFont() method has failed with the status: " + status.ToString(), caption);

    }

    else

        MessageBox.Show("The NewPage() method has failed with the status: " + status.ToString(), caption);

}

else

    MessageBox.Show("The NewPDF() method has failed with the status: " + status.ToString(), caption);

gdpicturePDF.Dispose();

Reference

GdPicturePDF Class
GdPicturePDF Members
DrawText Method
DrawTextUnderline
AddStandardFont Method
AddTrueTypeFont Method
SetTextSize Method
SetTextScaling Method