SetTextCharSpacing Method (GdPicturePDF)

In This Topic

Sets the character spacing to be used when drawing text onto the currently loaded PDF document. This value defines a distance between adjacent characters in a line of text. It is a number expressed in unscaled text space units (points). The initial value is set to 0.

The character spacing 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 SetTextCharSpacing( _

   ByVal CharSpacing As Single _

) As GdPictureStatus

public GdPictureStatus SetTextCharSpacing( 

   float CharSpacing

)

public function SetTextCharSpacing( 

    CharSpacing: Single

): GdPictureStatus;

public function SetTextCharSpacing( 

   CharSpacing : float

) : GdPictureStatus;

public: GdPictureStatus SetTextCharSpacing( 

   float CharSpacing

)

public:

GdPictureStatus SetTextCharSpacing( 

   float CharSpacing

)

Parameters

CharSpacing: A new char spacing to set. 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.

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 reset the character spacing in the PDF document in order to be able to draw text using this parameter.

VB.NET
C#

Dim caption As String = "Example: SetTextCharSpacing"

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

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

               (gdpicturePDF.DrawText(fontName, 50, 700, "Lorem ipsum dolor sit amet ...") = GdPictureStatus.OK) AndAlso

               (gdpicturePDF.SetTextCharSpacing(5) = GdPictureStatus.OK) AndAlso

               (gdpicturePDF.DrawText(fontName, 50, 600, "Lorem ipsum dolor sit amet ...") = GdPictureStatus.OK) AndAlso

               (gdpicturePDF.SetTextCharSpacing(10) = GdPictureStatus.OK) AndAlso

               (gdpicturePDF.DrawText(fontName, 50, 500, "Lorem ipsum dolor sit amet ...") = GdPictureStatus.OK) AndAlso

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

                status = gdpicturePDF.SaveToFile("test_SetTextCharSpacing.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: SetTextCharSpacing";

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)

        {

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

                (gdpicturePDF.DrawText(fontName, 50, 700, "Lorem ipsum dolor sit amet ...") == GdPictureStatus.OK) &&

                (gdpicturePDF.SetTextCharSpacing(5) == GdPictureStatus.OK) &&

                (gdpicturePDF.DrawText(fontName, 50, 600, "Lorem ipsum dolor sit amet ...") == GdPictureStatus.OK) &&

                (gdpicturePDF.SetTextCharSpacing(10) == GdPictureStatus.OK) &&

                (gdpicturePDF.DrawText(fontName, 50, 500, "Lorem ipsum dolor sit amet ...") == GdPictureStatus.OK) &&

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

            {

                status = gdpicturePDF.SaveToFile("test_SetTextCharSpacing.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
AddStandardFont Method
AddTrueTypeFont Method
SetTextSize Method
SetTextWordSpacing Method