Application.SetCompatibleTextRenderingDefault Method (System.Windows.Forms)

SetCompatibleTextRenderingDefault M...

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

Application..::.SetCompatibleTextRenderingDefault Method

Updated: October 2008

Sets the application-wide default for the UseCompatibleTextRendering property defined on certain controls.

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in System.Windows.Forms.dll)

Syntax

Visual Basic (Declaration)

Public Shared Sub SetCompatibleTextRenderingDefault ( _
    defaultValue As Boolean _
)

Visual Basic (Usage)

Dim defaultValue As Boolean

Application.SetCompatibleTextRenderingDefault(defaultValue)

public static void SetCompatibleTextRenderingDefault(
    bool defaultValue
)

Visual C++

public:
static void SetCompatibleTextRenderingDefault(
    bool defaultValue
)

JScript

public static function SetCompatibleTextRenderingDefault(
    defaultValue : boolean
)

Parameters

defaultValue: Type: System..::.Boolean
The default value to use for new controls. If true, new controls that support UseCompatibleTextRendering use the GDI+ based Graphics class for text rendering; if false, new controls use the GDI based TextRenderer class.

Exceptions

Exception	Condition
InvalidOperationException	You can only call this method before the first window is created by your Windows Forms application.

Remarks

Certain Windows Forms controls can render their text using either the TextRenderer class, which is based on the GDI graphics library, or the Graphics class, which is based on the GDI+ graphics library. This change was made in the .NET Framework 2.0 because of performance and localization issues with GDI+. Use SetCompatibleTextRenderingDefault to set the default value of the UseCompatibleTextRendering property for controls that support it.

The UseCompatibleTextRendering property is intended to provide visual compatibility between Windows Forms controls that render text using the TextRenderer class and .NET Framework 1.0 and .NET Framework 1.1 applications that perform custom text rendering using the Graphics class. In most cases, if your application is not being upgraded from .NET Framework 1.0 or .NET Framework 1.1, it is recommended that you leave UseCompatibleTextRendering set to the default value of false.

The GDI based TextRenderer class was introduced in the .NET Framework 2.0 to improve performance, make text look better, and improve support for international fonts. In earlier versions of the .NET Framework, the GDI+ based Graphics class was used to perform all text rendering. GDI calculates character spacing and word wrapping differently from GDI+. In a Windows Forms application that uses the Graphics class to render text, this could cause the text for controls that use TextRenderer to appear different from the other text in the application. To resolve this incompatibility, you can set the UseCompatibleTextRendering property to true. To set UseCompatibleTextRendering to true for all supported controls in the application, call the SetCompatibleTextRenderingDefault method with a parameter of true.

You should never call this method if your Windows Forms code is hosted in another application, such as Internet Explorer. Only call this method in stand-alone Windows Forms applications.

Examples

Important Note:
To set the default value for UseCompatibleTextRendering in Visual Basic 2005 or later, see WindowsFormsApplicationBase..::.UseCompatibleTextRendering.

In Visual C# 2005 or later, a call to SetCompatibleTextRenderingDefault is automatically generated in the Program.cs file. To change the text rendering default, modify the generated code.

static class Program

{

/// <summary>

/// The main entry point for the application.

/// </summary>

[STAThread]

static void Main()

{

Application.EnableVisualStyles();

Application.SetCompatibleTextRenderingDefault(false);

Application.Run(new Form1());

}

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information