StringFormat.ToString メソッド

.NET Framework クラス ライブラリ リファレンス

StringFormat.ToString メソッド

この StringFormat オブジェクトをユーザーが判読できる文字列に変換します。

名前空間: System.Drawing
アセンブリ: System.Drawing (system.drawing.dll 内)
構文

Visual Basic (宣言)

Public Overrides Function
 ToString As String

Visual Basic (使用法)

Dim instance As StringFormat
Dim returnValue As String

returnValue = instance.ToString

C#

public override string ToString ()

C++

public:
virtual String^ ToString () override

J#

public String ToString ()

JScript

public override function ToString () : String

戻り値
この StringFormat オブジェクトの文字列形式。

解説

FormatFlags プロパティの値だけが変換されます。

使用例

次の例は、Windows フォームでの使用を意図してデザインされており、Paint イベント ハンドラのパラメータである PaintEventArgse が必要です。このコードは次のアクションを実行します。

• StringFormat オブジェクトを文字列に変換します。

• 文字列を描画します。

• StringFormat オブジェクト内のあるプロパティを変更します。

• 文字列を描画します。StringFormat オブジェクトのプロパティが変更されているため、文字列も変更されます。

Visual Basic

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

C#

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

C++

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

J#

public void ToStringExample(PaintEventArgs
 e)
{
    Graphics g = e.get_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.set_Trimming(StringTrimming.None);
    myStringFormat.set_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);
} //ToStringExample

プラットフォーム

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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0

参照

関連項目
StringFormat クラス
StringFormat メンバ
System.Drawing 名前空間