GdPicture.NET.14.API
GdPicture14 Namespace / GdPicturePDF Class / SetTextUnderlineDistance Method
New value for the text decoration line width.
Example





In This Topic
SetTextUnderlineDistance Method (GdPicturePDF)
In This Topic
Sets text underline distance from text for all subsequent text drawing operations.
Syntax
'Declaration
 
Public Function SetTextUnderlineDistance( _
   ByVal TextUnderlineDistance As Single _
) As GdPictureStatus
public GdPictureStatus SetTextUnderlineDistance( 
   float TextUnderlineDistance
)
public function SetTextUnderlineDistance( 
    TextUnderlineDistance: Single
): GdPictureStatus; 
public function SetTextUnderlineDistance( 
   TextUnderlineDistance : float
) : GdPictureStatus;
public: GdPictureStatus SetTextUnderlineDistance( 
   float TextUnderlineDistance
) 
public:
GdPictureStatus SetTextUnderlineDistance( 
   float TextUnderlineDistance
) 

Parameters

TextUnderlineDistance
New value for the text decoration line width.

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.
Example
How to draw underline text on the newly created page.
Using gdpicturePDF As GdPicturePDF = New GdPicturePDF()
    gdpicturePDF.NewPDF()
    gdpicturePDF.NewPage(PdfPageSizes.PdfPageSizeA4)
    gdpicturePDF.SetOrigin(PdfOrigin.PdfOriginTopLeft)
    Dim fontResName As String = gdpicturePDF.AddStandardFont(PdfStandardFont.PdfStandardFontHelvetica)
    gdpicturePDF.SetTextDecorationStyle(PdfTextDecorationStyle.Underline)
    gdpicturePDF.SetTextUnderlineStyle(PdfTextUnderlineStyle.Single)
    gdpicturePDF.SetTextUnderlineColor(255, 0, 0)
    gdpicturePDF.SetTextUnderlineWidth(2)
    gdpicturePDF.SetTextUnderlineDistance(2)
    gdpicturePDF.DrawRotatedText(fontResName, 100, 100, "This is rotated underlined text!", 15)
    gdpicturePDF.SaveToFile("output.pdf")
End Using
using (GdPicturePDF gdpicturePDF = new GdPicturePDF())
{
    gdpicturePDF.NewPDF();
    gdpicturePDF.NewPage(PdfPageSizes.PdfPageSizeA4);
    gdpicturePDF.SetOrigin(PdfOrigin.PdfOriginTopLeft);
    string fontResName = gdpicturePDF.AddStandardFont(PdfStandardFont.PdfStandardFontHelvetica);
    gdpicturePDF.SetTextDecorationStyle(PdfTextDecorationStyle.Underline);
    gdpicturePDF.SetTextUnderlineStyle(PdfTextUnderlineStyle.Single);    
    gdpicturePDF.SetTextUnderlineColor(255, 0, 0);
    gdpicturePDF.SetTextUnderlineWidth(2);
    gdpicturePDF.SetTextUnderlineDistance(2);
    gdpicturePDF.DrawRotatedText(fontResName, 100, 100, "This is rotated underlined text!", 15);
    gdpicturePDF.SaveToFile("output.pdf");
}
See Also