DrawText Method (GdPicturePDF)
In This Topic
Draws required text using the specified font on the currently selected page of the loaded PDF document. You also need to set the destination point, expressed in the current units defined in the PDF document, related to the actual page, where the text is to be drawn.
You can simply use the GetMeasurementUnit method to determine the currently defined units and you can easily use the SetMeasurementUnit method to reset the units according to your preference.
Syntax
'Declaration
Public Function DrawText( _
ByVal As String, _
ByVal As Single, _
ByVal As Single, _
ByVal As String _
) As GdPictureStatus
public GdPictureStatus DrawText(
string ,
float ,
float ,
string
)
public function DrawText(
: String;
: Single;
: Single;
: String
): GdPictureStatus;
public function DrawText(
: String,
: float,
: float,
: String
) : GdPictureStatus;
public: GdPictureStatus DrawText(
string* ,
float ,
float ,
string*
)
public:
GdPictureStatus DrawText(
String^ ,
float ,
float ,
String^
)
Parameters
- FontResName
- The resource name of the font you prefer for drawing your text.
You can easily obtain this name using the AddStandardFont method or any of the AddTrueTypeFont...() methods. For further assistance, please see the Fonts section of the GdPicturePDF class in the Reference Guide.
- DstX
- The horizontal (X) coordinate of the destination point, where the text is to be drawn,
in the current units used in the PDF document with respect to the currently defined origin, related to the currently selected page.
- DstY
- The vertical (Y) coordinate of the destination point, where the text is to be drawn,
in the current units used in the PDF document with respect to the currently defined origin, related to the currently selected page.
- Text
- The required text to draw.
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.
Example
How to draw text with the specified attributes in the middle of a page of the loaded PDF document.
Dim caption As String = "Example: DrawText"
Dim gdpicturePDF As GdPicturePDF = New GdPicturePDF()
Dim status As GdPictureStatus = gdpicturePDF.LoadFromFile("test.pdf", False)
If status = GdPictureStatus.OK Then
gdpicturePDF.SetOrigin(PdfOrigin.PdfOriginTopLeft)
gdpicturePDF.SetMeasurementUnit(PdfMeasurementUnit.PdfMeasurementUnitPoint)
Dim fontName As String = gdpicturePDF.AddStandardFont(PdfStandardFont.PdfStandardFontTimesBold)
If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
Dim text As String = "GdPicture.NET"
Dim textSize As Integer = 30
Dim textWidth As Single = gdpicturePDF.GetTextWidth(fontName, textSize, text)
If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
gdpicturePDF.SelectPage(1)
Dim pageWidth As Single = gdpicturePDF.GetPageWidth() 'Be careful: this function returns value in PDF points.
Dim pageHeight As Single = gdpicturePDF.GetPageHeight() 'Be careful: this function returns value in PDF points.
If (gdpicturePDF.SetFillColor(0, 0, 255) = GdPictureStatus.OK) AndAlso
(gdpicturePDF.SetTextSize(textSize) = GdPictureStatus.OK) AndAlso
(gdpicturePDF.DrawText(fontName, pageWidth / 2 - textWidth / 2, pageHeight / 2, text) = GdPictureStatus.OK) Then
status = gdpicturePDF.SaveToFile("test_DrawText.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 GetTextWidth() 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("The LoadFromFile() method has failed with the status: " + status.ToString(), caption)
End If
gdpicturePDF.Dispose()
string caption = "Example: DrawText";
GdPicturePDF gdpicturePDF = new GdPicturePDF();
GdPictureStatus status = gdpicturePDF.LoadFromFile("test.pdf", false);
if (status == GdPictureStatus.OK)
{
gdpicturePDF.SetOrigin(PdfOrigin.PdfOriginTopLeft);
gdpicturePDF.SetMeasurementUnit(PdfMeasurementUnit.PdfMeasurementUnitPoint);
string fontName = gdpicturePDF.AddStandardFont(PdfStandardFont.PdfStandardFontTimesBold);
if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
{
string text = "GdPicture.NET";
int textSize = 30;
float textWidth = gdpicturePDF.GetTextWidth(fontName, textSize, text);
if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
{
gdpicturePDF.SelectPage(1);
float pageWidth = gdpicturePDF.GetPageWidth(); //Be careful: this function returns value in PDF points.
float pageHeight = gdpicturePDF.GetPageHeight(); //Be careful: this function returns value in PDF points.
if ((gdpicturePDF.SetFillColor(0, 0, 255) == GdPictureStatus.OK) &&
(gdpicturePDF.SetTextSize(textSize) == GdPictureStatus.OK) &&
(gdpicturePDF.DrawText(fontName, pageWidth / 2 - textWidth / 2, pageHeight / 2, text) == GdPictureStatus.OK))
{
status = gdpicturePDF.SaveToFile("test_DrawText.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 GetTextWidth() 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("The LoadFromFile() method has failed with the status: " + status.ToString(), caption);
gdpicturePDF.Dispose();
Example
How to draw text with the specified attributes in the middle of a page of the loaded PDF document.
Dim caption As String = "Example: DrawText"
Dim gdpicturePDF As GdPicturePDF = New GdPicturePDF()
Dim status As GdPictureStatus = gdpicturePDF.LoadFromFile("test.pdf", False)
If status = GdPictureStatus.OK Then
gdpicturePDF.SetOrigin(PdfOrigin.PdfOriginTopLeft)
gdpicturePDF.SetMeasurementUnit(PdfMeasurementUnit.PdfMeasurementUnitPoint)
Dim fontName As String = gdpicturePDF.AddStandardFont(PdfStandardFont.PdfStandardFontTimesBold)
If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
Dim text As String = "GdPicture.NET"
Dim textSize As Integer = 30
Dim textWidth As Single = gdpicturePDF.GetTextWidth(fontName, textSize, text)
If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
gdpicturePDF.SelectPage(1)
Dim pageWidth As Single = gdpicturePDF.GetPageWidth() 'Be careful: this function returns value in PDF points.
Dim pageHeight As Single = gdpicturePDF.GetPageHeight() 'Be careful: this function returns value in PDF points.
If (gdpicturePDF.SetFillColor(0, 0, 255) = GdPictureStatus.OK) AndAlso
(gdpicturePDF.SetTextSize(textSize) = GdPictureStatus.OK) AndAlso
(gdpicturePDF.DrawText(fontName, pageWidth / 2 - textWidth / 2, pageHeight / 2, text) = GdPictureStatus.OK) Then
status = gdpicturePDF.SaveToFile("test_DrawText.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 GetTextWidth() 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("The LoadFromFile() method has failed with the status: " + status.ToString(), caption)
End If
gdpicturePDF.Dispose()
string caption = "Example: DrawText";
GdPicturePDF gdpicturePDF = new GdPicturePDF();
GdPictureStatus status = gdpicturePDF.LoadFromFile("test.pdf", false);
if (status == GdPictureStatus.OK)
{
gdpicturePDF.SetOrigin(PdfOrigin.PdfOriginTopLeft);
gdpicturePDF.SetMeasurementUnit(PdfMeasurementUnit.PdfMeasurementUnitPoint);
string fontName = gdpicturePDF.AddStandardFont(PdfStandardFont.PdfStandardFontTimesBold);
if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
{
string text = "GdPicture.NET";
int textSize = 30;
float textWidth = gdpicturePDF.GetTextWidth(fontName, textSize, text);
if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
{
gdpicturePDF.SelectPage(1);
float pageWidth = gdpicturePDF.GetPageWidth(); //Be careful: this function returns value in PDF points.
float pageHeight = gdpicturePDF.GetPageHeight(); //Be careful: this function returns value in PDF points.
if ((gdpicturePDF.SetFillColor(0, 0, 255) == GdPictureStatus.OK) &&
(gdpicturePDF.SetTextSize(textSize) == GdPictureStatus.OK) &&
(gdpicturePDF.DrawText(fontName, pageWidth / 2 - textWidth / 2, pageHeight / 2, text) == GdPictureStatus.OK))
{
status = gdpicturePDF.SaveToFile("test_DrawText.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 GetTextWidth() 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("The LoadFromFile() method has failed with the status: " + status.ToString(), caption);
gdpicturePDF.Dispose();
See Also