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

Definição

Namespace:
Microsoft.VisualBasic
Assembly:
Microsoft.VisualBasic.dll

Devolve uma expressão formatada como um valor de moeda com o símbolo de moeda definido no painel de controlo do 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);
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

Required. Expressão a ser formatada.

NumDigitsAfterDecimal
Int32

Optional. Valor numérico que indica quantas casas são exibidas à direita da decimal. O valor padrão é -1, que indica que as configurações regionais do computador são usadas.

IncludeLeadingDigit
TriState

Optional. TriState enumeração que indica se um zero à esquerda é exibido ou não para valores fracionários. Consulte "Comentários" para obter valores.

UseParensForNegativeNumbers
TriState

Optional. TriState enumeração que indica se os valores negativos devem ou não ser colocados entre parênteses. Consulte "Comentários" para obter valores.

GroupDigits
TriState

Optional. TriState enumeração que indica se os números são ou não agrupados usando o delimitador de grupo especificado nas configurações regionais do computador. Consulte "Comentários" para obter valores.

Retornos

String

Uma expressão formatada como um valor de moeda usando o símbolo de moeda definido no painel de controle do sistema.

Exceções

ArgumentException

O número de dígitos após o ponto decimal é maior que 99.

InvalidCastException

O tipo não é numérico.

Exemplos

O exemplo a seguir ilustra o uso da FormatCurrency função.

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

Comentários

Quando um ou mais argumentos opcionais são omitidos, os valores de configurações regionais correspondentes do computador são usados.

A posição do símbolo de moeda relativa ao valor de moeda é determinada pelas definições regionais do sistema.

Observação

Todas as informações de configurações vêm da localidade do aplicativo. Por padrão, essa será a localidade definida no painel de controle. No entanto, ele pode ser alterado programaticamente usando o .NET Framework, exceto zero à esquerda, que vem da guia Number.

Os IncludeLeadingDigitargumentos e GroupDigits os UseParensForNegativeNumbersargumentos assumem os seguintes valores de enumeração TriState.

Valor Description
TriState.True Verdade
TriState.False Falso
TriState.UseDefault As configurações regionais do computador

Aplica-se a

Confira também