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

Необязательный элемент. Числовое значение, указывающее количество цифр, которые должны быть отображены справа от десятичного разделителя. По умолчанию используется значение –1, указывающее на использование региональных настроек компьютера.

IncludeLeadingDigit

TriState

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

UseParensForNegativeNumbers

TriState

Необязательный элемент. Перечисление TriState, указывающее, следует ли заключать отрицательные значения в скобки. Значения см. в разделе "Примечания".

GroupDigits

TriState

Необязательный элемент. Перечисление 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)

Комментарии

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

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

Примечание

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

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

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

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

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