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

Definição

Namespace:

Microsoft.VisualBasic

Assembly:

Microsoft.VisualBasic.Core.dll

Origem:

Strings.vb

Retorna uma expressão formatada como um número.

public static string FormatNumber (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 FormatNumber : obj * int * Microsoft.VisualBasic.TriState * Microsoft.VisualBasic.TriState * Microsoft.VisualBasic.TriState -> string

Public Function FormatNumber (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

Obrigatórios. Expressão a ser formatada.

NumDigitsAfterDecimal

Int32

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

IncludeLeadingDigit

TriState

Opcional. A constante TriState que indica se um 0 à esquerda é exibido para valores fracionários. Consulte “Configurações” para obter os valores.

UseParensForNegativeNumbers

TriState

Opcional. A constante TriState que indica se é necessário colocar valores negativos entre parênteses. Consulte “Configurações” para obter os valores.

GroupDigits

TriState

Opcional. A constante TriState que indica se os números são agrupados usando o delimitador de grupo especificado nas configurações de localidade ou não. Consulte “Configurações” para obter os valores.

Retornos

String

Uma expressão formatada como um número.

Exceções

InvalidCastException

O tipo não é numérico.

Exemplos

Este exemplo demonstra a FormatNumber função .

Dim testNumber As Integer = 45600
' Returns "45,600.00".
Dim testString As String = FormatNumber(testNumber, 2, , , TriState.True)

Comentários

Quando um ou mais argumentos opcionais são omitidos, os valores para argumentos omitidos são fornecidos pelas configurações de localidade.

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.

Os IncludeLeadingDigitargumentos , UseParensForNegativeNumberse GroupDigits têm as seguintes configurações.

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

Confira também

• FormatCurrency(Object, Int32, TriState, TriState, TriState)
• FormatDateTime(DateTime, DateFormat)
• FormatPercent(Object, Int32, TriState, TriState, TriState)
• TriState
• InvalidCastException
• Resumo de manipulação da cadeia de caracteres