Export (0) Print
Expand All

StringFormat.ToString Method

Converts this StringFormat object to a human-readable string.

Namespace:  System.Drawing
Assembly:  System.Drawing (in System.Drawing.dll)

public override string ToString()

Return Value

Type: System.String
A string representation of this StringFormat object.

Only the value of the FormatFlags property is converted.

The following example is designed for use with Windows Forms, and it requires PaintEventArgs e, which is a parameter of the Paint event handler. The code performs the following actions:

  • Converts a StringFormat object to a string.

  • Draws the string.

  • Changes some properties in the StringFormat object.

  • Draws the string. The string will be different because the properties of the StringFormat object have changed.

public void ToStringExample(PaintEventArgs e)
{
    Graphics     g = e.Graphics;
    SolidBrush   blueBrush = new SolidBrush(Color.FromArgb(255, 0, 0, 255));
    Font         myFont = new Font("Times New Roman", 14);
    StringFormat myStringFormat = new StringFormat();

    // String variable to hold the values of the StringFormat object. 
    string    strFmtString;

    // Convert the string format object to a string (only certain information 
    // in the object is converted) and display the string.
    strFmtString = myStringFormat.ToString();
    g.DrawString("Before changing properties:   " + myStringFormat,
        myFont, blueBrush, 20, 40);

    // Change some properties of the string format
    myStringFormat.Trimming = StringTrimming.None;
    myStringFormat.FormatFlags =   StringFormatFlags.NoWrap
        | StringFormatFlags.NoClip;

    // Convert the string format object to a string and display the string. 
    // The string will be different because the properties of the string 
    // format have changed.
    strFmtString = myStringFormat.ToString();
    g.DrawString("After changing properties:   " + myStringFormat,
        myFont, blueBrush, 20, 70);
}

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft