Глобальный контекст.ПолучитьСклоненияСтрокиПоЧислу (Global context.GetStringDeclensionsByNumber)

Глобальный контекст (Global context)

ПолучитьСклоненияСтрокиПоЧислу (GetStringDeclensionsByNumber)

Доступен, начиная с версии 8.3.14.

Синтаксис:

ПолучитьСклоненияСтрокиПоЧислу(<СклоняемаяСтрока>, <Число>, <СклоняемыеЕдиницыИзмерения>, <ОписаниеСтроки>, <ФорматнаяСтрока>, <ФорматнаяСтрокаЧисла>)

Параметры:

<СклоняемаяСтрока> (обязательный)

Тип: Строка.
Содержит строку, которую требуется согласовать и просклонять.

<Число> (обязательный)

Тип: Число.
Содержит число, относительно которого будет выполнено согласование и склонение строки.

<СклоняемыеЕдиницыИзмерения> (необязательный)

Тип: Строка.
Содержит строку с единицей измерения, которую необходимо согласовать и просклонять. Также поддерживается передача нескольких единиц измерения в следующем виде (перечисляются через запятую):

Единица измерения для целой части (Например, "килограмм").
Единица измерения для дробной части (Например, "грамм").
Количество разрядов дробной части (Может отсутствовать, по умолчанию - 2).

В результате, общая строка параметра будет выглядеть так: "килограмм, грамм, 2".

<ОписаниеСтроки> (необязательный)

Тип: Строка.
Содержит информацию о строке, которую нужно обработать.
Каждый параметр задается именем параметра, символом "=" (равно) и значением параметра. Параметры перечисляются через символ ";" (точка с запятой).
Допустимые параметры:

Л (L) - Код локализации. По умолчанию используется код локализации информационной базы. Примеры кодов локализации: ru_RU - Русский (Россия), en_US - Английский (США). В настоящий момент поддерживается только русский язык. Если код локализации не указан, то используется текущая локализация информационной базы.
ЧС (NM) – тип числительного. Возможные варианты:
- Количественное (Cardinal) - Используется для целых и дробных значений.
- Порядковое (Ordinal) - Используется только для целых значений.
Если тип числительного не указан, то в качестве параметра будет использовано количественное числительное. Если переданное число является дробью и указано, что оно является порядковым числительным, то будет сгенерировано исключение.

<ФорматнаяСтрока> (необязательный)

Тип: Строка.
Содержит параметры форматирования.
Каждый параметр задается именем параметра, символом "=" (равно) и значением параметра. Параметры перечисляются через символ ";" (точка с запятой).
Допустимы следующие параметры:

ПД (CS) – Падеж. Если не указан, то выполняется только согласование и возвращается форма именительного падежа. Возможные значения:
- Именительный (Nominative),
- Родительный (Genitive),
- Дательный (Dative),
- Винительный (Accusative),
- Творительный (Instrumental),
- Предложный (Prepositional).
ПЧ (NP) – представление числа. Если не указано, то используется "Авто". Возможные варианты:
- Число (Number) - числительное будет записано цифрами.
- ЧислоПрописью (NumberInWords) - числительное будет записано прописью (Например, "120" - "сто двадцать").
- ЧислоСОкончанием (NumberWithEnding) - числительное будет записано с окончанием:
  - Для порядкового числительного (ЧС=Порядковое - если предпоследняя буква в окончании является согласной, то формируется двухбуквенное наращение окончания (Например, "двенадцатого автомобиля" - "12-го автомобиля").
  - Для порядкового числительного (ЧС=Порядковое) - если предпоследняя буква в окончании является гласной, то формируется однобуквенное наращение окончания (Например, "двенадцатый автомобиль" – "12-й автомобиль").
  - Для количественного числительного (ЧС=Количественное): генерируется исключение о невозможности использования параметров <ЧС=Количественное> и <ПЧ=ЧислоСОкончанием> вместе.
- Авто (Auto) - для порядковых числительных используется "ЧислоСОкончанием", для количественных - "Число".

<ФорматнаяСтрокаЧисла> (необязательный)

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

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

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

Описание:

Склоняет переданное сочетание числа и строки в указанном падеже.

Доступность:

Сервер, толстый клиент, внешнее соединение, интеграция.

Пример:

Результат = ПолучитьСклоненияСтрокиПоЧислу("стул", 12, "",
    "ЧС=Порядковое", "ПД=Родительный; ПЧ=ЧислоСОкончанием");
// Результат будет содержать массив со строкой "12-го стула".

Результат = ПолучитьСклоненияСтрокиПоЧислу("автомобиль", 5, "",
    "ЧС=Количественное", "ПД=Дательный; ПЧ=ЧислоПрописью");
// Результат будет содержать массив со строкой "пяти автомобилям".

Результат = ПолучитьСклоненияСтрокиПоЧислу("медный купорос", 3.5,
    "килограмм, грамм, 2", "ЧС=Количественное", "ПД=Винительный;
    ПЧ=ЧислоПрописью");
// Результат будет содержать массив со строкой "три килограмма

//пятьдесят граммов медного купороса".".

Использование в версии:

Доступен, начиная с версии 8.3.14.

Методическая информация