Graphics.MeasureString Method (String, Font, Int32)
Measures the specified string when drawn with the specified Font.
Assembly: System.Drawing (in System.Drawing.dll)
Parameters
- text
-
Type:
System.String
String to measure.
- font
-
Type:
System.Drawing.Font
Font that defines the format of the string.
- width
-
Type:
System.Int32
Maximum width of the string in pixels.
Return Value
Type: System.Drawing.SizeFThis method returns a SizeF structure that represents the size, in the units specified by the PageUnit property, of the string specified in the text parameter as drawn with the font parameter.
| Exception | Condition |
|---|---|
| ArgumentException | font is null. |
The width parameter specifies the maximum value of the width component of the returned SizeF structure (Width). If the width parameter is less than the actual width of the string, the returned Width component is truncated to a value representing the maximum number of characters that will fit within the specified width. To accommodate the entire string, the returned Height component is adjusted to a value that allows displaying the string with character wrap.
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 width of the string.
Creates a size object and uses it, the font object, and the maximum string width 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 Sub MeasureStringWidth(ByVal e As PaintEventArgs) ' Set up string. Dim measureString As String = "Measure String" Dim stringFont As New Font("Arial", 16) ' Set maximum width of string. Dim stringWidth As Integer = 200 ' Measure string. Dim stringSize As New SizeF stringSize = e.Graphics.MeasureString(measureString, _ stringFont, stringWidth) ' 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)) End Sub
Available since 1.1