PdfGraphics.MeasureString(String, Font, PdfStringFormat) Method

Measures the specified string when drawn with the specified font and text formatting parameters.

Namespace: DevExpress.Pdf

Assembly: DevExpress.Pdf.v23.2.Drawing.dll

NuGet Package: DevExpress.Pdf.Drawing

Declaration

C#

public SizeF MeasureString(
    string text,
    Font font,
    PdfStringFormat format
)

VB.NET

Public Function MeasureString(
    text As String,
    font As Font,
    format As PdfStringFormat
) As SizeF

Parameters

Name	Type	Description
text	String	A text to measure.
font	Font	An object that contains font parameters.
format	PdfStringFormat	An object that contains text formatting parameters.

Returns

Type	Description
SizeF	The string’s measured size.

Remarks

Use this method to calculate a size of the drawn text. Use the returned SizeF object to calculate a page area or a point where you can draw text.

The MeasureString method overload measures a string with 96 DPI. Use the PdfGraphics.MeasureString(String, Font, PdfStringFormat, Single, Single) method overload to obtain text size with 72 DPI to calculate its size on a PDF page.

The code sample below uses the MeasureString method to draw text in the page center:

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 a point where to draw text
                PointF textPoint =
                    new PointF((float)((pageSize.Width - textSize.Width) / 2), (float)((pageSize.Height - textSize.Height) / 2));

                // Draw text at the calculated point
                graphics.DrawString(text, font, textBrush, textPoint, 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 a point where to draw text
        Dim textPoint As New PointF(CSng((pageSize.Width - textSize.Width) \ 2), CSng((pageSize.Height - textSize.Height) \ 2))

        ' Draw text at the calculated point
        graphics.DrawString(text, font, textBrush, textPoint, 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