Article
11/18/2011

Strings.FormatNumber Method

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Returns an expression formatted as a number.

Namespace: Microsoft.VisualBasic
Assembly: Microsoft.VisualBasic (in Microsoft.VisualBasic.dll)

Syntax

'Declaration
Public Shared Function FormatNumber ( _
    Expression As Object, _
    NumDigitsAfterDecimal As Integer, _
    IncludeLeadingDigit As TriState, _
    UseParensForNegativeNumbers As TriState, _
    GroupDigits As TriState _
) As String

public static string FormatNumber(
    Object Expression,
    int NumDigitsAfterDecimal,
    TriState IncludeLeadingDigit,
    TriState UseParensForNegativeNumbers,
    TriState GroupDigits
)

Parameters

Expression
Type: System.Object
Required. Expression to be formatted.

NumDigitsAfterDecimal
Type: System.Int32
Optional. Numeric value indicating how many places are displayed to the right of the decimal. The default value is –1, which indicates that the computer's regional settings are used.

IncludeLeadingDigit
Type: Microsoft.VisualBasic.TriState
Optional. TriState constant that indicates whether a leading 0 is displayed for fractional values. See "Settings" for values.

UseParensForNegativeNumbers
Type: Microsoft.VisualBasic.TriState
Optional. TriState constant that indicates whether to place negative values within parentheses. See "Settings" for values.

GroupDigits
Type: Microsoft.VisualBasic.TriState
Optional. TriState constant that indicates whether or not numbers are grouped using the group delimiter specified in the locale settings. See "Settings" for values.

Return Value

Type: System.String
Returns an expression formatted as a number.

Remarks

When one or more optional arguments are omitted the values for omitted arguments are provided by the locale settings.

Note:
All settings information comes from the locale of the application. By default, that will be the locale set in the control panel. However, it may be changed programmatically by using the .NET Framework.

The IncludeLeadingDigit, UseParensForNegativeNumbers, and GroupDigits arguments have the following settings.

Constant	Description
TriState.True	True
TriState.False	False
TriState.UseDefault	The computer's regional settings

Examples

This example demonstrates the FormatNumber function.

Dim TestNumber As Integer = 45600
' Returns "45,600.00".
Dim TestString As String = FormatNumber(TestNumber, 2, , , TriState.True)

Version Information

Silverlight

Supported in: 5, 4, 3

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Share via