Strings.FormatNumber(Object, Int32, TriState, TriState, TriState) Método

Definición

Espacio de nombres:
Microsoft.VisualBasic
Ensamblado:
Microsoft.VisualBasic.dll

Devuelve una expresión con formato de número.

public static string FormatNumber(object Expression, int NumDigitsAfterDecimal = -1, Microsoft.VisualBasic.TriState IncludeLeadingDigit = Microsoft.VisualBasic.TriState.UseDefault, Microsoft.VisualBasic.TriState UseParensForNegativeNumbers = Microsoft.VisualBasic.TriState.UseDefault, Microsoft.VisualBasic.TriState GroupDigits = Microsoft.VisualBasic.TriState.UseDefault);
static member FormatNumber : obj * int * Microsoft.VisualBasic.TriState * Microsoft.VisualBasic.TriState * Microsoft.VisualBasic.TriState -> string
Public Function FormatNumber (Expression As Object, Optional NumDigitsAfterDecimal As Integer = -1, Optional IncludeLeadingDigit As TriState = Microsoft.VisualBasic.TriState.UseDefault, Optional UseParensForNegativeNumbers As TriState = Microsoft.VisualBasic.TriState.UseDefault, Optional GroupDigits As TriState = Microsoft.VisualBasic.TriState.UseDefault) As String

Parámetros

Expression
Object

Required. Expresión a la que se va a dar formato.

NumDigitsAfterDecimal
Int32

Optional. Valor numérico que indica cuántos lugares se muestran a la derecha del decimal. El valor predeterminado es -1, que indica que se usa la configuración regional del equipo.

IncludeLeadingDigit
TriState

Optional. TriState constante que indica si se muestra un 0 inicial para los valores fraccionarios. Consulte "Configuración" para ver los valores.

UseParensForNegativeNumbers
TriState

Optional. TriState constante que indica si se deben colocar valores negativos entre paréntesis. Consulte "Configuración" para ver los valores.

GroupDigits
TriState

Optional. TriState constante que indica si los números se agrupan mediante el delimitador de grupo especificado en la configuración regional. Consulte "Configuración" para ver los valores.

Devoluciones

String

Expresión con formato de número.

Excepciones

InvalidCastException

El tipo no es numérico.

Ejemplos

En este ejemplo se muestra la FormatNumber función .

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

Comentarios

Cuando se omiten uno o varios argumentos opcionales, los valores de los argumentos omitidos se proporcionan mediante la configuración regional.

Nota:

Toda la información de configuración procede de la configuración regional de la aplicación. De forma predeterminada, será la configuración regional establecida en el panel de control. Sin embargo, se puede cambiar mediante programación mediante el uso de .NET Framework.

Los IncludeLeadingDigitargumentos , UseParensForNegativeNumbersy GroupDigits tienen la siguiente configuración.

Constante Description
TriState.True Cierto
TriState.False Falso
TriState.UseDefault Configuración regional del equipo

Se aplica a

Consulte también