Complex.ToString Method (String, IFormatProvider)
Converts the value of the current complex number to its equivalent string representation in Cartesian form by using the specified format and culture-specific format information for its real and imaginary parts.
Assembly: System.Numerics (in System.Numerics.dll)
abstract ToString : format:string * provider:IFormatProvider -> string override ToString : format:string * provider:IFormatProvider -> string
- Type: System.String
A standard or custom numeric format string.
- Type: System.IFormatProvider
An object that supplies culture-specific formatting information.
Return ValueType: System.String
The string representation of the current instance in Cartesian form, as specified by format and provider.
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 a 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 formatting in the .NET Framework, see Formatting Types.
The provider parameter is an IFormatProvider implementation. Its GetFormat method returns a NumberFormatInfo object that provides culture-specific information about the format of the real and imaginary numbers in the returned string. 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. If provider is a null reference (Nothing in Visual Basic), the returned string is formatted using the NumberFormatInfo object of the current culture.
The provider parameter can be one of the following:
A CultureInfo object that represents the culture that supplies formatting information
The NumberFormatInfo object that supplies formatting information.
The following example creates an array of complex numbers, and displays each using several standard format strings as well as CultureInfo objects that represent the English - United States ("en-US") and French - France ("fr-FR") cultures.
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.