Decimal::Parse Method (String^, NumberStyles)
Converts the string representation of a number in a specified style to its Decimal equivalent.
Assembly: mscorlib (in mscorlib.dll)
Parameters
- s
-
Type:
System::String^
The string representation of the number to convert.
- style
-
Type:
System.Globalization::NumberStyles
A bitwise combination of NumberStyles values that indicates the style elements that can be present in s. A typical value to specify is Number.
Return Value
Type: System::DecimalThe Decimal number equivalent to the number contained in s as specified by style.
| Exception | Condition |
|---|---|
| ArgumentNullException | s is null. |
| ArgumentException | |
| FormatException | s is not in the correct format. |
| OverflowException |
The style parameter defines the style elements (such as thousands separators, white space, and currency symbols) that are allowed in the s parameter for the parse operation to succeed. It must be a combination of bit flags from the NumberStyles enumeration. The following NumberStyles members are not supported:
Depending on the value of style, the s parameter may include the following elements:
[ws][$][sign][digits,]digits[.fractional-digits][e[sign]digits][ws]
Elements in square brackets ([ and ]) are optional. The following table describes each element.
Element | Description |
|---|---|
ws | Optional white space. White space can appear at the beginning of s if style includes the NumberStyles::AllowLeadingWhite flag, and it can appear at the end of s if style includes the NumberStyles::AllowTrailingWhite flag. |
$ | A culture-specific currency symbol. Its position in the string is defined by the NumberFormatInfo::CurrencyNegativePattern and NumberFormatInfo::CurrencyPositivePattern properties of the current culture. The current culture's currency symbol can appear in s if style includes the NumberStyles::AllowCurrencySymbol flag. |
sign | An optional sign. The sign can appear at the beginning of s if style includes the NumberStyles::AllowLeadingSign flag, and it can appear at the end of s if style includes the NumberStyles::AllowTrailingSign flag. Parentheses can be used in s to indicate a negative value if style includes the NumberStyles::AllowParentheses flag. |
digits | A sequence of digits ranging from 0 to 9. |
, | A culture-specific thousands separator symbol. The current culture's thousands separator can appear in s if style includes the NumberStyles::AllowThousands flag. |
. | A culture-specific decimal point symbol. The current culture's decimal point symbol can appear in s if style includes the NumberStyles::AllowDecimalPoint flag. |
fractional-digits | A sequence of digits ranging from 0 to 9. Fractional digits can appear in s only if style includes the NumberStyles::AllowDecimalPoint flag. |
e | The 'e' or 'E' character, which indicates that the value is represented in exponential notation. The s parameter can represent a number in exponential notation if style includes the NumberStyles::AllowExponent flag. |
A string with digits only (which corresponds to the None style) always parses successfully. The remaining NumberStyles members control elements that may be but are not required to be present in the input string. The following table indicates how individual NumberStyles members affect the elements that may be present in s.
NumberStyles value | Elements permitted in s in addition to digits |
|---|---|
The digits element only. | |
The . and fractional-digits elements. | |
The s parameter can also use exponential notation. This flag supports values in the form digitsEdigits; additional flags are needed to successfully parse strings with elements such as positive or negative signs and decimal point symbols. | |
The ws element at the beginning of s. | |
The ws element at the end of s. | |
The sign element at the beginning of s. | |
The sign element at the end of s. | |
The sign element in the form of parentheses enclosing the numeric value. | |
The , element. | |
The $ element. | |
All. The s parameter cannot represent a hexadecimal number or a number in exponential notation. | |
The ws element at the beginning or end of s, sign at the beginning of s, and the . symbol. The s parameter can also use exponential notation. | |
The ws, sign, ,, and . elements. | |
All styles, except s cannot represent a hexadecimal number. |
The s parameter is parsed using the formatting information in a NumberFormatInfo object initialized for the current system culture. For more information, see CurrentInfo.
A Decimal has 29 digits of precision. If s represents a number that has more than 29 digits, but has a fractional part and is within the range of MaxValue and MinValue, the number is rounded, not truncated, to 29 digits using rounding to nearest.
If a separator is encountered in the s parameter during a parse operation, styles includes the NumberStyles::AllowThousands and NumberStyles::AllowDecimalPoint values, and the applicable currency or number decimal and group separators are the same, the parse operation assumes that the separator is a decimal separator rather than a group separator. For more information about separators, see CurrencyDecimalSeparator, NumberDecimalSeparator, CurrencyGroupSeparator, and NumberGroupSeparator.
Available since 8
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1