Int16.Parse Method (String, NumberStyles)
Microsoft Silverlight will reach end of support after October 2021. Learn more.
Converts the string representation of a number in a specified style to its 16-bit signed integer equivalent.
Namespace: System
Assembly: mscorlib (in mscorlib.dll)
Syntax
'Declaration
Public Shared Function Parse ( _
s As String, _
style As NumberStyles _
) As Short
public static short Parse(
string s,
NumberStyles style
)
Parameters
- s
Type: System.String
A string containing a number to convert.
- style
Type: System.Globalization.NumberStyles
A bitwise combination of the enumeration values that indicates the style elements that can be present in s. A typical value to specify is NumberStyles.Integer.
Return Value
Type: System.Int16
A 16-bit signed integer equivalent to the number specified in s.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentNullException | s is nulla null reference (Nothing in Visual Basic). |
| ArgumentException | style is not a NumberStyles value. -or- style is not a combination of AllowHexSpecifier and HexNumber values. |
| FormatException | s is not in a format compliant with style. |
| OverflowException | s represents a number less than MinValue or greater than MaxValue. -or- s includes non-zero fractional digits. |
Remarks
The style parameter defines the style elements (such as white space or a sign symbol) 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. Depending on the value of style, the s parameter may include the following elements:
[ws][$][sign][digits,]digits[.fractional_digits][e[sign]digits][ws]
Or, if style includes AllowHexSpecifier:
[ws]hexdigits[ws]
Items 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, or 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.CurrencyPositivePattern and NumberFormatInfo.CurrencyNegativePattern property 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 from 0 through 9. |
, |
A culture-specific thousands separator symbol. The current culture's thousands separator symbol 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 the 0 digit. Fractional digits can appear in s if style includes the NumberStyles.AllowDecimalPoint flag. If any digit other than 0 appears in fractional_digits, the method throws an OverflowException. |
e |
The 'e' or 'E' character, which indicates that s can be represented in exponential notation. The s parameter can represent a number in exponential notation if style includes the NumberStyles.AllowExponent flag. However, s must represent a number in the range of the Int16 data type and cannot have a non-zero fractional component. |
hexdigits |
A sequence of hexadecimal digits from 0 through f, or 0 through F. |
A string with digits only (which corresponds to the NumberStyles.None style) always parses successfully. Most of the remaining NumberStyles members control elements that may be but are not required to be present in this input string. The following table indicates how individual NumberStyles members affect the elements that may be present in s.
Non-composite NumberStyles values |
Elements permitted in s in addition to digits |
|---|---|
Decimal digits only. |
|
The . and fractional_digits elements. However, fractional_digits must consist of only one or more 0 digits or an OverflowException is thrown. |
|
The s parameter can also use exponential notation. |
|
The ws element at the beginning of s. |
|
The ws element at the end of s. |
|
A sign can appear before digits. |
|
A sign can appear after digits. |
|
The sign element in the form of parentheses enclosing the numeric value. |
|
The , element. |
|
The $ element. |
If the NumberStyles.AllowHexSpecifier flag is used, s must be the string representation of a hexadecimal value. The only other flags that can be present in style are NumberStyles.AllowLeadingWhite and NumberStyles.AllowTrailingWhite. (The NumberStyles enumeration has a composite number style, NumberStyles.HexNumber, that includes both white space flags.)
The s parameter is parsed using the formatting information in a NumberFormatInfo object that is initialized for the current system culture. For more information, see NumberFormatInfo.CurrentInfo. To parse s using the formatting information of a specific culture, call the Int16.Parse(String, NumberStyles, IFormatProvider) method.
Examples
The following example uses the Int16.Parse(String, NumberStyles) method to parse the string representations of Int16 values using the en-US culture.
Imports System.Globalization
Module Example
Public Sub Demo(ByVal outputBlock As System.Windows.Controls.TextBlock)
Dim value As String
Dim style As NumberStyles
' Parse a number with a thousands separator (throws an exception).
value = "14,644"
style = NumberStyles.None
ParseToInt16(outputBlock, value, style)
style = NumberStyles.AllowThousands
ParseToInt16(outputBlock, value, style)
' Parse a number with a thousands separator and decimal point.
value = "14,644.00"
style = NumberStyles.AllowThousands Or NumberStyles.Integer Or _
NumberStyles.AllowDecimalPoint
ParseToInt16(outputBlock, value, style)
' Parse a number with a fractional component (throws an exception).
value = "14,644.001"
ParseToInt16(outputBlock, value, style)
' Parse a number in exponential notation.
value = "145E02"
style = style Or NumberStyles.AllowExponent
ParseToInt16(outputBlock, value, style)
' Parse a number in exponential notation with a positive sign.
value = "145E+02"
ParseToInt16(outputBlock, value, style)
' Parse a number in exponential notation with a negative sign
' (throws an exception).
value = "145E-02"
ParseToInt16(outputBlock, value, style)
End Sub
Private Sub ParseToInt16(ByVal outputBlock As System.Windows.Controls.TextBlock, ByVal value As String, ByVal style As NumberStyles)
Try
Dim number As Short = Int16.Parse(value, style)
outputBlock.Text += String.Format("Converted '{0}' to {1}.", value, number) & vbCrLf
Catch e As FormatException
outputBlock.Text += String.Format("Unable to parse '{0}' with style {1}.", value, _
style.ToString()) & vbCrLf
Catch e As OverflowException
outputBlock.Text += String.Format("'{0}' is out of range of the Int16 type.", value) & vbCrLf
End Try
End Sub
End Module
' The example displays the following output:
' Unable to parse '14,644' with style None.
' Converted '14,644' to 14644.
' Converted '14,644.00' to 14644.
' '14,644.001' is out of range of the Int16 type.
' Converted '145E02' to 14500.
' Converted '145E+02' to 14500.
' '145E-02' is out of range of the Int16 type.
using System;
using System.Globalization;
public class Example
{
public static void Demo(System.Windows.Controls.TextBlock outputBlock)
{
string value;
NumberStyles style;
// Parse a number with a thousands separator (throws an exception).
value = "14,644";
style = NumberStyles.None;
ParseToInt16(outputBlock, value, style);
style = NumberStyles.AllowThousands;
ParseToInt16(outputBlock, value, style);
// Parse a number with a thousands separator and decimal point.
value = "14,644.00";
style = NumberStyles.AllowThousands | NumberStyles.Integer |
NumberStyles.AllowDecimalPoint;
ParseToInt16(outputBlock, value, style);
// Parse a number with a fractional component (throws an exception).
value = "14,644.001";
ParseToInt16(outputBlock, value, style);
// Parse a number in exponential notation.
value = "145E02";
style = style | NumberStyles.AllowExponent;
ParseToInt16(outputBlock, value, style);
// Parse a number in exponential notation with a positive sign.
value = "145E+02";
ParseToInt16(outputBlock, value, style);
// Parse a number in exponential notation with a negative sign
// (throws an exception).
value = "145E-02";
ParseToInt16(outputBlock, value, style);
}
private static void ParseToInt16(System.Windows.Controls.TextBlock outputBlock, string value, NumberStyles style)
{
try
{
short number = Int16.Parse(value, style);
outputBlock.Text += String.Format("Converted '{0}' to {1}.", value, number) + "\n";
}
catch (FormatException)
{
outputBlock.Text += String.Format("Unable to parse '{0}' with style {1}.", value,
style.ToString()) + "\n";
}
catch (OverflowException)
{
outputBlock.Text += String.Format("'{0}' is out of range of the Int16 type.", value) + "\n";
}
}
}
// The example displays the following output:
// Unable to parse '14,644' with style None.
// Converted '14,644' to 14644.
// Converted '14,644.00' to 14644.
// '14,644.001' is out of range of the Int16 type.
// Converted '145E02' to 14500.
// Converted '145E+02' to 14500.
// '145E-02' is out of range of the Int16 type.
Version Information
Silverlight
Supported in: 5, 4, 3
Silverlight for Windows Phone
Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0
XNA Framework
Supported in: Xbox 360, Windows Phone OS 7.0
Platforms
For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.
See Also