Export (0) Print
Expand All

Strings.FormatNumber Method

Returns an expression formatted as a number.

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

'Declaration
Public Shared Function FormatNumber ( _
	Expression As Object, _
	<OptionalAttribute> Optional NumDigitsAfterDecimal As Integer = -1, _
	<OptionalAttribute> Optional IncludeLeadingDigit As TriState = TriState.UseDefault, _
	<OptionalAttribute> Optional UseParensForNegativeNumbers As TriState = TriState.UseDefault, _
	<OptionalAttribute> Optional GroupDigits As TriState = TriState.UseDefault _
) As String
'Usage
Dim Expression As Object
Dim NumDigitsAfterDecimal As Integer
Dim IncludeLeadingDigit As TriState
Dim UseParensForNegativeNumbers As TriState
Dim GroupDigits As TriState
Dim returnValue As String

returnValue = Strings.FormatNumber(Expression, NumDigitsAfterDecimal, IncludeLeadingDigit, UseParensForNegativeNumbers, GroupDigits)
public static String FormatNumber (
	Object Expression, 
	/** @attribute OptionalAttribute() */ int NumDigitsAfterDecimal, 
	/** @attribute OptionalAttribute() */ TriState IncludeLeadingDigit, 
	/** @attribute OptionalAttribute() */ TriState UseParensForNegativeNumbers, 
	/** @attribute OptionalAttribute() */ TriState GroupDigits
)
public static function FormatNumber (
	Expression : Object, 
	NumDigitsAfterDecimal : int, 
	IncludeLeadingDigit : TriState, 
	UseParensForNegativeNumbers : TriState, 
	GroupDigits : TriState
) : String
Not applicable.

Parameters

Expression

Required. Expression to be formatted.

NumDigitsAfterDecimal

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

Optional. TriState constant that indicates whether a leading 0 is displayed for fractional values. See "Settings" for values.

UseParensForNegativeNumbers

Optional. TriState constant that indicates whether to place negative values within parentheses. See "Settings" for values.

GroupDigits

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

Returns an expression formatted as a number.

For more detailed information, see the Visual Basic topic FormatNumber Function (Visual Basic).

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

NoteNote:

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

This example demonstrates the FormatNumber function.

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

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, 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.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft