Export (0) Print
Expand All

Graphics.MeasureString Method (String, Font, SizeF)

Measures the specified string when drawn with the specified Font within the specified layout area.

Namespace: System.Drawing
Assembly: System.Drawing (in system.drawing.dll)

public SizeF MeasureString (
	string text,
	Font font,
	SizeF layoutArea
)
public SizeF MeasureString (
	String text, 
	Font font, 
	SizeF layoutArea
)
public function MeasureString (
	text : String, 
	font : Font, 
	layoutArea : SizeF
) : SizeF
Not applicable.

Parameters

text

String to measure.

font

Font defines the text format of the string.

layoutArea

SizeF structure that specifies the maximum layout area for the text.

Return Value

This method returns a SizeF structure that represents the size, in the units specified by the PageUnit property, of the string specified by the text parameter as drawn with the font parameter.

The MeasureString method is designed for use with individual strings and includes a small amount of extra space before and after the string to allow for overhanging glyphs. Also, the DrawString method adjusts glyph points to optimize display quality and might display a string narrower than reported by MeasureString. To obtain metrics suitable for adjacent strings in layout (for example, when implementing formatted text), use the MeasureCharacterRanges method or one of the MeasureString methods that takes a StringFormat, and pass GenericTypographic. Also, ensure the TextRenderingHint for the Graphics is AntiAlias.

The following code example is designed for use with Windows Forms, and it requires PaintEventArgse, which is a parameter of the Paint event handler. The code performs the following actions:

  • Creates a string to measure and a font object set to Arial (16 point).

  • Sets the maximum layout size of the string.

  • Creates a size object and uses it, the font object, and the maximum layout size to measure the size of the string.

  • Draws a red rectangle using the measured size of the string.

  • Draws the string within the drawn rectangle.

private void MeasureStringSizeF(PaintEventArgs e)
{

    // Set up string.
    string measureString = "Measure String";
    Font stringFont = new Font("Arial", 16);

    // Set maximum layout size.
    SizeF layoutSize = new SizeF(200.0F, 50.0F);

    // Measure string.
    SizeF stringSize = new SizeF();
    stringSize = e.Graphics.MeasureString(measureString, stringFont, layoutSize);

    // Draw rectangle representing size of string.
    e.Graphics.DrawRectangle(new Pen(Color.Red, 1), 0.0F, 0.0F, stringSize.Width, stringSize.Height);

    // Draw string to screen.
    e.Graphics.DrawString(measureString, stringFont, Brushes.Black, new PointF(0, 0));
}

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft