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

  • Referencia

Definición

Espacio de nombres:
Microsoft.VisualBasic
Ensamblado:
Microsoft.VisualBasic.Core.dll
Ensamblado:
Microsoft.VisualBasic.dll
Source:
Strings.vb
Source:
Strings.vb
Source:
Strings.vb

Devuelve una expresión con formato de moneda en la que se utilizará el símbolo de moneda que se haya definido en el panel de control del sistema.

public static string FormatCurrency (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 FormatCurrency (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 FormatCurrency : obj * int * Microsoft.VisualBasic.TriState * Microsoft.VisualBasic.TriState * Microsoft.VisualBasic.TriState -> string
Public Function FormatCurrency (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. Expresión a la que se debe dar formato.

NumDigitsAfterDecimal
Int32

Opcional. Valor numérico que indica el número de posiciones que se muestran a la derecha del separador decimal. El valor predeterminado es -1, que indica que se utiliza la configuración regional del equipo.

IncludeLeadingDigit
TriState

Opcional. Enumeración de TriState que indica si se muestra un cero inicial o no para los valores fraccionarios. Vea los valores en la sección "Comentarios".

UseParensForNegativeNumbers
TriState

Opcional. Enumeración TriState que indica si los valores negativos se van a colocar entre paréntesis o no. Vea los valores en la sección "Comentarios".

GroupDigits
TriState

Opcional. Enumeración TriState que indica si los números se agrupan o no mediante el delimitador de grupo especificado en la configuración regional del equipo. Vea los valores en la sección "Comentarios".

Devoluciones

String

Expresión con formato de moneda en la que se utilizará el símbolo de moneda que se haya definido en el panel de control del sistema.

Excepciones

ArgumentException

El número de dígitos situados a continuación del signo decimal es mayor que 99.

InvalidCastException

El tipo no es numérico.

Ejemplos

En el siguiente ejemplo se muestra el uso de la función FormatCurrency.

Dim testDebt As Double = -4456.43
Dim testString As String
' Returns "($4,456.43)".
testString = FormatCurrency(testDebt, , , TriState.True, TriState.True)

Comentarios

Cuando se omiten uno o varios argumentos opcionales, se usan en su lugar los valores de configuración regional coincidentes del equipo.

La posición del símbolo de moneda en relación con el valor de moneda viene determinada por la configuración regional del sistema.

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, excepto el cero inicial, que procede de la Number pestaña .

Los IncludeLeadingDigitargumentos , UseParensForNegativeNumbersy GroupDigits toman los siguientes valores de enumeración TriState.

Valor Descripción
TriState.True True
TriState.False False
TriState.UseDefault Configuración regional del equipo

Se aplica a

Consulte también