This topic has not yet been rated - Rate this topic

Convert.ToDecimal Method (String, IFormatProvider)

Silverlight

Converts the specified String representation of a number to an equivalent Decimal number using the specified culture-specific formatting information.

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

Syntax

public static decimal ToDecimal(
	string value,
	IFormatProvider provider
)

Parameters

value: Type: System.String
A String containing a number to convert.

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

Return Value

Type: System.Decimal
A Decimal number equivalent to the value of value.
-or-
Zero if value is null.

Exceptions

Exception	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 Decimal.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 null, the NumberFormatInfo for the current culture is used.

If you prefer not to handle an exception if the conversion fails, you can call the Decimal.TryParse method instead. It returns a Boolean value that indicates whether the conversion succeeded or failed.

Examples

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


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

class Example
{
   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 ConvertToDecimal(System.Windows.Controls.TextBlock outputBlock, string numericStr,
       IFormatProvider provider)
   {
      object defaultValue;
      object providerValue;

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

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

      outputBlock.Text += String.Format(formatter, numericStr, defaultValue,
          providerValue) + "\n";
   }

   public static void Demo(System.Windows.Controls.TextBlock outputBlock)
   {
      // 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 };

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

      // Convert strings, with and without an IFormatProvider.
      ConvertToDecimal(outputBlock, "123456789", provider);
      ConvertToDecimal(outputBlock, "12345.6789", provider);
      ConvertToDecimal(outputBlock, "12345,6789", provider);
      ConvertToDecimal(outputBlock, "123,456.789", provider);
      ConvertToDecimal(outputBlock, "123.456,789", provider);
      ConvertToDecimal(outputBlock, "123,456,789.0123", provider);
      ConvertToDecimal(outputBlock, "123.456.789,0123", provider);
   }
}

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

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

String to convert     Default/exception   Provider/exception
-----------------     -----------------   ------------------
123456789             123456789           123456789
12345.6789            12345.6789          123456789
12345,6789            123456789           12345.6789
123,456.789           123456.789          FormatException
123.456,789           FormatException     123456.789
123,456,789.0123      123456789.0123      FormatException
123.456.789,0123      FormatException     123456789.0123
*/