This documentation is archived and is not being maintained.

Graphics.DrawString Method (String, Font, Brush, Single, Single, StringFormat)

Draws the specified text string at the specified location with the specified Brush and Font objects using the formatting attributes of the specified StringFormat.

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

public void DrawString(
	string s,
	Font font,
	Brush brush,
	float x,
	float y,
	StringFormat format
)

Parameters

s
Type: System.String
String to draw.
font
Type: System.Drawing.Font
Font that defines the text format of the string.
brush
Type: System.Drawing.Brush
Brush that determines the color and texture of the drawn text.
x
Type: System.Single
The x-coordinate of the upper-left corner of the drawn text.
y
Type: System.Single
The y-coordinate of the upper-left corner of the drawn text.
format
Type: System.Drawing.StringFormat
StringFormat that specifies formatting attributes, such as line spacing and alignment, that are applied to the drawn text.

ExceptionCondition
ArgumentNullException

brush is null.

-or-

s is null.

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

  • Creates a text string to draw.

  • Defines the font as Arial (16pt).

  • Creates a solid, black brush to draw with.

  • Creates the coordinates of a point for the upper-left corner at which to draw the text.

  • Sets the format of the string to draw vertically

  • Draws the string to the screen using the font, brush, destination point, and format.


public void DrawStringFloatFormat(PaintEventArgs e)
{

    // Create string to draw.
    String drawString = "Sample Text";

    // Create font and brush.
    Font drawFont = new Font("Arial", 16);
    SolidBrush drawBrush = new SolidBrush(Color.Black);

    // Create point for upper-left corner of drawing.
    float x = 150.0F;
    float y =  50.0F;

    // Set format of string.
    StringFormat drawFormat = new StringFormat();
    drawFormat.FormatFlags = StringFormatFlags.DirectionVertical;

    // Draw string to screen.
    e.Graphics.DrawString(drawString, drawFont, drawBrush, x, y, drawFormat);
}


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: