Função FormatCurrency (Visual Basic)

Artigo
08/25/2010

Retorna uma expressão formatada sistema autônomo um valor monetário usando o símbolo de moeda definido no painel de controle do sistema.

Function FormatCurrency(
   ByVal Expression As Object,
   Optional ByVal NumDigitsAfterDecimal As Integer = -1,
   Optional ByVal IncludeLeadingDigit As TriState = TriState.UseDefault,
   Optional ByVal UseParensForNegativeNumbers As TriState = TriState.UseDefault,
   Optional ByVal GroupDigits As TriState = TriState.UseDefault
) As String

Parâmetros

Expression
Obrigatório.Expressão a ser formatada.
NumDigitsAfterDecimal
Opcional.Valor numérico indicando quantas casas são exibidas à direita da vírgula decimal.Valor padrão é – 1, o que indica que as configurações regionais do computador são utilizadas.
IncludeLeadingDigit
Opcional.Enumeração TriState que indica se um zero entrelinhamento é exibido para valores fracionários.Consulte "Configurações" para os valores.
UseParensForNegativeNumbers
Opcional.Enumeração TriState que indica se deve ou não coloque os valores negativos entre parênteses.Consulte "Configurações" para os valores.
GroupDigits
Opcional.Enumeração TriState que indica se ou não números são agrupados usando o delimitador de agrupar especificado nas configurações regionais do computador.Consulte "Configurações" para os valores.

Configurações

The IncludeLeadingDigit, UseParensForNegativeNumbers, e GroupDigits argumentos levar os seguintes valores de enumeração TriState.

Valor	Descrição
TriState.True	True
TriState.False	False
TriState.UseDefault	As configurações regionais do computador

Exceções

Tipo de exceção	Número de erro	Condição
ArgumentException	5	Número de dígitos após o ponto decimal é maior que 99.
InvalidCastException	13	Tipo é não numérico.

Ver a coluna " número de erro " se você estiver atualizando aplicativos Visual Basic 6.0 que usam manipulação de erros não estruturada.(Você pode comparar o número do erro com a Propriedade do Número (Erro de objeto).) Entretanto, quando for possivel, você pode considerar substituir tal controle de erro por Visão Geral sobre a Manipulação Estruturada de Exceções para o Visual Basic.

Comentários

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

A posição do símbolo da moeda em relação ao valor de moeda é determinada pelas configurações regionais do sistema.

Observação:
Todas as informações de configuração vêm da localidade do aplicativo.Por padrão, este será o conjunto de localidade no Painel de controle.No entanto, pode ser alterada em programaticamente usando o .NET estrutura, exceto o zero entrelinhamento, que vem das Number guia.

Exemplo

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

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