TextRenderingMethod Property (DrawingEngine)

In This Topic

Gets or sets the text rendering method.

Syntax

Visual Basic
C#
Managed Extensions for C++
C++/CLI

'Declaration

Public Property TextRenderingMethod As TextRenderingMethod

public TextRenderingMethod TextRenderingMethod { get; set; }

public: __property TextRenderingMethod get_TextRenderingMethod();
public: __property void set_TextRenderingMethod(
   TextRenderingMethod value
);

public:
property TextRenderingMethod TextRenderingMethod {
   TextRenderingMethod get();
   void set(TextRenderingMethod value);
}

Property Value

Default value is TextRenderingMethod.DrawString.

Example

Here is an example that shows how to use DrawingEngine.TextRenderingMethod property.

VB.NET


''' <summary>
''' Renders text using different text rendering methods on specified drawing engine.
''' </summary>
''' <param name="drawingEngine">Drawing engine.</param>
''' <param name="area">Area to draw objects in.</param>
Public Shared Sub TextRenderingMethodExample(drawingEngine As DrawingEngine, area As RectangleF)
    ' set font size
    Dim fontSize As Single = (area.Width + area.Height) * 0.06F

    ' create font and brush to draw text
    Using font As IDrawingFont = drawingEngine.DrawingFactory.CreateFont("Arial", fontSize, False, True)
        Using brush As IDrawingSolidBrush = drawingEngine.DrawingFactory.CreateSolidBrush(Color.Green)
            ' set "graphics path" text rendering method and draw text
            drawingEngine.TextRenderingMethod = TextRenderingMethod.GraphicsPath
            drawingEngine.DrawText("Graphics path method example!", font, brush, New PointF(area.X, area.Y + area.Height * 0.5F))
            ' set "draw string" text rendering method and draw text
            drawingEngine.TextRenderingMethod = TextRenderingMethod.DrawString
            drawingEngine.DrawText("Draw string method example!", font, brush, New PointF(area.X, area.Y))
        End Using
    End Using
End Sub


/// <summary>
/// Renders text using different text rendering methods on specified drawing engine.
/// </summary>
/// <param name="drawingEngine">Drawing engine.</param>
/// <param name="area">Area to draw objects in.</param>
public static void TextRenderingMethodExample(DrawingEngine drawingEngine, RectangleF area)
{
    // set font size
    float fontSize = (area.Width + area.Height) * 0.06f;

    // create font and brush to draw text
    using (IDrawingFont font = drawingEngine.DrawingFactory.CreateFont("Arial", fontSize, false, true))
    using (IDrawingSolidBrush brush = drawingEngine.DrawingFactory.CreateSolidBrush(Color.Green))
    {
        // set "graphics path" text rendering method and draw text
        drawingEngine.TextRenderingMethod = TextRenderingMethod.GraphicsPath;
        drawingEngine.DrawText("Graphics path method example!", font, brush, new PointF(area.X, area.Y + area.Height * 0.5f));
        // set "draw string" text rendering method and draw text
        drawingEngine.TextRenderingMethod = TextRenderingMethod.DrawString;
        drawingEngine.DrawText("Draw string method example!", font, brush, new PointF(area.X, area.Y));
    }
}

Requirements

Target Platforms: .NET9; .NET 8; .NET 7; .NET 6; .NET Framework 4.8, 4.7, 4.6, 4.5, 4.0, 3.5

Reference

DrawingEngine Class
DrawingEngine Members

Send Feedback