форматВалюты

Функция форматВалюты преобразует числовое значение в денежную сумму в выбранном формате.

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

Синтаксис

форматВалюты(число, формат, падеж, разделительТысяч)

Параметры:

• число — числовое значение, которое необходимо отформатировать;
• формат — формат отображения денежной суммы;
• падеж — падеж, в котором необходимо вывести название валюты;
• разделительТысяч — определяет, нужно ли разделять разряды числа пробелами.

Для параметра формат доступны следующие значения:

Значение	Результат
ФорматВалюты.БезКопеек	1 234 (одна тысяча двести тридцать четыре) рубля
ФорматВалюты.Длинный	1 234 (одна тысяча двести тридцать четыре) рубля 57 копеек
ФорматВалюты.ДлинныйКопейкиСокращенно	1 234 (одна тысяча двести тридцать четыре) рубля 57 коп.
ФорматВалюты.Краткий	1 234 руб. 57 коп.
ФорматВалюты.РублиПрописью	одна тысяча двести тридцать четыре рубля 57 копеек
ФорматВалюты.Числовой	1 234,57 ₽
ФорматВалюты.ЧисловойБезВалюты	1 234,57

Для параметра падеж доступны следующие значения:

Значение	Вопрос
Падеж.Именительный	кто? что?
Падеж.Родительный	кого? чего?
Падеж.Дательный	кому? чему?
Падеж.Винительный	кого? что?
Падеж.Творительный	кем? чем?
Падеж.Предложный	о ком? о чём?

Для параметра разделительТысяч доступны следующие значения:

• РазделительТысяч.Отобразить — разделять разряды числа пробелами;
• РазделительТысяч.Скрыть — выводить число без разделителей тысяч.

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

Функция возвращает текстовое значение с денежной суммой в выбранном формате.

Например, если поле сумма содержит:

1234,57

выражение:

форматВалюты(
    сумма,
    ФорматВалюты.Краткий,
    Падеж.Именительный,
    РазделительТысяч.Отобразить
)

вернёт:

1 234 руб. 57 коп.

Особенности

Параметр падеж изменяет форму названия рублей и копеек. Само числовое значение суммы при этом не изменяется.

Параметр разделительТысяч влияет на отображение разрядов в числовой части суммы.

Например, при значении:

РазделительТысяч.Отобразить

число выводится так:

1 234,57

При значении:

РазделительТысяч.Скрыть

разделитель между разрядами не отображается:

1234,57

Примеры

Сумма цифрами и прописью

Если поле сумма содержит:

1234,57

выражение:

форматВалюты(
    сумма,
    ФорматВалюты.Длинный,
    Падеж.Именительный,
    РазделительТысяч.Отобразить
)

вернёт:

1 234 (одна тысяча двести тридцать четыре) рубля 57 копеек

Сумма прописью

Если поле сумма содержит:

1234,57

выражение:

форматВалюты(
    сумма,
    ФорматВалюты.РублиПрописью,
    Падеж.Именительный,
    РазделительТысяч.Отобразить
)

вернёт:

одна тысяча двести тридцать четыре рубля 57 копеек

Сумма без обозначения валюты

Если поле сумма содержит:

1234,57

выражение:

форматВалюты(
    сумма,
    ФорматВалюты.ЧисловойБезВалюты,
    Падеж.Именительный,
    РазделительТысяч.Отобразить
)

вернёт:

1 234,57

Связь с другими функциями

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

Например, перед форматированием сумму можно округлить:

форматВалюты(
    округлить(сумма, 2),
    ФорматВалюты.Краткий,
    Падеж.Именительный,
    РазделительТысяч.Отобразить
)

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