Общего назначения БЗК клиент сервер

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

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

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

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

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

ЗаполненоЗначениеСвойства

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

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

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

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

УстановитьСвойствоЭлементовФормы

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

////////////////////////////////////////////////////////////////////////////////
// Функции для работы с управляемыми формами.
//

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

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

ОбщегоНазначенияБЗККлиентСервер.УстановитьСвойствоЭлементовФормы(ЭлементыФормы, ИменаЭлементов, ИмяСвойства, Значение)

УстановитьОбязательностьПоляВводаФормы

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

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

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

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

УстановитьОбязательностьЗаполненияПоляВвода

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

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

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

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

УстановитьНеобязательностьЗаполненияПоляВвода

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

// Задает необязательность заполнения поля формы.
// Устанавливает свойства АвтоОтметкаНезаполненного и ОтметкаНезаполненного поля формы.
//
// Параметры:
//  ПолеВвода - ПолеФормы - Поля формы. Должно быть полем ввода (ВидПоляФормы.ПолеВвода).
//
Процедура УстановитьНеобязательностьЗаполненияПоляВвода(ПолеВвода) Экспорт

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

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

УстановитьОбязательностьТаблицыФормы

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

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

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

ОбщегоНазначенияБЗККлиентСервер.УстановитьОбязательностьТаблицыФормы(Форма, ИмяЭлемента, Обязательная, ПутьКДанным);

УстановитьОбязательностьПоляВводаТаблицыФормы

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

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

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

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

ПодсистемаСуществует

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

////////////////////////////////////////////////////////////////////////////////
// Функции для вызова необязательных подсистем.

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

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

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

ОбщийМодуль

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

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

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

Результат = ОбщегоНазначенияБЗККлиентСервер.ОбщийМодуль(Имя)

ЭтоВисокосныйГод

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

////////////////////////////////////////////////////////////////////////////////
// Функции для работы с датами

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

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

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

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

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

////////////////////////////////////////////////////////////////////////////////
// Функции для работы с коллекциями

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

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

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

СрезМассива

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

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

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

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

УдалитьВсеВхожденияКромеТипаИзМассива

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

// Удаляет все вхождения кроме значений указанного типа.
//
// Параметры:
//  Массив - Массив - массив, из которого необходимо удалить значения;
//  Тип - Тип - тип значений, которые должны остаться в массиве.
//
Процедура УдалитьВсеВхожденияКромеТипаИзМассива(Массив, Тип) Экспорт

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

ОбщегоНазначенияБЗККлиентСервер.УдалитьВсеВхожденияКромеТипаИзМассива(Массив, Тип)

УдалитьПустыеЗначенияИзМассива

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

// Удаляет пустые значения из массива.
//
// Параметры:
//  Массив - Массив - массив, из которого необходимо удалить пустые значения;
//
Процедура УдалитьПустыеЗначенияИзМассива(Массив) Экспорт

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

ОбщегоНазначенияБЗККлиентСервер.УдалитьПустыеЗначенияИзМассива(Массив)

ОчиститьЗначенияСтруктуры

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

// Очищает значения свойств структуры
//
// Параметры:
//  Структура - Структура - очищаемая структура.
//
Процедура ОчиститьЗначенияСтруктуры(Структура) Экспорт

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

ОбщегоНазначенияБЗККлиентСервер.ОчиститьЗначенияСтруктуры(Структура)

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

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

// Формирует небольшой массив размером от 2 до 5 элементов по их значениям.
// Для создания массива из единственного элемента см. ОбщегоНазначенияКлиентСервер.ЗначениеВМассиве.
//
// Параметры:
//   Элемент<n> - элементы массива.
//
// Возвращаемое значение:
//   Массив из Элемент<n>.
//
Функция ЗначенияВМассиве( Экспорт

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

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

ДобавитьЗначениеВМассив

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

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

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

ОбщегоНазначенияБЗККлиентСервер.ДобавитьЗначениеВМассив(Массив, Значение)

ЗначенияСоответствия

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

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

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

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

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

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

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

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

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

ВыгрузитьКолонку

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

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

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

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

КоллекцияВМассив

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

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

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

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

СледующийИдентификаторСтрокиДереваПоЗначениюПоля

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

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

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

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

ИдентификаторСтрокиДереваПоЗначениюПоля

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

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

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

Результат = ОбщегоНазначенияБЗККлиентСервер.ИдентификаторСтрокиДереваПоЗначениюПоля(Дерево, ИмяПоля, СтрокаДляПоиска)