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

Definição

Espaço de Nomes:
Microsoft.VisualBasic
Assemblagem:
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 quantos lugares são exibidos à direita do decimal. O valor padrão é -1, o que indica que as definições regionais do computador são usadas.

IncludeLeadingDigit
TriState

Optional. TriState enumeração que indica se um zero à esquerda é ou não apresentado para valores fracionários. Consulte "Observações" para valores.

UseParensForNegativeNumbers
TriState

Optional. TriState enumeração que indica se deve ou não colocar valores negativos entre parênteses. Consulte "Observações" para valores.

GroupDigits
TriState

Optional. TriState enumeração que indica se os números estão ou não agrupados usando o delimitador de grupo especificado nas definições regionais do computador. Consulte "Observações" para valores.

Devoluções

String

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

Exceções

ArgumentException

O número de dígitos após a vírgula decimal é superior a 99.

InvalidCastException

O tipo não é numérico.

Exemplos

O exemplo seguinte ilustra a utilização 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)

Observações

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

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

Note

Todas as informações de definições provêm da localização da aplicação. Por defeito, esse será o local definido no painel de controlo. No entanto, pode ser alterado programaticamente usando o .NET Framework, exceto o zero à esquerda, que vem do separador Number.

Os IncludeLeadingDigitargumentos , UseParensForNegativeNumbers, e GroupDigits tomam os seguintes valores de enumeração TriState.

Value Description
TriState.True Verdade
TriState.False Falso
TriState.UseDefault Configurações regionais do computador

Aplica-se a

Ver também