PdfGraphics.DrawString(String, Font, SolidBrush, Single, Single) Method

Draws text with the specified brush and font parameters at the specified point on a page.

Namespace: DevExpress.Pdf

Assembly: DevExpress.Pdf.v21.1.Drawing.dll

NuGet Package: DevExpress.Pdf.Drawing

Declaration

C#

public void DrawString(
    string text,
    Font font,
    SolidBrush brush,
    float x,
    float y
)

VB.NET

Public Sub DrawString(
    text As String,
    font As Font,
    brush As SolidBrush,
    x As Single,
    y As Single
)

Parameters

Name	Type	Description
text	String	A text to draw.
font	Font	A Font object that defines the text format.
brush	SolidBrush	A SolidBrush object that determines the color and texture of the drawn text.
x	Single	The x-coordinate in the world coordinate system of a point where you can draw text.
y	Single	The y-coordinate in the world coordinate system of a point where you can draw text.

Remarks

Use the MeasureString method to calculate a size of the drawn text and a point where you can draw text.

The x and y parameters define the point where the text’s upper-left corner is located. Set the TextOrigin property to Baseline to make the x and y parameters define the point where the start of the text’s baseline is located. Set this property before the DrawString method call.

Use the UseKerning property to enable kerning in drawn text.

To draw a string on the PDF page, use one of the following methods:

PdfGraphics.AddToPageForeground, PdfGraphics.AddToPageBackground

These methods allow you to draw content on an existing page.

PdfDocumentProcessor.RenderNewPage

Draws content on a new page.

The code sample below draws text in the center of an empty page:

C#

using DevExpress.Pdf;
using System.Drawing;
//...

using (var processor = new PdfDocumentProcessor())
{
    processor.CreateEmptyDocument();

    using (PdfGraphics graphics = processor.CreateGraphics())
    {
        // Obtain the first document page
        PdfPage page = processor.AddNewPage(PdfPaperSize.A4);
        PdfRectangle pageSize = page.CropBox;

        // Specify text to draw
        string text = "PDF Document API";
        using (SolidBrush textBrush = new SolidBrush(Color.FromArgb(255, Color.DarkOrange)))
        {
            using (Font font = new Font("Segoe UI", 20, FontStyle.Regular))
            {
                // Calculate text size
                SizeF textSize = graphics.MeasureString(text, font);

                // Calculate a point where to draw text
                float x = (float)((pageSize.Width - textSize.Width) / 2);
                float y = (float)((pageSize.Height - textSize.Height) / 2);

                // Draw text at the calculated point
                graphics.DrawString(text, font, textBrush, x,y);

                // Add graphics content to the page foreground
                graphics.AddToPageForeground(page, 72, 72);
            }
        }
    }
    processor.SaveDocument("result.pdf");
}

VB.NET

Imports DevExpress.Pdf
Imports System.Drawing
'...

Using processor = New PdfDocumentProcessor()
  processor.CreateEmptyDocument()

  Using graphics As PdfGraphics = processor.CreateGraphics()
    ' Obtain the first document page
    Dim page As PdfPage = processor.AddNewPage(PdfPaperSize.A4)
    Dim pageSize As PdfRectangle = page.CropBox

    ' Specify text to draw
    Dim text As String = "PDF Document API"
    Using textBrush As New SolidBrush(Color.FromArgb(255, Color.DarkOrange))
      Using font As New Font("Segoe UI", 20, FontStyle.Regular)
        ' Calculate text size
        Dim textSize As SizeF = graphics.MeasureString(text, font)

        ' Calculate a point where to draw text
        Dim x As Single = CSng((pageSize.Width - textSize.Width) \ 2)
        Dim y As Single = CSng((pageSize.Height - textSize.Height) \ 2)

        ' Draw text at the calculated point
        graphics.DrawString(text, font, textBrush, x,y)

        ' Add graphics content to the page foreground
        graphics.AddToPageForeground(page, 72, 72)
      End Using
    End Using
  End Using
  processor.SaveDocument("result.pdf")
End Using

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DrawString(String, Font, SolidBrush, Single, Single) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

pdf-document-api-generate-document-layout/CS/DocumentCreationAPI/Program.cs#L30

using (Font font1 = new Font("Times New Roman", 32, FontStyle.Bold)) {
    graph.DrawString("PDF Document Processor", font1, black, 180, 150);
}

pdf-document-api-add-link-to-page/CS/AddLinkToPage/Program.cs#L31

using (Font font = new Font("Times New Roman", 32, FontStyle.Bold)) {
    graphics.DrawString("PDF Document Processor", font, black, 180, 150);
}

pdf-document-api-add-link-to-uri/CS/AddLinkToUri/Program.cs#L32

    SolidBrush blue = (SolidBrush)Brushes.Blue;
    graphics.DrawString("https://www.devexpress.com", font, blue, 310, 150);
}

VB.NET

pdf-document-api-generate-document-layout/VB/DocumentCreationAPI/Program.vb#L25

Using font1 As Font = New Font("Times New Roman", 32, FontStyle.Bold)
    graph.DrawString("PDF Document Processor", font1, black, 180, 150)
End Using

pdf-document-api-add-link-to-page/VB/AddLinkToPage/Program.vb#L27

Using font As Font = New Font("Times New Roman", 32, FontStyle.Bold)
    graphics.DrawString("PDF Document Processor", font, black, 180, 150)
End Using

pdf-document-api-add-link-to-uri/VB/AddLinkToUri/Program.vb#L28

    Dim blue As SolidBrush = CType(Brushes.Blue, SolidBrush)
    graphics.DrawString("https://www.devexpress.com", font, blue, 310, 150)
End Using