PdfGraphics.DrawString(String, Font, SolidBrush, RectangleF, PdfStringFormat) Method

Draws text in the specified page rectangle. Allows you to specify brush, font, and string parameters.

Namespace: DevExpress.Pdf

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

NuGet Package: DevExpress.Pdf.Drawing

Declaration

C#

public void DrawString(
    string text,
    Font font,
    SolidBrush brush,
    RectangleF layout,
    PdfStringFormat format
)

VB.NET

Public Sub DrawString(
    text As String,
    font As Font,
    brush As SolidBrush,
    layout As RectangleF,
    format As PdfStringFormat
)

Parameters

Name	Type	Description
text	String	A text to draw.
font	Font	An object that defines text font options.
brush	SolidBrush	An object that determines the color and texture of the drawn text.
layout	RectangleF	A page rectangle in the world coordinate system where you can draw text.
format	PdfStringFormat	An object that specifies text formatting attributes.

Remarks

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

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, PdfStringFormat.GenericTypographic);

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

                RectangleF textRect = new RectangleF(x, y, textSize.Width, textSize.Height);

                // Draw text in the calculated area
                graphics.DrawString(text, font, textBrush, textRect, PdfStringFormat.GenericTypographic);

                // 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, PdfStringFormat.GenericTypographic)

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

        Dim textRect As New RectangleF(x, y, textSize.Width, textSize.Height)

        ' Draw text in the calculated area
        graphics.DrawString(text, font, textBrush, textRect, PdfStringFormat.GenericTypographic)

        ' 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 snippet (auto-collected from DevExpress Examples) contains a reference to the DrawString(String, Font, SolidBrush, RectangleF, PdfStringFormat) 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.

VB.NET

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

    Dim rect As RectangleF = New RectangleF(0, 0, stringSize.Width * scale, stringSize.Height * scale)
    graphics.DrawString(Text, actualFont, brush, rect, stringFormat)
End Using