StringFormat.ToString Method

Definition

Namespace:

System.Drawing

Assembly:

System.Drawing.Common.dll

Converts this StringFormat object to a human-readable string.

public:
 override System::String ^ ToString();

public override string ToString ();

override this.ToString : unit -> string

Public Overrides Function ToString () As String

Returns

String

A string representation of this StringFormat object.

Examples

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.

void ToStringExample( PaintEventArgs^ e )
{
   Graphics^ g = e->Graphics;
   SolidBrush^ blueBrush = gcnew SolidBrush( Color::FromArgb( 255, 0, 0, 255 ) );
   System::Drawing::Font^ myFont = gcnew System::Drawing::Font( "Times New Roman",14 );
   StringFormat^ myStringFormat = gcnew 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( String::Format( "Before changing properties:   {0}", myStringFormat ), myFont, blueBrush, 20, 40 );

   // Change some properties of the string format
   myStringFormat->Trimming = StringTrimming::None;
   myStringFormat->FormatFlags = (StringFormatFlags)(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( String::Format( "After changing properties:   {0}", myStringFormat ), myFont, blueBrush, 20, 70 );
}

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);
}

Public Sub ToStringExample(ByVal e As PaintEventArgs)
    Dim g As Graphics = e.Graphics
    Dim blueBrush As New SolidBrush(Color.FromArgb(255, 0, 0, 255))
    Dim myFont As New Font("Times New Roman", 14)
    Dim myStringFormat As New StringFormat

    ' String variable to hold the values of the StringFormat object.
    Dim strFmtString As String

    ' 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:   ", myFont, blueBrush, _
    20, 40, myStringFormat)

    ' Change some properties of the string format.
    myStringFormat.Trimming = StringTrimming.None
    myStringFormat.FormatFlags = StringFormatFlags.NoWrap Or _
    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:   ", myFont, blueBrush, _
    20, 70, myStringFormat)
End Sub

Remarks

Only the value of the FormatFlags property is converted.