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

Definición

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

Devuelve una expresión con formato de número.Returns an expression formatted as a number.

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);
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

Obligatorio.Required. Expresión a la que se debe dar formato.Expression to be formatted.

NumDigitsAfterDecimal
Int32

Opcional.Optional. Valor numérico que indica el número de posiciones que se muestran a la derecha del separador decimal.Numeric value indicating how many places are displayed to the right of the decimal. El valor predeterminado es -1, que indica que se utiliza la configuración regional del equipo.The default value is -1, which indicates that the computer's regional settings are used.

IncludeLeadingDigit
TriState

Opcional.Optional. Constante TriState que indica si se muestra un 0 inicial para los valores fraccionarios.TriState constant that indicates whether a leading 0 is displayed for fractional values. Consulte los valores en "Configuración".See "Settings" for values.

UseParensForNegativeNumbers
TriState

Opcional.Optional. Constante TriState que indica si los valores negativos se van a colocar entre paréntesis.TriState constant that indicates whether to place negative values within parentheses. Consulte los valores en "Configuración".See "Settings" for values.

GroupDigits
TriState

Opcional.Optional. Constante TriState que indica si los números se agrupan o no mediante el delimitador de grupo especificado en la configuración regional.TriState constant that indicates whether or not numbers are grouped using the group delimiter specified in the locale settings. Consulte los valores en "Configuración".See "Settings" for values.

Devoluciones

String

Expresión con formato de número.An expression formatted as a number.

Excepciones

InvalidCastException

El tipo no es numérico.Type is not numeric.

Ejemplos

En este ejemplo se muestra la FormatNumber función.This example demonstrates the FormatNumber function.

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

Comentarios

Cuando se omiten uno o más argumentos opcionales, los valores de configuración regional proporcionan los valores de los argumentos omitidos.When one or more optional arguments are omitted the values for omitted arguments are provided by the locale settings.

Nota

Toda la información de configuración procede de la configuración regional de la aplicación.All settings information comes from the locale of the application. De forma predeterminada, será la configuración regional establecida en el panel de control.By default, that will be the locale set in the control panel. Sin embargo, se puede cambiar mediante programación con el .NET Framework.However, it may be changed programmatically by using the .NET Framework.

Los IncludeLeadingDigit UseParensForNegativeNumbers argumentos, y GroupDigits tienen la siguiente configuración.The IncludeLeadingDigit, UseParensForNegativeNumbers, and GroupDigits arguments have the following settings.

ConstanteConstant DescripciónDescription
TriState.True TrueTrue
TriState.False FalseFalse
TriState.UseDefault La configuración regional del equipoThe computer's regional settings

Se aplica a

Consulte también