1. Graphics Mill 5.5 for .NET
  2. Aurigma Graphics Mill 5.5 for .NET
  3. Class Library Reference
  4. Aurigma.GraphicsMill.Drawing Namespace
  5. GdiGraphics Class
  6. GdiGraphics Methods
  7. DrawText Method
This documentation is for the old version. Go to the latest Graphics Mill docs

GdiGraphics.DrawText Method (String, Font, SolidBrush, Rectangle, Boolean, Int32)

Draws text in the specified rectangle taking into account its line breaks and justification.

Namespace: Aurigma.GraphicsMill.Drawing
Assembly: Aurigma.GraphicsMill (in Aurigma.GraphicsMill.dll)

Syntax

Visual Basic 
Public Sub DrawText ( _
	s As String, _
	font As Font, _
	brush As SolidBrush, _
	rect As Rectangle, _
	clipping As Boolean, _
	tabSize As Integer _
)
C# 
public void DrawText(
	string s,
	Font font,
	SolidBrush brush,
	Rectangle rect,
	bool clipping,
	int tabSize
)

Parameters

s

Type: System.String

Multiline text to draw.
font

Type: Aurigma.GraphicsMill.Drawing.Font

Font object specifying text rendering options.
brush

Type: Aurigma.GraphicsMill.Drawing.SolidBrush

SolidBrush object containing font color.
rect

Type: System.Drawing.Rectangle

Destination rectangle.
clipping

Type: System.Boolean

Value specifying whether to clip the text when it does not fit the bounding rectangle. If this value is false all the lines of the text will be rendered regardless of the destination rectangle.
tabSize

Type: System.Int32

Value which specifies the number of whitespaces to replace one tabulation character in the text.

Remarks

All the coordinates are measured in units specified with Unit property. If the destination rectangle width is 0 the text will not be wrapped during the drawing. The extent of the text drawn by this method can be measured using the Font.MeasureText method.

The DrawText() method supports newline (\n in C# and vbNewLine in VB) and tabulation (\t in C# and vbTab in VB) characters. It makes the characters after the newline symbol be displayed in a new line and replaces the tabulation character with the specified number of whitespaces.

Note

If you draw text on indexed bitmaps, antialiasing is disabled regardless to the Antialiased property value. Also, if the GdiGraphics was created on the base of the Bitmap which has Format8bppGrayScale pixel format, antialiasing will not be applied for text output. The reason of this issue is that GDI does not support grayscale bitmaps. That's why Graphics Mill for .NET represents this image as Format8bppIndexed bitmap with grayscale palette.

See Also

Reference

Manual