Font.DrawText(Sprite,String,Rectangle,DrawTextFormat,Color) Method (Microsoft.DirectX.Direct3D)

Article
06/30/2006

Draws formatted text.

Definition

Visual Basic Public Function DrawText( _
    ByVal sprite As Sprite, _
    ByVal text As String, _
    ByVal rect As Rectangle, _
    ByVal format As DrawTextFormat, _
    ByVal color As Color _
) As Integer

C# public int DrawText(
    Sprite sprite,
    string text,
    Rectangle rect,
    DrawTextFormat format,
    Color color
);

C++ public:
int DrawText(
    Sprite^ sprite,
    String^ text,
    Rectangle rect,
    DrawTextFormat format,
    Color color
);

JScript public function DrawText(
    sprite : Sprite,
    text : String,
    rect : Rectangle,
    format : DrawTextFormat,
    color : Color
) : int;

Parameters

sprite Microsoft.DirectX.Direct3D.Sprite
A Sprite object that contains the string. Can be null, in which case Microsoft Direct3D renders the string with its own sprite object.
If Font.DrawText will be called more than once in a row, a sprite object should be specified to improve efficiency.

text System.String
String to draw.

rect System.Drawing.Rectangle
A Rectangle structure that contains the rectangle, in logical coordinates, in which the text is being formatted.

format Microsoft.DirectX.Direct3D.DrawTextFormat
Method of formatting the text; can be any combination of values from the DrawTextFormat enumeration.

color System.Drawing.Color
Color of the text. For more information, see Color.

Return Value

System.Int32
If the function succeeds, the return value is the height of the text in logical units. If DrawTextFormat.Center or DrawTextFormat.Bottom is specified in the format parameter, the return value is the offset from rect.Top to the bottom of the drawn text. If the function fails, the return value is 0.

Remarks

This method must be called from inside of a Device.BeginScene ... Device.EndScene block.

Unless the NoClip format is used, this method clips the text so that it does not appear outside of the specified rectangle. All formatting is assumed to have multiple lines unless the SingleLine format is specified.

If the selected font is too large for the rectangle, this method does not attempt to substitute a smaller font.

This method supports only fonts whose escapement and orientation are both zero.

Visual Basic	Public Function DrawText( _ ByVal sprite As Sprite, _ ByVal text As String, _ ByVal rect As Rectangle, _ ByVal format As DrawTextFormat, _ ByVal color As Color _ ) As Integer
C#	public int DrawText( Sprite sprite, string text, Rectangle rect, DrawTextFormat format, Color color );
C++	public: int DrawText( Sprite^ sprite, String^ text, Rectangle rect, DrawTextFormat format, Color color );
JScript	public function DrawText( sprite : Sprite, text : String, rect : Rectangle, format : DrawTextFormat, color : Color ) : int;

sprite	Microsoft.DirectX.Direct3D.Sprite A Sprite object that contains the string. Can be null, in which case Microsoft Direct3D renders the string with its own sprite object. If Font.DrawText will be called more than once in a row, a sprite object should be specified to improve efficiency.
text	System.String String to draw.
rect	System.Drawing.Rectangle A Rectangle structure that contains the rectangle, in logical coordinates, in which the text is being formatted.
format	Microsoft.DirectX.Direct3D.DrawTextFormat Method of formatting the text; can be any combination of values from the DrawTextFormat enumeration.
color	System.Drawing.Color Color of the text. For more information, see Color.

Font.DrawText(Sprite,String,Rectangle,DrawTextFormat,Color) Method (Microsoft.DirectX.Direct3D)

Additional resources