Функция FormatCurrency (Visual Basic)

Статья
11/05/2008

Обновлен: Ноябрь 2007

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

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

Параметры

Expression
Обязательный параметр. Выражение, подлежащее форматированию.
NumDigitsAfterDecimal
Необязательный параметр. Числовое значение, указывающее количество цифр, которые должны быть отображены справа от десятичного разделителя. По умолчанию используется значение –1, указывающее на необходимость использования региональных настроек компьютера.
IncludeLeadingDigit
Необязательный параметр. Перечисление Tristate, указывающее, следует ли отображать ноль перед дробными значениями. Значения см. в разделе "Параметры".
UseParensForNegativeNumbers
Необязательный параметр. Перечисление Tristate, указывающее, следует ли заключать отрицательные числа в скобки. Значения см. в разделе "Параметры".
GroupDigits
Необязательный параметр. Перечисление Tristate, указывающее, следует ли группировать числа, используя разделитель групп, заданный в региональных настройках компьютера. Значения см. в разделе "Параметры".

Параметры

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

Значение	Описание
TriState.True	Истина
TriState.False	Ложь
TriState.UseDefault	Региональные параметры, установленные на компьютере

Исключения

Тип исключения	Номер ошибки	Условия
ArgumentException	5	Число цифр после десятичного разделителя превышает 99.
InvalidCastException	13	Тип не является числовым.

См. столбец "Номер ошибки", если выполняется обновление приложений Visual Basic 6.0, в которых используется неструктурированная обработка ошибок. (Номер ошибки можно сравнить со значением Свойство Number (объект Err).) Тем не менее, по возможности следует заменить эту систему работы с ошибками на Обзор структурной обработки исключений в Visual Basic.

Заметки

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

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

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

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

Пример

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

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