Strings.FormatCurrency(Object, Int32, TriState, TriState, TriState) Метод

Определение

Пространство имен:

Microsoft.VisualBasic

Сборка:

Microsoft.VisualBasic.Core.dll

Исходный код:

Strings.vb

Данная функция возвращает выражение, отформатированное как денежное значение с использованием обозначения денежной единицы, заданного в панели управления.

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

Параметры

Expression

Object

Обязательно. Выражение, которое нужно отформатировать.

NumDigitsAfterDecimal

Int32

Optional. Числовое значение, указывающее, сколько мест отображается справа от десятичного разряда. Значение по умолчанию — -1, указывающее, что используются региональные параметры компьютера.

IncludeLeadingDigit

TriState

Optional. TriState перечисление, указывающее, отображается ли начальный ноль для дробных значений. Дополнительные сведения см. в разделе "Примечания".

UseParensForNegativeNumbers

TriState

Optional. TriState перечисление, указывающее, следует ли размещать отрицательные значения в скобках. Дополнительные сведения см. в разделе "Примечания".

GroupDigits

TriState

Optional. TriState перечисление, указывающее, группируются ли числа с помощью разделителя группы, указанного в региональных параметрах компьютера. Дополнительные сведения см. в разделе "Примечания".

Возвращаемое значение

String

Выражение отформатировано как значение валюты с помощью символа валюты, определенного на системной панели управления.

Исключения

ArgumentException

Число цифр после десятичной запятой больше 99.

InvalidCastException

Тип не является числовым.

Примеры

В следующем примере показано использование FormatCurrency функции.

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

Комментарии

Если один или несколько необязательных аргументов опущены, вместо этого используются соответствующие значения региональных параметров компьютера.

Положение обозначения денежной единицы относительно денежного значения определяется региональными параметрами компьютера.

Note

Все сведения о параметрах берутся из языкового стандарта приложения. По умолчанию это будет языковой стандарт, заданный на панели управления. Однако его можно изменить программным способом с помощью платформы .NET Framework, за исключением начальных нулей, поступающих с вкладки Number.

IncludeLeadingDigitАргументы UseParensForNegativeNumbersи GroupDigits аргументы принимают следующие значения перечисления TriState.

Ценность	Description
TriState.True	True
TriState.False	Неправда
TriState.UseDefault	Региональные параметры компьютера

См. также раздел

• FormatDateTime(DateTime, DateFormat)
• FormatNumber(Object, Int32, TriState, TriState, TriState)
• FormatPercent(Object, Int32, TriState, TriState, TriState)
• TriState
• Format(Object, String)
• ArgumentException
• InvalidCastException
• Операции со строками