This topic has not yet been rated - Rate this topic

Convert.ToSingle Method (String, IFormatProvider)

.NET Framework 3.0

Converts the specified String representation of a number to an equivalent single-precision floating point number using the specified culture-specific formatting information.

Namespace: System
Assembly: mscorlib (in mscorlib.dll)

Syntax

C++

Copy

public static float ToSingle (
	string value,
	IFormatProvider provider
)

Copy

public static float ToSingle (
	String value, 
	IFormatProvider provider
)

JScript

Copy

public static function ToSingle (
	value : String, 
	provider : IFormatProvider
) : float

XAML

Copy

Not applicable.

Parameters

value: A String containing a number to convert.

provider: An IFormatProvider interface implementation that supplies culture-specific formatting information.

Return Value

A single-precision floating point number equivalent to the value of value. -or- Zero if value is a null reference (Nothing in Visual Basic).

Exceptions

Exception type	Condition
FormatException	value is not a number in a valid format.
OverflowException	value represents a number less than MinValue or greater than MaxValue.

Remarks

The return value is the result of invoking the Single.Parse method on value.

provider is an IFormatProvider instance that obtains a NumberFormatInfo object. The NumberFormatInfo object provides culture-specific information about the format of value. If provider is a null reference (Nothing in Visual Basic), the NumberFormatInfo for the current culture is used.

Example

The following code example converts String representations of Single values with the ToSingle method, using an IFormatProvider object.

C++

Copy

// Example of the Convert.ToSingle( String ) and 
// Convert.ToSingle( String, IFormatProvider ) methods.
using System;
using System.Globalization;

class ToSingleProviderDemo
{
    static string formatter = "{0,-22}{1,-20}{2}";

    // Get the exception type name; remove the namespace prefix.
    static string GetExceptionType( Exception ex )
    {
        string exceptionType = ex.GetType( ).ToString( );
        return exceptionType.Substring( 
            exceptionType.LastIndexOf( '.' ) + 1 );
    }

    static void ConvertToSingle( string numericStr, 
        IFormatProvider provider )
    {
        object defaultValue;
        object providerValue;

        // Convert numericStr to float without a format provider.
        try
        {
            defaultValue = Convert.ToSingle( numericStr );
        }
        catch( Exception ex )
        {
            defaultValue = GetExceptionType( ex );
        }

        // Convert numericStr to float with a format provider.
        try
        {
            providerValue = Convert.ToSingle( numericStr, provider );
        }
        catch( Exception ex )
        {
            providerValue = GetExceptionType( ex );
        }

        Console.WriteLine( formatter, numericStr, defaultValue, 
            providerValue );
    }

    static void Main( )
    {
        // Create a NumberFormatInfo object and set several of its
        // properties that apply to numbers.
        NumberFormatInfo provider = new NumberFormatInfo( );

        provider.NumberDecimalSeparator = ",";
        provider.NumberGroupSeparator = ".";
        provider.NumberGroupSizes = new int[ ] { 3 };

        Console.WriteLine( 
            "This example of\n  Convert.ToSingle( String ) and \n" +
            "  Convert.ToSingle( String, IFormatProvider ) \n" +
            "generates the following output when run in the " +
            "[{0}] culture.", 
            CultureInfo.CurrentCulture.Name );
        Console.WriteLine( "\nSeveral " +
            "strings are converted to float values, using \n" +
            "default formatting and a NumberFormatInfo object.\n");
        Console.WriteLine( formatter, "String to convert", 
            "Default/exception", "Provider/exception" );
        Console.WriteLine( formatter, "-----------------", 
            "-----------------", "------------------" );

        // Convert strings, with and without an IFormatProvider.
        ConvertToSingle( "1234567", provider );
        ConvertToSingle( "1234.567", provider );
        ConvertToSingle( "1234,567", provider );
        ConvertToSingle( "12,345.67", provider );
        ConvertToSingle( "12.345,67", provider );
        ConvertToSingle( "1,234,567.89", provider );
        ConvertToSingle( "1.234.567,89", provider );
    }
}

/*
This example of
  Convert.ToSingle( String ) and
  Convert.ToSingle( String, IFormatProvider )
generates the following output when run in the [en-US] culture.

Several strings are converted to float values, using
default formatting and a NumberFormatInfo object.

String to convert     Default/exception   Provider/exception
-----------------     -----------------   ------------------
1234567               1234567             1234567
1234.567              1234.567            1234567
1234,567              1234567             1234.567
12,345.67             12345.67            FormatException
12.345,67             FormatException     12345.67
1,234,567.89          1234568             FormatException
1.234.567,89          FormatException     1234568
*/

Copy

// Example of the Convert.ToSingle( String ) and 
// Convert.ToSingle( String, IFormatProvider ) methods.
import System.* ;
import System.Globalization.* ;

class ToSingleProviderDemo
{
    private static String formatter = "{0,-22}{1,-20}{2}";
     
    // Get the exception type name; remove the namespace prefix.
    static String GetExceptionType(System.Exception ex)
    {
        String exceptionType = ex.GetType().ToString();
        return exceptionType.Substring((exceptionType.LastIndexOf('.') + 1)) ;
    } //GetExceptionType   
   
    static void ConvertToSingle(String numericStr, IFormatProvider provider)
    {
        Object defaultValue;
        Object providerValue;
      
        // Convert numericStr to float without a format provider.
        try {
            defaultValue =System.Convert.ToString(Convert.ToSingle(numericStr));
        }
        catch(System.Exception  ex) {      
            defaultValue = GetExceptionType(ex);
        }
      
        // Convert numericStr to float with a format provider.
        try {
            providerValue = System.Convert.ToString(Convert.ToSingle(numericStr,
                            provider));
        }
        catch(System.Exception  ex) {      
            providerValue = GetExceptionType(ex);
        }
      
        Console.WriteLine(formatter, numericStr, defaultValue, providerValue);
    } //ConvertToSingle   
   
    public static void main(String[] args)
    {
   
        // Create a NumberFormatInfo object and set several of its
        // properties that apply to numbers.
        NumberFormatInfo provider =  new NumberFormatInfo();
      
        provider.set_NumberDecimalSeparator(",");
        provider.set_NumberGroupSeparator(".");
        provider.set_NumberGroupSizes(new int[]{3});
      
        Console.WriteLine("This example of\n  Convert.ToSingle( String ) and \n"
            + "  Convert.ToSingle( String, IFormatProvider ) \n" 
            + "generates the following output when run in the " 
            + "[{0}] culture.", CultureInfo.get_CurrentCulture().get_Name());
        Console.WriteLine(("\nSeveral " 
            + "strings are converted to float values, using \n" 
            + "default formatting and a NumberFormatInfo object.\n"));
        Console.WriteLine(formatter, "String to convert", "Default/exception", 
            "Provider/exception");
        Console.WriteLine(formatter, "-----------------", "-----------------", 
            "------------------");
      
        // Convert strings, with and without an IFormatProvider.
        ConvertToSingle("1234567", provider);
        ConvertToSingle("1234.567", provider);
        ConvertToSingle("1234,567", provider);
        ConvertToSingle("12,345.67", provider);
        ConvertToSingle("12.345,67", provider);
        ConvertToSingle("1,234,567.89", provider);
        ConvertToSingle("1.234.567,89", provider);
    } //main
} //ToSingleProviderDemo

/*
This example of
  Convert.ToSingle( String ) and
  Convert.ToSingle( String, IFormatProvider )
generates the following output when run in the [en-US] culture.

Several strings are converted to float values, using
default formatting and a NumberFormatInfo object.

String to convert     Default/exception   Provider/exception
-----------------     -----------------   ------------------
1234567               1234567             1234567
1234.567              1234.567            1234567
1234,567              1234567             1234.567
12,345.67             12345.67            FormatException
12.345,67             FormatException      12345.67
1,234,567.89          1234568             FormatException
1.234.567,89          FormatException      1234568
*/

Platforms

Windows 98, Windows Server 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

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

Version Information

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

XNA Framework

Supported in: 1.0

Reference

Convert Class
Convert Members
System Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Content Add

FAQ