Complex.ToString Method (String)
Microsoft Silverlight will reach end of support after October 2021. Learn more.
Converts the value of the current complex number to its equivalent string representation in Cartesian form by using the specified format for its real and imaginary parts.
Namespace: System.Numerics
Assembly: System.Numerics (in System.Numerics.dll)
Syntax
'Declaration
Public Function ToString ( _
format As String _
) As String
public string ToString(
string format
)
Parameters
- format
Type: System.String
A standard or custom numeric format string.
Return Value
Type: System.String
The string representation of the current instance in Cartesian form.
Remarks
The string representation of the complex number returned by this method displays the number using its Cartesian coordinates in the form (a, b), where a is the real part of the complex number, and b is its imaginary part. Both a and b are formatted using the format string specified by format. The format parameter can be any valid standard numeric format specifier, or any combination of custom numeric format specifiers. If format is equal to String.Empty or is nulla null reference (Nothing in Visual Basic), the real and imaginary parts of the complex number are formatted with the general format specifier ("G"). If format is any other value, the method throws a FormatException.
The .NET Framework provides extensive formatting support, which is described in greater detail in the following topics:
For more information about numeric format strings, see Standard Numeric Format Strings and Custom Numeric Format Strings.
For more information about formatting in the .NET Framework, see Formatting Types.
The format of the returned string is determined by the NumberFormatInfo object for the current culture. Depending on the format parameter, this object controls symbols such as the negative sign, the group separator, and the decimal point symbol in the output string. To provide formatting information for cultures other than the current culture, call the ToString(String, IFormatProvider) overload.
Examples
The following example initializes a complex number and displays it using several standard format strings.
Imports System.Numerics
Module Example
Public Sub Demo(ByVal outputBlock As System.Windows.Controls.TextBlock)
Dim c() As Complex = { New Complex(17.3, 14.1),
New Complex(-18.9, 147.2),
New Complex(13.472, -18.115),
New Complex(-11.154, -17.002) }
Dim formats() As String = {"F2", "N2", "G5"}
For Each c1 As Complex In c
For Each format As String In formats
outputBlock.Text += String.Format("{0}: {1} ", format, c1.ToString(format)) & vbCrLf
Next
outputBlock.Text &= vbCrLf
Next
End Sub
End Module
' The example displays the following output:
' F2: (17.30, 14.10)
' N2: (17.30, 14.10)
' G5: (17.3, 14.1)
'
' F2: (-18.90, 147.20)
' N2: (-18.90, 147.20)
' G5: (-18.9, 147.2)
'
' F2: (13.47, -18.12)
' N2: (13.47, -18.12)
' G5: (13.472, -18.115)
'
' F2: (-11.15, -17.00)
' N2: (-11.15, -17.00)
' G5: (-11.154, -17.002)
using System;
using System.Numerics;
public class Example
{
public static void Demo(System.Windows.Controls.TextBlock outputBlock)
{
Complex[] c = { new Complex(17.3, 14.1),
new Complex(-18.9, 147.2),
new Complex(13.472, -18.115),
new Complex(-11.154, -17.002) };
string[] formats = { "F2", "N2", "G5" };
foreach (Complex c1 in c)
{
foreach (string format in formats)
outputBlock.Text += String.Format("{0}: {1} ", format, c1.ToString(format)) + "\n";
outputBlock.Text += "\n";
}
}
}
// The example displays the following output:
// F2: (17.30, 14.10)
// N2: (17.30, 14.10)
// G5: (17.3, 14.1)
//
// F2: (-18.90, 147.20)
// N2: (-18.90, 147.20)
// G5: (-18.9, 147.2)
//
// F2: (13.47, -18.12)
// N2: (13.47, -18.12)
// G5: (13.472, -18.115)
//
// F2: (-11.15, -17.00)
// N2: (-11.15, -17.00)
// G5: (-11.154, -17.002)
Version Information
Silverlight
Supported in: 5, 4
Platforms
For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.
See Also