Complex::ToString Method (String^)
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.
Assembly: System.Numerics (in System.Numerics.dll)
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.
| Exception | Condition |
|---|---|
| FormatException | format is not a valid format string. |
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 null, 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 in the .NET Framework.
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.
Available since 8
.NET Framework
Available since 4.0
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 4.0
Windows Phone
Available since 8.1