Общего назначения клиент сервер УХ

ВернутьАлфавитноЦифровоеПредставление

Описание, пример вызова

////////////////////////////////////////////////////////////////////////////////
// ПРОЦЕДУРЫ РАБОТЫ С КОДАМИ ЭЛЕМЕНТОВ СПРАВОЧНИКОВ.

// Функция заменяет все не алфавитноцифровые символы на знак подчеркивания.
// Параметры
//  Код            - Строка, Значение кода, которое необходимо преобразовать.
// Возвращаемое значение
//  Строка, преобразованное значение кода.
//
Функция ВернутьАлфавитноЦифровоеПредставление(Код, РазрешитьЦифрыВНачале = Ложь, РазрешитьСлужебныеСимволы = Ложь, ЗаменятьНеправильные=Истина) Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.ВернутьАлфавитноЦифровоеПредставление(Код, РазрешитьЦифрыВНачале, РазрешитьСлужебныеСимволы, ЗаменятьНеправильные);

РусАнгАлфавитВспомогательныеСимволы

Описание, пример вызова

// Проверяет что символ принадлежит множеству [A-Z|А-Я|_|0-9]
//
Функция РусАнгАлфавитВспомогательныеСимволы(Символ) Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.РусАнгАлфавитВспомогательныеСимволы(Символ)

УстановитьНовоеЗначение

Описание, пример вызова

/////////////////////////////////////////////////////////////////

// Процедура проверяет переданный параметр, если он не соответствует значению,
// то присваивает ему указанное значение.
//
// Параметры:
//  Параметр - параметр, значение которого проверяется и заполняется.
//  Значение - значение для заполнения пустого параметра.
//
Процедура УстановитьНовоеЗначение(Параметр, Значение, ЕстьИзменения = Ложь) Экспорт

Пример вызова

ОбщегоНазначенияКлиентСерверУХ.УстановитьНовоеЗначение(Параметр, Значение, ЕстьИзменения);

ЗаполнитьЗначенияОтличающихсяСвойств

Описание, пример вызова

Процедура ЗаполнитьЗначенияОтличающихсяСвойств(Приемник, Источник, Экспорт

Пример вызова

ОбщегоНазначенияКлиентСерверУХ.ЗаполнитьЗначенияОтличающихсяСвойств(Приемник, Источник, );

ИменаСвойствОбъекта

Описание, пример вызова

Функция ИменаСвойствОбъекта(Объект) Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.ИменаСвойствОбъекта(Объект)

ИменаСвойствСтруктуры

Описание, пример вызова

Функция ИменаСвойствСтруктуры(Структура) Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.ИменаСвойствСтруктуры(Структура)

ИменаСвойствСтрокиТаблицыЗначений

Описание, пример вызова

Функция ИменаСвойствСтрокиТаблицыЗначений(СтрокаТаблицыЗначений) Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.ИменаСвойствСтрокиТаблицыЗначений(СтрокаТаблицыЗначений)

ДополнитьТаблицу

Описание, пример вызова

// Дополняет таблицу значений-приемник данными из таблицы значений-источник
//
// Параметры:
//  ТаблицаИсточник - Таблица значений - таблица из которой будут браться строки для заполнения
//  ТаблицаПриемник - Таблица значений - таблица в которую будут добавлены строки из таблицы-источника
//
Процедура ДополнитьТаблицу(ТаблицаИсточник, ТаблицаПриемник) Экспорт

Пример вызова

ОбщегоНазначенияКлиентСерверУХ.ДополнитьТаблицу(ТаблицаИсточник, ТаблицаПриемник)

ДобавитьЗначениеВКоллекцию

Описание, пример вызова

Процедура ДобавитьЗначениеВКоллекцию(Значение,КоллекцияЗначений) Экспорт

Пример вызова

ОбщегоНазначенияКлиентСерверУХ.ДобавитьЗначениеВКоллекцию(Значение, КоллекцияЗначений)

ПолучитьИмяВременногоФайлаУниверсально

Описание, пример вызова

Функция ПолучитьИмяВременногоФайлаУниверсально(Расширение = ".tmp") Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.ПолучитьИмяВременногоФайлаУниверсально(Расширение);

РазностьДатВДнях

Описание, пример вызова

// Функция возвращает разность в днях между "ДатаУменьшаемое" и "ДатаВычитаемое"
//
Функция РазностьДатВДнях(Знач ДатаУменьшаемое, Знач ДатаВычитаемое) Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.РазностьДатВДнях(ДатаУменьшаемое, ДатаВычитаемое)

ПолучитьКореньОшибки

Описание, пример вызова

// Возвращает самую первую ошибку из информации об ошибке.
//
// Параметры:
//  ИнформацияОбОшибке   - ИнформацияОбОшибке.
//
// Возвращаемое значение:
//   - ИнформацияОбОшибке
//
Функция ПолучитьКореньОшибки(Знач ИнформацияОбОшибке) Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.ПолучитьКореньОшибки(ИнформацияОбОшибке)

МножественныйПоискПоДеревуЗначений

Описание, пример вызова

Процедура МножественныйПоискПоДеревуЗначений(МассивНайденныхСтрок, ДеревоЗначений, СтруктураПоиска, ТолькоТекущийУровень = Ложь) Экспорт

Пример вызова

ОбщегоНазначенияКлиентСерверУХ.МножественныйПоискПоДеревуЗначений(МассивНайденныхСтрок, ДеревоЗначений, СтруктураПоиска, ТолькоТекущийУровень);

СравнитьЗначения

Описание, пример вызова

Функция СравнитьЗначения(СравниваемоеЗначение, ЗначениеСравнения) Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.СравнитьЗначения(СравниваемоеЗначение, ЗначениеСравнения));

СообщитьПользователю

Описание, пример вызова

// Формирует и выводит сообщение, которое может быть связано с элементом
// управления формы.
//
//  Параметры
//  ТекстСообщенияПользователю  - Строка - текст сообщения.
//  ОбъектИлиСсылка        - Ссылка на объект ИБ или объект
//  Поле            - Строка - наименование реквизита формы
//  ПутьКДанным          - Строка - путь к данным (путь к реквизиту формы)
//  Отказ            - Булево - Выходной параметр.
//                                Устанавливается в этой процедуре в значение Истина.
//
//  Примеры использования:
//  1. Для вывода сообщения у поля управляемой формы, связанного с реквизитом объекта:
//  ОбщегоНазначенияКлиентСервер.СообщитьПользователю(
//    НСтр("ru = 'Сообщение об ошибке.'"), ,
//    "ПолеВРеквизитеФормыОбъект",
//    "Объект");
//
//  Альтернативный вариант использования в форме объекта:
//  ОбщегоНазначенияКлиентСервер.СообщитьПользователю(
//    НСтр("ru = 'Сообщение об ошибке.'"), ,
//    "Объект.ПолеВРеквизитеФормыОбъект");
//
//  2. Для вывода сообщения рядом с полем управляемой формы, связанным с реквизитом формы:
//  ОбщегоНазначенияКлиентСервер.СообщитьПользователю(
//    НСтр("ru = 'Сообщение об ошибке.'"), ,
//    "ИмяРеквизитаФормы");
//
//  3. Для вывода сообщения из кода на сервере:
//  ОбщегоНазначенияКлиентСервер.СообщитьПользователю(
//    НСтр("ru = 'Сообщение об ошибке.'"),СсылкаНаОбъект,,,Отказ);
//
Процедура СообщитьПользователю(  Знач ТекстСообщенияПользователю, Экспорт

Пример вызова

ОбщегоНазначенияКлиентСерверУХ.СообщитьПользователю(ТекстСообщенияПользователю, );

ПоместитьТаблицуЗначенийВКоллекциюФормы

Описание, пример вызова

Процедура ПоместитьТаблицуЗначенийВКоллекциюФормы(ТаблицаЗначений,КоллекцияФормы) Экспорт

Пример вызова

ОбщегоНазначенияКлиентСерверУХ.ПоместитьТаблицуЗначенийВКоллекциюФормы(ТаблицаЗначений, КоллекцияФормы)

ПоместитьДеревоЗначенийВКоллекциюФормы

Описание, пример вызова

Процедура ПоместитьДеревоЗначенийВКоллекциюФормы(ДеревоЗначений,КоллекцияФормы) Экспорт

Пример вызова

ОбщегоНазначенияКлиентСерверУХ.ПоместитьДеревоЗначенийВКоллекциюФормы(ДеревоЗначений, КоллекцияФормы)

НаименованиеПоКоду

Описание, пример вызова

// Возвращает наименование объекта по его коду.
// Пример: "ОсновныеСредства" => "Основные средства".
//
Функция НаименованиеПоКоду(Знач Код) Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.НаименованиеПоКоду(Код)

ПолучитьКлючПоНаименованию

Описание, пример вызова

Функция ПолучитьКлючПоНаименованию(Наименование) Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.ПолучитьКлючПоНаименованию(Наименование)

НайтиСтрокуДерева

Описание, пример вызова

Функция НайтиСтрокуДерева(КоллекцияЭлементов,Значение,ИмяКолонки) Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.НайтиСтрокуДерева(КоллекцияЭлементов, Значение, ИмяКолонки)

УстановитьЭлементОтбора

Описание, пример вызова

// Используется для создания элемента отбора или, если таковой не найден,
// установления существующим элементам свойств
// Параметры
// ОбластьПоискаДобавления - контейнер с элементами и группами отбора, например
//          Список.Отбор
//          или группа в отборе
// ИмяПоля - строка - имя для поля компоновки данных (заполняется всегда)
// Устанавливаемые поля:
// ВидСравнения - ВидСравненияКомпоновкиДанных - вид сравнения
// ПравоеЗначение - произвольный
// Представление - представление элемента компоновки данных
// Использование - булево - использование элемента
//
Процедура УстановитьЭлементОтбора(ОбластьПоискаДобавления, Экспорт

Пример вызова

ОбщегоНазначенияКлиентСерверУХ.УстановитьЭлементОтбора(ОбластьПоискаДобавления, );

НайтиЭлементыИГруппыОтбора

Описание, пример вызова

// Поиск элементов и групп отбора динамического списка
// Параметры:
// ОбластьПоиска - контейнер с элементами и группами отбора, например
//          Список.Отбор
//          или группа в отборе
// ИмяПоля - имя поля компоновки (не используется для групп)
// Представление - представление поля компоновки
// Примечание: поиск может осуществляться или по ЛевомуЗначению, или по Представлению
//
Функция НайтиЭлементыИГруппыОтбора(знач ОбластьПоиска, Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.НайтиЭлементыИГруппыОтбора(знач ОбластьПоиска, );

ДобавитьЭлементКомпоновки

Описание, пример вызова

// Добавление элемента компоновки в контейнер элементов компоновки
// Параметры:
// ОбластьДобавления - контейнер с элементами и группами отбора, например
//          Список.Отбор
//          или группа в отборе
// ИмяПоля - строка - имя для поля компоновки данных
// ВидСравнения - ВидСравненияКомпоновкиДанных - вид сравнения
// ПравоеЗначение - произвольный
// Представление - представление элемента компоновки данных
// Использование - булево - использование элемента
//
Функция ДобавитьЭлементКомпоновки(ОбластьДобавления, Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.ДобавитьЭлементКомпоновки(ОбластьДобавления, );

ДобавитьПодчиненныеЭлементыКоллекции

Описание, пример вызова

Процедура ДобавитьПодчиненныеЭлементыКоллекции(СтрокаДерева,СтрокаКоллекции) Экспорт

Пример вызова

ОбщегоНазначенияКлиентСерверУХ.ДобавитьПодчиненныеЭлементыКоллекции(СтрокаДерева, СтрокаКоллекции));

ИзменитьЭлементыОтбора

Описание, пример вызова

// Изменение элементов отбора
// Параметры
// ИмяПоля - строка - имя поля компоновки
// ВидСравнения - ВидСравненияКомпоновкиДанных - вид сравнения
// ПравоеЗначение - произвольный
// Представление - строка - представление элемента компоновки данных
//
Функция ИзменитьЭлементыОтбора(ОбластьПоиска, Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.ИзменитьЭлементыОтбора(ОбластьПоиска, );

НайтиРекурсивно

Описание, пример вызова

Процедура НайтиРекурсивно(КоллекцияЭлементов, МассивЭлементов, СпособПоиска, ЗначениеПоиска) Экспорт

Пример вызова

ОбщегоНазначенияКлиентСерверУХ.НайтиРекурсивно(КоллекцияЭлементов, МассивЭлементов, СпособПоиска, ЗначениеПоиска));

ВыполнитьПоискИсключенийВхожденияСимволов

Описание, пример вызова

Функция ВыполнитьПоискИсключенийВхожденияСимволов(ОбследуемаяСтрока, ДопустимыеСимволы) Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.ВыполнитьПоискИсключенийВхожденияСимволов(ОбследуемаяСтрока, ДопустимыеСимволы));

ПолучитьНовыйКлючКоллекции

Описание, пример вызова

Функция ПолучитьНовыйКлючКоллекции(Коллекция, ИмяКолонки = "КлючСтроки", СтатусУстановки = Ложь) Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.ПолучитьНовыйКлючКоллекции(Коллекция, ИмяКолонки, СтатусУстановки);

УстановитьИзЗаполненногоЗначение

Описание, пример вызова

Процедура УстановитьИзЗаполненногоЗначение(Параметр, Значение) Экспорт

Пример вызова

ОбщегоНазначенияКлиентСерверУХ.УстановитьИзЗаполненногоЗначение(Параметр, Значение)

ПолучитьОписаниеПримитивногоТипаИзСтроки

Описание, пример вызова

////////////////////////////////////////////////////////////////////////////////
// ПРОЦЕДУРЫ И ФУНКЦИИ РАБОТЫ С ТИПАМИ

Функция ПолучитьОписаниеПримитивногоТипаИзСтроки(МассивТиповВИБ) Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.ПолучитьОписаниеПримитивногоТипаИзСтроки(МассивТиповВИБ)

ПримитивныйТипСтрока

Описание, пример вызова

// Служебная функция, определяющая примитивность переданного типа
//
Функция ПримитивныйТипСтрока(СтрокаТип) Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.ПримитивныйТипСтрока(СтрокаТип)

ПустоеЗначениеТипа

Описание, пример вызова

// Предназначена для получения пустого значения заданного типа:
//  примитивного, или ссылочного. Используется
//
// Параметры:
//  ЗаданныйТип   - тип, пустое значение которого нужно получить
//
Функция ПустоеЗначениеТипа(ЗаданныйТип) Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.ПустоеЗначениеТипа(ЗаданныйТип)

ПолучитьРеквизитФормыПоПути

Описание, пример вызова

// Получает значение реквизита формы.
// Параметры:
//    Форма
//    ПутьРеквизита - строка, путь к данным, например: "Объект.МесяцНачисления".
Функция ПолучитьРеквизитФормыПоПути(Форма, ПутьРеквизита) Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.ПолучитьРеквизитФормыПоПути(Форма, ПутьРеквизита)

НовыйУникальныйИдентификатор

Описание, пример вызова

// Возвращает новый УникальныйИдентификатор. Предназначена для вызова из СКД.
Функция НовыйУникальныйИдентификатор() Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.НовыйУникальныйИдентификатор()

ПустойУникальныйИдентификатор

Описание, пример вызова

// Возвращает пустой уникальный идентфикатор.
//
// Возвращаемое значение:
//  УникальныйИдентификатор - уникальный идентификатор.
//
Функция ПустойУникальныйИдентификатор() Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.ПустойУникальныйИдентификатор()

СвойствоСтруктуры

Описание, пример вызова

// Возвращает значение свойства структуры.
//
// Параметры:
//   Структура - Структура, ФиксированнаяСтруктура - Объект, из которого необходимо прочитать значение ключа.
//   Ключ - Строка - Имя свойства структуры, для которого необходимо прочитать значение.
//   ЗначениеПоУмолчанию - Произвольный - Необязательный. Возвращается когда в структуре нет значения по указанному
//                                        ключу.
//       Для скорости рекомендуется передавать только быстро вычисляемые значения (например примитивные типы),
//       а инициализацию более тяжелых значений выполнять после проверки полученного значения (только если это
//       требуется).
//
// Возвращаемое значение:
//   Произвольный - Значение свойства структуры. ЗначениеПоУмолчанию если в структуре нет указанного свойства.
//
Функция СвойствоСтруктуры(Структура, Ключ, ЗначениеПоУмолчанию = Неопределено) Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.СвойствоСтруктуры(Структура, Ключ, ЗначениеПоУмолчанию);

ЗначениеВМассиве

Описание, пример вызова

// Создает массив и помещает в него переданное значение.
Функция ЗначениеВМассиве(Значение) Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.ЗначениеВМассиве(Значение)

МассивВСоответствие

Описание, пример вызова

// Создает соответствие и помещает в него в качестве ключей значения
// из массива. Значения элементров соотвествия устанавливаются
// из аргумента ЗначениеСоответствие.
//
Функция МассивВСоответствие(МассивИсточник, ЗначениеСоответствия=Истина) Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.МассивВСоответствие(МассивИсточник, ЗначениеСоответствия);

КлючиСоответствияВМассив

Описание, пример вызова

// Создает массив из ключей соответствия.
//
// Параметры:
//  Соответствие - Соответствие - источник данных.
//
// Возвращаемое значение:
//   - Массив.
//
Функция КлючиСоответствияВМассив(Соответствие) Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.КлючиСоответствияВМассив(Соответствие)

ВыгрузитьКолонкуКоллекцииВМассив

Описание, пример вызова

// Выгружает из коллекции указанную по имени колонку.
//  Необходима, т.к. на клиенте отсутствует стандартная функция.
//
// Параметры:
//  Коллекция   - ДанныеФормыКоллекция - коллекция.
//  ИмяКолонки   - Строка - имя колонки.
//
// Возвращаемое значение:
//   - Массив - значения колонки указанной коллекции.
//
Функция ВыгрузитьКолонкуКоллекцииВМассив(Коллекция, ИмяКолонки) Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.ВыгрузитьКолонкуКоллекцииВМассив(Коллекция, ИмяКолонки)

ЗаменитьУдалитьПараметрВыбора

Описание, пример вызова

Процедура ЗаменитьУдалитьПараметрВыбора(Элемент, Имя, НовыйПараметрВыбора = Неопределено) Экспорт

Пример вызова

ОбщегоНазначенияКлиентСерверУХ.ЗаменитьУдалитьПараметрВыбора(Элемент, Имя, НовыйПараметрВыбора);

Округлить

Описание, пример вызова

// Округляет число до заданной точности по указанному правилу (перенесено из ЗарплатаКадрыКлиентСервер).
//
// Параметры:
//  Число                   - число, число которое необходимо округлить.
//  Точность            - число, "базис" до которого нужно округлить заданное число.
//  Правило         - булево, Истина - в большую сторону, Ложь - в меньшую, Неопределено/В остальных случаях - по правилу арифметики
//
// Возвращаемое значение:
// Число - округленное до заданной точности значение.
//
Функция Округлить(Число, Точность = 0, Правило = Неопределено) Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.Округлить(Число, Точность, Правило);

МаксимальныйИнтервалПроверкиНапоминаний

Описание, пример вызова

// Возвращает максимальный интервал (в секундах) проверки напоминаний.
Функция МаксимальныйИнтервалПроверкиНапоминаний() Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.МаксимальныйИнтервалПроверкиНапоминаний()

СвернутьСписокЗначений

Описание, пример вызова

// Возвращает копию списка значений СписокВход, где удалены все
//неуникальные значения. ВАЖНО! Будут потеряны представления элементов.
Функция СвернутьСписокЗначений(СписокВход) Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.СвернутьСписокЗначений(СписокВход)

ОтфильтроватьСвойстваСтруктуры

Описание, пример вызова

// Получить строку имен свойств структуры отфильтрованный по присутствии в свойствах структуры.
// Параметры:
//  ОбъектСтруктура - Структура.
//  ИменаСвойств - Строка. Имена свойств разделенные запятыми. Пробелы не учитываются.
// Возвращает:
//  Строка - имена свойств присутствующие в ИменаСвойств и принадлежащие структуре ОбъектСтруктура.
//
Функция ОтфильтроватьСвойстваСтруктуры(ОбъектСтруктура, Знач ИменаСвойств) Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.ОтфильтроватьСвойстваСтруктуры(ОбъектСтруктура, ИменаСвойств)

ЗаполнитьЗначенияСвойствИзСтруктуры

Описание, пример вызова

// Обертка для функции ЗаполнитьЗначенияСвойств.
// При исключении свойств, не выдает ошибку, если свойство отсутствует в СтруктураИсточник.
Процедура ЗаполнитьЗначенияСвойствИзСтруктуры(Приемник, СтруктураИсточник, Знач СписокСвойств, Знач ИсключаяСвойства) Экспорт

Пример вызова

ОбщегоНазначенияКлиентСерверУХ.ЗаполнитьЗначенияСвойствИзСтруктуры(Приемник, СтруктураИсточник, СписокСвойств, ИсключаяСвойства)

ЗаполнитьНеЗаполненныеСвойства

Описание, пример вызова

// Заполняет свойства переданного объекта из структуры, если они не заполнены
//
// Параметры:
//  Объект         - Произвольный   - любой объект, свойства которого требуется заполнить
//  ЗначенияРеквизитов   - Структура    - структура: Ключ - имя реквизита объекта, Значение - значение реквизита объекта
//
Процедура ЗаполнитьНеЗаполненныеСвойства(Объект, ЗначенияРеквизитов) Экспорт

Пример вызова

ОбщегоНазначенияКлиентСерверУХ.ЗаполнитьНеЗаполненныеСвойства(Объект, ЗначенияРеквизитов)

ОчиститьСвойстваОбъекта

Описание, пример вызова

// Устанавливает свойства объекта значениями по умолчанию для их типа
//
// Параметры:
//  Объект     - ДокументОбъект, Структура и т.п. - объект свойства которого очищаются
//  ИменаСвойств - Строка - имена свойств объекта через запятую
//
Процедура ОчиститьСвойстваОбъекта(Объект, ИменаСвойств) Экспорт

Пример вызова

ОбщегоНазначенияКлиентСерверУХ.ОчиститьСвойстваОбъекта(Объект, ИменаСвойств)

ПустоеЗначение

Описание, пример вызова

// Возвращает пустое значение переданного типа
//
// Параметры:
//  ТипЗначения   - Тип - тип значения
//
// Возвращаемое значение:
//   - пустое значение
//
Функция ПустоеЗначение(ТипЗначения) Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.ПустоеЗначение(ТипЗначения)

УдалитьПустыеЭлементыМассива

Описание, пример вызова

// Возвращает копию массива МассивВход, из которого удалены
// незаполненные элементы.
Функция УдалитьПустыеЭлементыМассива(МассивВход) Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.УдалитьПустыеЭлементыМассива(МассивВход)

СортироватьМассив

Описание, пример вызова

// Возвращает копию массива МассивВход, отсортированному по возрастанию/убыванию
// в зависимости от параметра ПоВозрастаниюВход.
Функция СортироватьМассив(МассивВход, ПоВозрастаниюВход = Истина) Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.СортироватьМассив(МассивВход, ПоВозрастаниюВход);

ПолучитьОбратныйМассив

Описание, пример вызова

// Возвращает новый массив заполненный элементами идущими
// в обратном направлении по отношению к исходному.
// Параметры:
//  М - Массив, ФиксированныйМассив - для получения обратного.
// Возвращает:
//  Массив - массив в котором все элементы идут в порядке, противоположному
//    порядку из исходного массива М.
//
Функция ПолучитьОбратныйМассив(М) Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.ПолучитьОбратныйМассив(М)

ПолучитьИндексыПутиКЭлементуВДеревеЗначений

Описание, пример вызова

// Возвращает массив заполненный индексами в ДеревоЗначений всех родителей
// и самого элемента ДанныеФормыДерево.
//
// Параметры:
//  ДеревоФормы - ДанныеФормыДерево - дерево формы для получения индекса
//    верхнего элемента. Если передать Неопределено, то после
//    нахождения сАмого родительского элемента, не будет
//    искать его индекс в корневых элементах дерева.
//  ЭлементДереваФормы - ДанныеФормыЭлементДерева - элемент для которого
//    необходимо получить путь.
// Возвращает:
//  Массив(Число) - индексы элементов в ДеревоЗначений от родителей к детям.
//
Функция ПолучитьИндексыПутиКЭлементуВДеревеЗначений(ДеревоФормы, ЭлементДереваФормы) Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.ПолучитьИндексыПутиКЭлементуВДеревеЗначений(ДеревоФормы, ЭлементДереваФормы)

ПолучитьЭлементДереваФормыПоИндексам

Описание, пример вызова

// Возвращает ДанныеФормыЭлементДерева в указанном ДанныеФормыДерево.
//  Поиск осуществляется по индексам из массива. От самого верхнего
//  родителя к самому элементу.
//
// Параметры:
//  ДеревоФормы - ДанныеФормыДерево - реквизит формы дерево для поиска в нем.
//  мИндексы - Массив(Число) - массив индексов.
//
// Возвращаемое значение:
//  ДанныеФормыЭлементДерева - если найден элемент.
//  Неопределено - элемент дерева не найден.
//
Функция ПолучитьЭлементДереваФормыПоИндексам(ДеревоФормы, мИндексы) Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.ПолучитьЭлементДереваФормыПоИндексам(ДеревоФормы, мИндексы)

УстановитьЗначениеПоляКоллекции

Описание, пример вызова

// Установить значение в указанных строке и колонке ДанныеФормыКоллекция.
//
// Параметры:
//  ОбъектКоллекции - ДанныеФормыКоллекция - объект у которого нужно установить значение.
//  ИмяКолонки - Строка - имя колонки в коллекции.
//  ТекущаяСтрока - Число - идентификатор строки коллекции.
//  Значение - Произвольный - значение, которое будет записано в ячейку.
//
Процедура УстановитьЗначениеПоляКоллекции(ОбъектКоллекции, ИмяКолонки, Экспорт

Пример вызова

ОбщегоНазначенияКлиентСерверУХ.УстановитьЗначениеПоляКоллекции(ОбъектКоллекции, ИмяКолонки, );

ПолучитьЗначениеПоляКоллекции

Описание, пример вызова

// Получить значение в указанной строке и колонке ДанныеФормыКоллекция.
//
// Параметры:
//  ОбъектКоллекции - ДанныеФормыКоллекция - коллекция из которой читаем значение.
//  ИмяКолонки - Строка - имя колонки в коллекции.
//  ТекущаяСтрока - Число - идентификатор строки коллекции.
//
Функция ПолучитьЗначениеПоляКоллекции(ОбъектКоллекции, ИмяКолонки, Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.ПолучитьЗначениеПоляКоллекции(ОбъектКоллекции, ИмяКолонки, );

ДополнитьСтрокиДереваФормы

Описание, пример вызова

// Получить структуру, описывающую строку аналитики источника данных.
//
// Параметры:
//  СтрокаДереваФормы - ДанныеФормыДерево, ДанныеФормыЭлементДерева - дерево
//    или строка в которую нужно добавить строки.
//  СтрокиКДобавлению - Массив(Структура) - массив структур описывающих
//    строки, которые нужно добавить. Реквизиты структуры должны
//    соответствовать колонкам дерева. Если необходимо добавлять
//    подчиненные строки, то у структуры должен быть реквизит
//    СтрокиКДобавлению.
//
Процедура ДополнитьСтрокиДереваФормы(СтрокаДереваФормы, СтрокиКДобавлению) Экспорт

Пример вызова

ОбщегоНазначенияКлиентСерверУХ.ДополнитьСтрокиДереваФормы(СтрокаДереваФормы, СтрокиКДобавлению)

ДобавитьВСписокИзСписка

Описание, пример вызова

// Добавляет все значение из списка значений Источник
//  в список значений Приемник.
//
// Параметры:
//  Приемник - СписокЗначений - список в который обаляем значения.
//  Источник - СписокЗначений - список из которого берутся значения.
//
// Возвращаемое значение:
//   - СписокЗначение - ссылка на Приемник.
//
Функция ДобавитьВСписокИзСписка(Приемник, Источник) Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.ДобавитьВСписокИзСписка(Приемник, Источник)

МинимумВМассиве

Описание, пример вызова

// Возвращает минимальное значение в массиве. Когда массив пустой, либо возникла
// ошибка - будет возвращено ЗначениеПоУмолчаниюВход.
Функция МинимумВМассиве(МассивВход, ЗначениеПоУмолчаниюВход = Неопределено) Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.МинимумВМассиве(МассивВход, ЗначениеПоУмолчаниюВход);

МаксимумВМассиве

Описание, пример вызова

// Возвращает максимальное значение в массиве. Когда массив пустой, либо возникла
// ошибка - будет возвращено ЗначениеПоУмолчаниюВход.
Функция МаксимумВМассиве(МассивВход, ЗначениеПоУмолчаниюВход = Неопределено) Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.МаксимумВМассиве(МассивВход, ЗначениеПоУмолчаниюВход);

ПроизведениеВМассиве

Описание, пример вызова

// Возвращает произведение значение в массиве. Когда массив пустой, либо возникла
// ошибка - будет возвращено ЗначениеПоУмолчаниюВход.
Функция ПроизведениеВМассиве(МассивВход, ЗначениеПоУмолчаниюВход = Неопределено) Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.ПроизведениеВМассиве(МассивВход, ЗначениеПоУмолчаниюВход);

СуммаЭлементовКоллекции

Описание, пример вызова

Функция СуммаЭлементовКоллекции(Коллекция, ИмяРеквизита) Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.СуммаЭлементовКоллекции(Коллекция, ИмяРеквизита)

НайтиЭлементКоллекцииПоЗначениюРеквизита

Описание, пример вызова

Функция НайтиЭлементКоллекцииПоЗначениюРеквизита(Коллекция, ИмяРеквизита, ЗначениеРеквизита) Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.НайтиЭлементКоллекцииПоЗначениюРеквизита(Коллекция, ИмяРеквизита, ЗначениеРеквизита)

СреднееАрифметическоеВМассиве

Описание, пример вызова

// Возвращает произведение значение в массиве. Когда массив пустой, либо возникла
// ошибка - будет возвращено ЗначениеПоУмолчаниюВход.
Функция СреднееАрифметическоеВМассиве(МассивВход, ЗначениеПоУмолчаниюВход = Неопределено) Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.СреднееАрифметическоеВМассиве(МассивВход, ЗначениеПоУмолчаниюВход);

УстановитьАвтоОтметкуЗаполненияЭлемента

Описание, пример вызова

// Процедура корректно снимает АвтоОтметкуНезаполненного для элемента формы
Процедура УстановитьАвтоОтметкуЗаполненияЭлемента(Элемент, ОбязательноеЗаполнение) Экспорт

Пример вызова

ОбщегоНазначенияКлиентСерверУХ.УстановитьАвтоОтметкуЗаполненияЭлемента(Элемент, ОбязательноеЗаполнение)

СтруктурыРавны

Описание, пример вызова

// Проверяет равенство реквизитов двух структур.
//  Проверка идентичности наборов реквизитов не производится.
//
// Параметры:
//  СтруктураИсходная - Структура - первая структура для сравнения.
//                  Из нее берутся имена полей.
//  СтруктураИзмененная - Структура - вторая структура для сравнения.
//
// Возвращаемое значение:
//   - Булево - Истина - если все реквизиты СтруктураИсходная равны
//             реквизитам СтруктураИзмененная.
//        Ложь - если реквизиты различны.
//
Функция СтруктурыРавны(СтруктураИсходная, СтруктураИзмененная) Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.СтруктурыРавны(СтруктураИсходная, СтруктураИзмененная)

ПолучитьФормуПоЭлементу

Описание, пример вызова

// Для переданного элемента формы возвращает саму форму.
// В случае ошибки, возвращает Неопределено.
//
Функция ПолучитьФормуПоЭлементу(ЭлементФормы) Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.ПолучитьФормуПоЭлементу(ЭлементФормы)

ПреобразоватьКодВУникальный

Описание, пример вызова

// Преобразует код КодВход в уникальный среди кодов МассивКодовВход
// с максимлаьной длиной ДлинаКодаСтрокиВход.
Функция ПреобразоватьКодВУникальный(КодВход, МассивКодовВход, ДлинаКодаСтрокиВход, БезУчетаРегистра = Ложь) Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.ПреобразоватьКодВУникальный(КодВход, МассивКодовВход, ДлинаКодаСтрокиВход, БезУчетаРегистра);

УдалитьЭлементСписокаЗначений

Описание, пример вызова

// Возвращает копию списка значений СписокВход, в которой удален элемент со значением
// ЗначениеЭлементаВход.
Функция УдалитьЭлементСписокаЗначений(СписокВход, ЗначениеЭлементаВход) Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.УдалитьЭлементСписокаЗначений(СписокВход, ЗначениеЭлементаВход)

РасчетныеПоказателиЯчеек

Описание, пример вызова

// Обертка над служебным интерфейсом БСП.
// Рассчитывает показатели числовых ячеек в табличном документе.
//
// Параметры:
//   ПараметрыРасчета - структура - см. также ОбщегоНазначенияСлужебныйКлиент.ПараметрыРасчетаПоказателейЯчеек.
//
// Возвращаемое значение:
//   Структура - результаты расчета выделенных ячеек.
//       * Количество         - Число - Количество выделенных ячеек.
//       * КоличествоЧисловых - Число - Количество числовых ячеек.
//       * Сумма      - Число - Сумма выделенных ячеек с числами.
//       * Среднее    - Число - Сумма выделенных ячеек с числами.
//       * Минимум    - Число - Сумма выделенных ячеек с числами.
//       * Максимум   - Число - Максимум выделенных ячеек с числами.
//
Функция РасчетныеПоказателиЯчеек(ТабличныйДокумент, ВыделенныеОбласти) Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.РасчетныеПоказателиЯчеек(ТабличныйДокумент, ВыделенныеОбласти)

ЗаполнитьМассивИзТаблицы

Описание, пример вызова

Процедура ЗаполнитьМассивИзТаблицы(Массив, Таблица, ИмяПоля) Экспорт

Пример вызова

ОбщегоНазначенияКлиентСерверУХ.ЗаполнитьМассивИзТаблицы(Массив, Таблица, ИмяПоля)

ЗаполнитьТаблицуИзМассива

Описание, пример вызова

Процедура ЗаполнитьТаблицуИзМассива(Таблица, Массив, ИмяПоля) Экспорт

Пример вызова

ОбщегоНазначенияКлиентСерверУХ.ЗаполнитьТаблицуИзМассива(Таблица, Массив, ИмяПоля)

ЭтоЧисло

Описание, пример вызова

Функция ЭтоЧисло(Знач ПроверяемоеЗначение) Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.ЭтоЧисло(ПроверяемоеЗначение)

ПолучитьОписаниеТиповДоговора

Описание, пример вызова

// Функция описание типа договора.
//
// Параметры:
//  ЗначениеКонтрагента - СправочникСсылка.Контрагенты, СправочникСсылка.Организации, Неопределено -
//    Ссылка для определения типа контрагента, договоры которого необходимо получить.
//
// Возвращаемое значение:
//  ОписаниеТипов - Описание типов справочник, содержащих договоры.
//
Функция ПолучитьОписаниеТиповДоговора() Экспорт

Пример вызова

Результат = ОбщегоНазначенияКлиентСерверУХ.ПолучитьОписаниеТиповДоговора()