Strings.FormatCurrency(Object, Int32, TriState, TriState, TriState) Strings.FormatCurrency(Object, Int32, TriState, TriState, TriState) Strings.FormatCurrency(Object, Int32, TriState, TriState, TriState) Method

Definición

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.Returns an expression formatted as a currency value using the currency symbol defined in the system control panel.

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 Object Object

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

NumDigitsAfterDecimal
Int32 Int32 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.Default value is -1, which indicates that the computer's regional settings are used.

IncludeLeadingDigit
TriState TriState TriState

Opcional.Optional. Enumeración de TriState que indica si se muestra un cero inicial o no para los valores fraccionarios.TriState enumeration that indicates whether or not a leading zero is displayed for fractional values. Vea los valores en la sección "Comentarios".See "Remarks" for values.

UseParensForNegativeNumbers
TriState TriState TriState

Opcional.Optional. Enumeración TriState que indica si los valores negativos se van a colocar entre paréntesis o no.TriState enumeration that indicates whether or not to place negative values within parentheses. Vea los valores en la sección "Comentarios".See "Remarks" for values.

GroupDigits
TriState TriState TriState

Opcional.Optional. 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.TriState enumeration that indicates whether or not numbers are grouped using the group delimiter specified in the computer's regional settings. Vea los valores en la sección "Comentarios".See "Remarks" for values.

Devoluciones

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.An expression formatted as a currency value using the currency symbol defined in the system control panel.

Excepciones

El número de dígitos situados a continuación del signo decimal es mayor que 99.Number of digits after decimal point is greater than 99.

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

Ejemplos

En el siguiente ejemplo se muestra el uso de la función FormatCurrency.The following example illustrates the use of the FormatCurrency function.

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 más argumentos opcionales, valores de configuración regional coincidente del equipo se usan en su lugar.When one or more optional arguments are omitted, the computer's matching regional-settings values are used instead.

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.The position of the currency symbol relative to the currency value is determined by the system's regional 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, que 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 utilizando .NET Framework, excepto el cero inicial, que procede la Number ficha.However, it may be changed programmatically by using the .NET Framework, except leading zero, which comes from the Number tab.

El IncludeLeadingDigit, UseParensForNegativeNumbers, y GroupDigits argumentos toman los siguientes valores de enumeración de tres estados.The IncludeLeadingDigit, UseParensForNegativeNumbers, and GroupDigits arguments take the following TriState enumeration values.

ValorValue DescripciónDescription
TriState.True TrueTrue
TriState.False FalseFalse
TriState.UseDefault Configuración regional del equipoThe computer's regional settings

Se aplica a

Consulte también: