Font.DrawText Method (Sprite, String, Rectangle, DrawTextFormat, Int32)

Article
12/12/2007

Draws formatted text.

Namespace: Microsoft.WindowsMobile.DirectX.Direct3D
Assembly: Microsoft.WindowsMobile.DirectX (in microsoft.windowsmobile.directx.dll)

Syntax

'Declaration
Public Function DrawText ( _
    sprite As Sprite, _
    value As String, _
    rectangle As Rectangle, _
    format As DrawTextFormat, _
    color As Integer _
) As Integer
'Usage
Dim instance As Font
Dim sprite As Sprite
Dim value As String
Dim rectangle As Rectangle
Dim format As DrawTextFormat
Dim color As Integer
Dim returnValue As Integer

returnValue = instance.DrawText(sprite, value, rectangle, format, color)

public int DrawText (
    Sprite sprite,
    string value,
    Rectangle rectangle,
    DrawTextFormat format,
    int color
)

public:
int DrawText (
    Sprite^ sprite, 
    String^ value, 
    Rectangle rectangle, 
    DrawTextFormat format, 
    int color
)

public int DrawText (
    Sprite sprite, 
    String value, 
    Rectangle rectangle, 
    DrawTextFormat format, 
    int color
)

public function DrawText (
    sprite : Sprite, 
    value : String, 
    rectangle : Rectangle, 
    format : DrawTextFormat, 
    color : int
) : int

Not applicable.

Parameters

sprite
A Sprite that contains the string. Can be a null reference (Nothing in Visual Basic), in which case Direct3D renders the string with its own sprite object.

value
The string to draw.

rectangle
A reference to a Rectangle structure that contains the rectangle, in logical coordinates, in which the text is being formatted.

format
The method of formatting the text; can be any combination of values from the DrawTextFormat enumeration.

color
An integer color value.

Return Value

If the function succeeds, the return value is the height of the text in logical units. If Center or Bottom is specified in the format parameter, the return value is the offset from the 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 BeginScene-method-to-EndScene-method code 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.

Platforms

Windows CE, Windows Mobile for Pocket PC, Windows Mobile for Smartphone

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

Version Information

.NET Compact Framework

Supported in: 2.0

Share via