1С. Сохранение настроек обработки
Пользователи работают с обработкой, в которой часть параметров меняется очень редко, но параметры у каждого пользователя свои. Необходимо организовать сохранение настроек и их восстановление для определенных реквизитов. Сохранение и восстановление выполнять только по кнопкам на форме.
Решение
Для сохранения настроек воспользуемся хранилищем настроек. Если конфигурация позволяет, то можно создать свое хранилище, или же воспользоваться одним из системных. Считаем, что конфигурация типовая(не редактируется), в качестве хранилища будем использовать ХранилищеНастроекДанныхФорм.
В форме определим команду Сохранить настройки, в которой вызовем метод Сохранить() указав ключ объекта, ключ настроек, сами настройки и пользователя:
В форме определим команду Восстановить настройки, в которой спросим про восстановление(пример с вопросом в режиме без модальных вызовов разбирал здесь) и при утвердительном ответе вызовем метод Загрузить() указав ключ объекта, ключ настроек и пользователя:
В итоге у каждого пользователя есть возможность сохранить определенные настройки и при необходимости восстановить их. Можно реализовать сохранение нескольких настроек, если дать возможность указания имени настройки и передавать его при сохранении/восстановлении как ключ настроек.
Механизм настроек пользователей в 1Cv8
Для сохранения информации о настройках пользователя, которая должна сохраняться между сеансами работы, в платформе реализованы хранилища настроек.
Существует два вида хранилищ настроек:
- Стандартное хранилище – хранилище, используемое системой по умолчанию и хранящее данные в системных таблицах информационной базы.
- Хранилища настроек – специальные объекты метаданных, которые описывают хранение данных в некотором объекте информационной базы.
Например, в этом объекте может быть описана работа с настройками, которые хранятся в справочнике.
Платформа использует пять хранилищ:
- Системное хранилище – в данное хранилище система сохраняет все возможные настройки, которые нужны для работы платформы. К данным настройкам относятся настройки размеров форм, настройки печати табличного документа и т. п. Полный перечень настроек, сохраняемых в системном хранилище, перечислен в Приложении В. В качестве системного хранилища настроек всегда используется стандартное хранилище настроек. Т. е. данные системного хранилища всегда сохраняются в системной таблице информационной базы.
- Хранилище общих настроек – данное хранилище предназначено для хранения различных настроек прикладного решения. Платформа самостоятельно не записывает в данное хранилище никаких настроек. Данное хранилище должен использовать разработчик из встроенного языка, для того чтобы выполнять сохранение/восстановление прикладных настроек пользователя.
- Хранилище пользовательских настроек отчетов – в данное хранилище помещаются пользовательские настройки отчетов.
- Хранилище вариантов отчетов – в данное хранилище помещаются варианты отчетов.
- Хранилище настроек данных форм – в это хранилище сохраняются данные форм. Этим хранилищем можно пользоваться, например, для сохранения реквизитов обработок. При этом можно выбрать индивидуальное хранилище для каждого отчета и обработки.
При разработке конфигурации имеется возможность определить собственные хранилища настроек для всех хранилищ (кроме системного хранилища). Для этого необходимо создать объект хранилище настроек в соответствующей ветке дерева метаданных и затем указать его в нужном свойстве конфигурации. Свойства объекта Конфигурация имеют те же имена, что и вышеперечисленные хранилища.
Таким образом, данные хранилищ могут храниться как в системной таблице информационной базы, так и в некотором специальном объекте информационной базы, например, в справочнике или регистре сведений. Например, можно создать в конфигурации объект хранилище настроек и указать в свойстве конфигурации, что данное хранилище следует использовать для хранения настроек отчетов. Таким образом, настройки отчетов будут сохраняться не в системной таблице, а в некотором объекте, например, в справочнике, что дает возможность организовать работу с едиными настройками отчетов, реализовать систему прав, обмен настройками и т.п.
Объект метаданных ХранилищеНастроек
Объект метаданных ХранилищеНастроек предназначен для обеспечения хранения прикладных настроек конфигурации. За счет реализации обработчиков событий и создания формы объекта выполняется модификация механизма работы с настройками таким образом, что изменяется место хранения настроек (вместо системных таблиц используются специальные объекты конфигурации, которые создал разработчик) и визуальные механизмы работы с настройками.
В конфигурации может быть определено произвольное количество хранилищ настроек.
Методы и обработчики
У объекта ХранилищеНастроекМенеджер имеется ряд методов, которые вызывают соответствующие события. Таким образом, определением обработчиков событий описывается логика сохранения/загрузки настроек.
В методах хранилища и обработчиках используются следующие параметры:
- КлючОбъекта – значение любого типа, которое используется в хранилище в качестве идентификатора объекта настройки. Например, для идентификации отчета платформа использует полное имя отчета.
- КлючНастроек – значение любого типа, которое используется в хранилище в качестве идентификатора объекта хранилища, хранящего настройку. Этот ключ используется в тех случаях, когда хранится несколько настроек, из которых возможен выбор пользователем.
В процессе разработки хранилища, разработчик самостоятельно определяет, каким образом будет идентифицироваться объект хранилища, тем самым, определяя тип параметра.
Например, если настройки сохраняются в справочнике, то в качестве ключа настройки можно использовать поле Код или значение Ссылка (элемента справочника).
- Настройка – объект, содержащий настройки. Значение любого типа, которое необходимо сохранить как настройку. Например, при сохранении настроек отчета будет использоваться объект ПользовательскиеНастройкиКомпоновкиДанных, а при сохранении данных формы – объект Соответствие.
- ОписаниеНастроек – значение типа ОписаниеНастроек. Специальный объект, содержащий информацию о настройке. Содержит ключ объекта, ключ настройки и представление настройки.
- Пользователь – имя пользователя. Если имеет значение Неопределено, то следует использовать имя текущего пользователя. В других случаях содержит имя пользователя, для которого нужно получить или сохранить настройки. По умолчанию имеет значение Неопределено.
Объект ХранилищеНастроек предоставляет следующие методы:
- Сохранить() – используется для сохранения настройки.
Вызывает событие ОбработкаСохранения. Если обработчик события не реализован или пустой, то действие не будет выполнено.
- Загрузить() – используется для получения настройки.
Вызывает событие ОбработкаЗагрузки. Если обработчик события не реализован или пустой, то действие не будет выполнено.
- ПолучитьОписание() – используется для получения описания настройки.
Вызывает событие ОбработкаПолученияОписания. Если обработчик события не реализован или пустой, то действие не будет выполнено.
- УстановитьОписание() – используется для установки описания настройки.
Вызывает событие ОбработкаУстановкиОписания. Если обработчик события не реализован или пустой, то действие не будет выполнено.
Подробнее про параметры методов можно посмотреть во встроенной справке.
В модуле менеджера объекта должны находится обработчики следующих событий:
- ОбработкаСохранения – содержит реализацию метода Сохранить(). В данном обработчике необходимо выполнить сохранение настройки в некоторый объект. Например, в элемент справочника.
- ОбработкаЗагрузки – содержит реализацию метода Загрузить(). В данном обработчике необходимо получить настройки из некоторого объекта. Например, из элемента справочника.
- ОбработкаПолученияОписания – содержит реализацию метода ПолучитьОписание(). В данном обработчике необходимо заполнить описание настройки на основании свойств сохраненной настройки. Например, из элемента справочника.
- ОбработкаУстановкиОписания – содержит реализацию метода УстановитьОписание(). В данном обработчике необходимо заполнить описание сохраненной настройки из переданного объекта ОписаниеНастроек. Например, в элементе справочника.
Подробнее про параметры обработчиков можно посмотреть во встроенной справке.
Формы
Кроме описания обработчиков в хранилище настроек необходимо определить формы, которые будут использоваться при сохранении и выборе настроек пользователем.
Когда пользователь применяет команды сохранения или загрузки настроек, система получает соответствующую форму объекта хранилища настроек, и отображает ее на экране.
Например, при сохранении настроек отчета система будет использовать форму сохранения того объекта метаданных, который указан в качестве хранилища настроек отчетов (непосредственно у самого отчета или у всей конфигурации). При этом форме будут переданы следующие параметры:
- КлючОбъекта – идентификатор объекта, для которого нужно отображать список настроек. Например, для отчета это будет полным именем отчета.
- КлючТекущихНастроек – идентификатор настройки, которая была текущей там, откуда вызывается форма сохранения или восстановления настроек. Например, это может быть идентификатором текущей настройки отчета.
- СтандартныеНастройки – список значений, содержащий стандартные настройки. Например, для выбора варианта отчета данный список содержит список стандартных вариантов, настроек, описанных в схеме компоновки данных отчета. Данный параметр передается только в форму загрузки.
При создании формы с помощью конструктора, вышеописанные параметры будут автоматически добавлены в список параметров формы.
В формах следует использовать переданные параметры и соответствующим образом фильтровать список настроек. Так, следует отображать только настройки для указанного в параметре КлючОбъекта объекта настройки (например, отчета).
Если пользователь выбрал настройку, то результатом работы формы должно быть значение типа ВыборНастроек. В этом значении, в свойстве КлючНастроек, должен находиться ключ выбранной настройки (например, код элемента справочника или другой, идентифицирующий настройку параметр), а в свойстве ДополнительныеСвойства – дополнительная информация, которую пользователь мог указать в форме.
Стандартное хранилище настроек
Стандартное хранилище настроек представляется во встроенном языке объектом СтандартноеХранилищеНастроекМенеджер. Данный объект реализует тот же набор методов, что и объект ХранилищеНастроекМенеджер, и дополнительно реализует методы:
- ПолучитьСписок() – метод получения списка настроек для выбранного объекта настройки,
- Удалить() – удаление определенной настройки выбранного объекта настройки.
Стандартное хранилище сохраняет настройки в системных таблицах информационной базы.
В качестве ключа объекта настройки и в качестве ключа настройки системное хранилище настроек принимает строку.
В качестве настроек системное хранилище принимает любое значение, которое может быть помещено в хранилище значений.
Сохранение настроек форм
Разработчик может управлять сохранением данных управляемых форм в настройках. Для этого при разработке формы ему необходимо воспользоваться следующими свойствами формы:
- СохранениеДанныхВНастройках – при помощи данного свойства разработчик формы может включить возможность сохранения данных формы (с возможностью выбора настройки, в которую будут сохраняться данные). Если у формы включена необходимость сохранения, то форма предоставляет команды сохранения / загрузки настроек.
- АвтоматическоеСохранениеДанныхВНастройках – указывает необходимость автоматического сохранения настроек при закрытии формы и восстановлении при открытии формы. При этом не важно, используется или нет список настроек.
- ХранилищеНастроек – ссылка на хранилище настроек, в котором предполагается сохранение настроек. Если не указано, то используется хранилище сохранения настроек данных формы, указанное в конфигурации. А если и в конфигурации не указано хранилище, то настройки сохраняются в стандартное хранилище настроек.
Если для формы установлена возможность сохранения данных, то необходимо указать, какие реквизиты формы должны сохраняться (колонка Сохранение на закладке Реквизиты редактора формы).
При сохранении настроек в качестве ключа объекта используется полное имя формы. В настройках сохраняется объект типа Соответствие, в котором в качестве ключей находятся пути к сохраняемым реквизитам, а в качестве значений – их (реквизитов) значения.
Для дополнительной обработки сохранения и загрузки в форме имеются следующие обработчики:
- ПриСохраненииДанныхВНастройкахНаСервере – в данный обработчик передается объект (типа Соответствие), в который будут сохраняться настройки. В объекте уже заполнены значения реквизитов, которые требовалось сохранять. В этом обработчике можно программно добавить в объект настроек дополнительную информацию. Например, поместить в реквизит настроек отбор.
- ПриЗагрузкеДанныхИзНастроекНаСервере – в данный обработчик передается объект, из которого уже загружены настройки. Это соответствие, в котором находятся значения реквизитов. В этом обработчике можно будет загрузить собственные свойства из соответствия. Например, восстановить параметры отбора.
Сохранение настроек отчетов
У объектов отчет и внешний отчет имеется свойства метаданных ХранилищеВариантов и ХранилищеНастроек. В данных свойствах указывается, в какие хранилища нужно сохранять варианты и настройки отчета соответственно. Если хранилища не указаны, то используются хранилища, указанные в свойствах конфигурации.
Форма отчета предоставляет команды сохранения и загрузки вариантов и настроек отчетов.
Для дополнительной обработки сохранения и загрузки настроек и вариантов отчета в расширении формы отчета имеются следующие обработчики:
- ПриСохраненииВариантаНаСервере – в данный обработчик передаются настройки компоновки данных, которые будут сохраняться. В этом обработчике можно программно добавить в объект настроек дополнительную информацию.
- ПриЗагрузкеВариантаНаСервере – в данный обработчик передается объект настроек, из которого уже загружен вариант отчета. В этом обработчике можно прочитать из объекта настроек дополнительную информацию.
- ПриСохраненииПользовательскихНастроекНаСервере – в данный обработчик передаются пользовательские настройки отчета, которые будут сохраняться. В этом обработчике можно добавить в настройки дополнительную информацию.
- ПриЗагрузкеПользовательскихНастроекНаСервере – в данный обработчик передается объект настроек, которые содержит уже загруженные пользовательские настройки. В этом обработчике можно прочитать из объекта настроек дополнительную информацию.
При необходимости сохранять в настройках компоновки данных или пользовательских настройках компоновки данных некоторую дополнительную информацию можно воспользоваться свойствами ДополнительныеСвойства объектов НастройкиКомпоновкиДанных и ПользовательскиеНастройкиКомпоновкиДанных. Свойство ДополнительныеСвойства представляет собой объект типа Структура.
Порядок разработки хранилища настроек
Далее приводится рекомендованный порядок разработки хранилищ настроек в управляемом приложении:
- Определяется, какое хранилище (см. начало главы) будет использоваться. Например, будем реализовывать хранилище настроек данных форм конфигурации.
- Определяется перечень объектов метаданных, которые будут использовать это хранилище, и определяется перечень хранимой информации, ее структура и типы. Эта информация поможет нам правильно выбрать объект метаданных, в данных которого будут храниться наши настройки.
- На основании информации из п. 2 создается объект (и его структура), который будет хранить настройки. Пусть наши настройки хранятся в элементах справочника. Т. к. в нашем случае структура сохраняемых данных крайне разнородна, то нет смысла реализовывать отдельный набор реквизитов для хранения настроек каждой формы, поэтому настройки будут храниться в реквизите справочника типа ХранилищеЗначения.
- Создается объект типа ХранилищеНастроек и для него выполняется реализация форм сохранения и загрузки. Тем самым мы обеспечиваем интерактивность при сохранении и восстановлении настроек.
- Для созданного объекта ХранилищеНастроек выполняется реализация обработчиков событий, связанных с сохранением и восстановлением настроек. Если не выполнить эту операцию, то не будут происходить собственно операции чтения/записи настроек. Для решения этой задачи нужно реализовать обработчики событий ОбработкаСохранения и ОбработкаЗагрузки в модуле созданного объекта типа ХранилищеНастроек.
- В объектах, выделенных в п. 2 (или в свойствах конфигурации), заполняются соответствующие свойства, тем самым указывая объектам, в каких хранилищах будут храниться настройки. В нашем примере необходимо заполнить свойство конфигурации Хранилище настроек данных форм ссылкой на объект, созданный на шаге 4.
- При необходимости выполняется реализация обработчиков событий, связанных с сохранением и восстановлением настроек в тех прикладных объектах, где это необходимо.
Приложение В. Настройки, сохраняемые платформой в хранилищах настроек
Приложение описывает настройки, которые автоматически сохраняются платформой в системном хранилище.
Хранилище: вариантов отчета
- Настройка: варианты отчета.
- Ключ объекта – полное имя отчета. Например: Отчет.Продажи.
- Ключ настройки – текстовый идентификатор варианта. Например: ПродажиПоРегионам.
- Тип сохраняемого значения – НастройкиКомпоновкиДанных.
Хранилище: настроек отчета
- Настройка: настройки отчета.
- Ключ объекта – текстовая строка, составленная из полного имени отчета, символа «/» и ключа варианта. Например: Отчет.Продажи/ПродажиПоРегионам.
- Ключ настройки – текстовый идентификатор настройки. Пример: МоиКлиенты.
- Тип сохраняемого значения – ПользовательскиеНастройкиКомпоновкиДанны.
Хранилище данных форм
- Настройка: значения полей формы.
- Ключ объекта – полное имя формы. Например: Обработка.ВыгрузкаДанных.Форма.ОсновнаяФорма.
- Ключ настройки – текстовый идентификатор сохраняемых значений. Пример: ВыгрузкаВСбербанк.
- Тип сохраняемого значения – Соответствие. Ключом соответствия выступает текстовый путь к сохраняемому реквизиту данных, а значением является значение реквизита.
Системное хранилище
- Настройка: ключ текущего варианта отчета.
- Ключ объекта – текстовая строка, составленная из полного имени отчета и строки «/КлючТекущегоВарианта» («/CurrentVariantKey»).
- Например: Отчет.Продажи/КлючТекущегоВарианта.
- Ключ объекта – является строковым значением, состоящим из полного имени отчета, ключа варианта отчета (в виде строки) и текста «КлючТекущихПользовательскихНастроек» (CurrentUserSettingsKey), разделенными символами «/».
- Например: Отчет.Продажи/ПродажиПоРегионам/ КлючТекущихПользовательскихНастроек.
- Ключ объекта – является строковым значением, состоящим из полного имени отчета, ключа варианта отчета (в виде строки) и текста «ТекущиеПользовательскиеНастройки» («CurrentUserSettings»), разделенными символами «/».
- Например: Отчет.Продажи/ПродажиПоРегионам/ ТекущиеПользовательскиеНастройки.
- Ключ объекта – является строковым значением, состоящим из полного имени формы и текста «КлючТекущихНастроекДанных» («CurrentDataSettingsKey»), разделенными символом «/».
- Например: Обработка.ВыгрузкаДанных.Формы.ОсновнаяФорма/КлючТекущихНастроекДанных
- Ключ объекта – является строковым значением, состоящим из полного имени формы и текста «ТекущиеДанные» («CurrentData»), разделенными символом «/».
- Например: Обработка.ВыгрузкаДанных.Формы.ОсновнаяФорма/ТекущиеДанные.
- Ключ объекта – является строковым значением, состоящим из полного имени формы и текста «НастройкиФормы» («FormSettings»), разделенными символом «/».
- Например: Обработка.ВыгрузкаДанных.Формы.ОсновнаяФорма/НастройкиФормы.
- Ключ объекта – является строковым значением, состоящим из полного имени формы и текста «НастройкиОкна» («WindowSettings»), разделенными символом «/».
- Например: Обработка.ВыгрузкаДанных.Формы.ОсновнаяФорма/ НастройкиОкна.
- Ключ объекта – «Общее/ИзбранноеРаботыПользователя» («Common/UserWorkFavorites»).
- Ключ настройки – пустая строка.
- Тип сохраняемого значения – ИзбранноеРаботыПользователя. Подробнее смотри раздел «Избранные ссылки пользователя» главы «Сервисные возможности навигации».
- Ключ объекта – строковое значение, один из вариантов:
- полное имя фрагмента командного интерфейса и «/ПанельДействий» («/ActionsPanel»);
- полное имени фрагмента командного интерфейса и «/ПанельНавигации/НастройкиКомандногоИнтерфейса» («/NavigationPanel/CommandInterfaceSettings»);
- «Общее/ПанельРазделов/НастройкиКоманд-ногоИнтерфейса» («Common/PartitionPanel/CommandInterfaceSettings»).
- Например: Подсистема.Продажи/ПанельНавигации/Нас-тройкиКомандногоИнтерфейса.
- Ключ объекта – «Общее/НастройкиРабочегоСтола» («Common/DesktopSettings»).
- Ключ настройки – пустая строка.
- Тип сохраняемого значения – НастройкиРабочегоСтола. Объект без свойств и методов.
- Ключ объекта – строковое значение, состоящее из «Общее/НастройкиПечатиТабличногоДокумента/» («Common/SpreadsheetDocumentPrintSettings/») и имени параметров печати. Например:
- Общее/НастройкиПечатиТабличногоДокумента/РасходнаяНакладная.
Объекты конфигуратора для работы с настройками
меню Справка/Содержание справки/1С предприятие/Встроенный язык/Глобальный контекст/Свойства/Хранилища настроек
меню Справка/Содержание справки/1С предприятие/Встроенный язык/Прикладные объекты/Хранилища настроек
Глобальный контекст
Глобальный контекст содержит ряд свойств (глобальных объектов), используемых для работы с настройками.
Использование: Только чтение.
Тип: СтандартноеХранилищеНастроекМенеджер; ХранилищеНастроекМенеджер.
Доступность: клиент, сервер, внешнее соединение.
Свойства глобального контекста:
- ХранилищаНастроек. Предназначено для доступа к хранилищам настроек.
- ХранилищеВариантовОтчетов. Содержит хранилище для хранения вариантов отчета.
- ХранилищеНастроекДанныхФорм. Содержит хранилище для хранения настроек данных форм.
- ХранилищеОбщихНастроек. Содержит хранилище, используемое для сохранения общих настроек.
- ХранилищеПользовательскихНастроекОтчетов. Содержит хранилище для хранения настроек отчетов.
- ХранилищеСистемныхНастроек. Содержит хранилище, в котором сохраняются системные настройки.
Хранилища настроек
В разделе описываются прикладные объекты, используемые для работы с хранилищем настроек.
СтандартноеХранилищеНастроекМенеджер (StandardSettingsStorageManager)
- Загрузить (Load)
- ПолучитьОписание (GetDescription)
- ПолучитьСписок (GetList)
- Сохранить (Save)
- Удалить (Delete)
- УстановитьОписание (SetDescription)
Описание: Хранилище настроек, хранящее настройки в системных таблицах.
Доступность: клиент, сервер, внешнее соединение.
См. также: Глобальный контекст, свойство ХранилищеСистемныхНастроек
ХранилищаНастроекМенеджер (SettingsStoragesManager)
Элементы коллекции: ХранилищеНастроекМенеджер
Для объекта доступен обход коллекции посредством оператора Для каждого … Из … Цикл. При обходе выбираются хранилища настроек.
Возможно обращение к хранилищу настроек посредством оператора [. ]. В качестве аргумента передается имя хранилища, как оно задано в конфигурации.
- <Имя хранилища> (<Имя хранилища>)
Описание: Коллекция хранилищ настроек, определенных в конфигурации.
Доступность: клиент, сервер, внешнее соединение.
См. также: Глобальный контекст, свойство ХранилищаНастроек
ХранилищеНастроекМенеджер.<Имя хранилища> (SettingsStorageManager.<Имя хранилища>)
- Загрузить (Load)
- ПолучитьМакет (GetTemplate)
- ПолучитьОписание (GetDescription)
- ПолучитьФорму (GetForm)
- ПолучитьФормуЗагрузки (GetLoadForm)
- ПолучитьФормуСохранения (GetSaveForm)
- Сохранить (Save)
- УстановитьОписание (SetDescription)
- ОбработкаЗагрузки (LoadProcessing)
- ОбработкаПолученияОписания (GetDescriptionProcessing)
- ОбработкаСохранения (SaveProcessing)
- ОбработкаУстановкиОписания (SetDescriptionProcessing)
Описание: Объект, предоставляющий доступ к хранилищу настроек определенного типа.
Доступность: клиент, сервер, внешнее соединение.
См. также: ХранилищаНастроекМенеджер, свойство <Имя хранилища>
ВыборНастроек (SettingsChoice)
- ДополнительныеСвойства (AdditionalProperties)
- КлючНастроек (SettingsKey)
- На основании ключа
Описание: Содержит информацию о выбранной пользователем настройке.
Доступность: клиент, сервер, внешнее соединение, тонкий клиент, веб-клиент.
ОписаниеНастроек (SettingsDescription)
- ДополнительныеСвойства (AdditionalProperties)
- КлючНастроек (SettingsKey)
- КлючОбъекта (ObjectKey)
- Пользователь (User)
- Представление (Presentation)
Описание: Содержит информацию об описании настройки.
Доступность: клиент, сервер, внешнее соединение.
- ХранилищеНастроекМенеджер, метод ПолучитьОписание
- ХранилищеНастроекМенеджер, метод УстановитьОписание
- ХранилищеНастроекМенеджер, событие ОбработкаПолученияОписания
- ХранилищеНастроекМенеджер, событие ОбработкаУстановкиОписания
- СтандартноеХранилищеНастроекМенеджер, метод ПолучитьОписание
- СтандартноеХранилищеНастроекМенеджер, метод Сохранить
- СтандартноеХранилищеНастроекМенеджер, метод УстановитьОписание
- ХранилищеНастроекМенеджер, метод Сохранить
- ХранилищеНастроекМенеджер, событие ОбработкаСохранения
Использование форм сохранения и загрузки
В разделе описываются механизмы использования форм сохранения и загрузки.
Форма сохранения
- КлючОбъекта (ObjectKey)
- КлючТекущихНастроек (CurrentSettingsKey)
Описание: Форма, используемая для сохранения настроек. Результатом работы формы должно быть значение типа ВыборНастроек или значение Неопределено в случае, если пользователь отказался от сохранения настройки.
Форма загрузки
- КлючОбъекта (ObjectKey)
- КлючТекущихНастроек (CurrentSettingsKey)
- СтандартныеНастройки (StandardSettings)
Форма, используемая для загрузки настроек.
Результатом работы формы (значение, передаваемое в метод Закрыть()) должно быть значение типа ВыборНастроек или значение Неопределено в случае, если пользователь отказался от загрузки настройки.
Особенности использования механизма настроек
Насколько можно понять из описания, можно выделить две части механизма:
- Использование прикладных объектов хранилища настройки для сохранения/восстановления настроек
- Замена встроенных объектов на определённые в конфигурации (паттерн плагин)
Не очень понятно зачем нужен механизм переопределения стандартных хранилищ, но, наверное, можно что-то придумать. Типа контекстной чувствительности настроек.
В глобальном контексте всегда существует набор объектов-менеджеров хранилищ различного рода настроек, которые и используются системой и/или разработчиками.
- ХранилищеВариантовОтчетов
- ХранилищеНастроекДанныхФорм
- ХранилищеОбщихНастроек
- ХранилищеПользовательскихНастроекОтчетов
- ХранилищеСистемныхНастроек
Сохранение/восстановление пользовательских настроек
Методы СохранитьЗначение и ВосстановитьЗначение не работают на тонком клиенте, поэтому их можно заменить на аналоги, которые исполняются на сервере (значение хранится индивидуально для пользователя).
Хранилище настроек
Объект метаданных ХранилищеНастроек предназначен для обеспечения хранения прикладных настроек конфигурации. За счет реализации обработчиков событий и создания форм объекта выполняется модификация механизма работы с настройками таким образом, что изменяется место хранения настроек (вместо системных таблиц используются объекты конфигурации, которые создал разработчик) и визуальные механизмы работы с настройками.
В конфигурации может быть определено произвольное количество хранилищ настроек.
Хранилище настроек может использоваться как только для программной работы, так и для программной и интерактивной работы. В первом случае для обеспечения необходимой функциональности требуется обязательная реализация обработчиком модуля объекта ХранилищеНастроек:
● ОбработкаСохранения – содержит реализацию метода Сохранить() . В данном обработчике необходимо выполнить сохранение настройки в некоторый объект. Например, в элемент справочника.
● ОбработкаЗагрузки – содержит реализацию метода Загрузить() . В данном обработчике необходимо получить настройки из некоторого объекта.
Например, из элемента справочника.
ВНИМАНИЕ! Если не реализовать тот или иной обработчик, то будет недоступно выполнение действия, которое обработчик реализует. Например, если не реализовать обработчик ОбработкаСохранения , будет недоступно сохранение настроек.
В процессе разработки хранилища разработчик самостоятельно определяет, каким образом будет идентифицироваться объект хранилища, тем самым определяя тип параметра. Например, если настройки сохраняются в справочнике, то в качестве ключа настройки можно использовать поле Код или значение Ссылка (элемента справочника).
Если для работы с настройками требуется интерактивность (формы сохранения и восстановления настроек), то необходимо реализовать формы сохранения и восстановления настроек и заполнить соответствующие свойства объекта ХранилищеНастроек (Основная форма сохранения и Основная форма загрузки).
ВНИМАНИЕ! Реализация форм сохранения и восстановления настроек является обязательной для выполнения интерактивных операций.
Программное сохранение и восстановление настроек возможно и без реализации этих форм.
Когда пользователь применяет команды сохранения или загрузки настроек, система получает соответствующую форму объекта хранилища настроек и отображает ее на экране. Например, при сохранении настроек отчета система будет использовать форму сохранения того объекта метаданных, который указан в качестве хранилища настроек отчетов (непосредственно у самого отчета или у всей конфигурации). При этом форме будут переданы параметры, более подробную информацию о которых можно получить в описании объекта ОписаниеНастроек в синтакс-помощнике.
При создании формы с помощью конструктора необходимые параметры будут автоматически добавлены в список параметров формы.
В формах следует использовать переданные параметры и соответствующим образом фильтровать список настроек. Так, следует отображать только настройки для указанного в параметре КлючОбъекта объекта настройки (например, отчета).
Если пользователь выбрал настройку, то результатом работы формы должно быть значение типа ВыборНастроек. В этом значении, в свойстве КлючНастроек , должен находиться ключ выбранной настройки (например, код элемента справочника или другой, идентифицирующий настройку параметр), а в свойстве Д ополнительныеСвойства – дополнительная информация, которую пользователь мог указать в форме:Закрыть ( Новый ВыборНастроек ( КлючСохраняемойНастройки ));
ВНИМАНИЕ! Не поддерживается сохранение настройки в стандартном хранилище настроек, если длина ключа объекта превышает 256 символов; длина ключа настроек превышает 128 символов; длина имени пользователя превышает 64 символа.2. Создание объекта метаданных
Для создания Хранилища настроек следует создать одноименный объект конфигурации. Это можно сделать в ветке Общие, пункт Хранилища настроек.
Рис. 1. Создание хранилища настроек
3. Стандартное хранилище настроек
Стандартное хранилище настроек представляется во встроенном языке объектом СтандартноеХранилищеНастроекМенеджер. Данный объект реализует тот
же набор методов, что и объект ХранилищеНастроекМенеджер, и дополнительно реализует методы:
● ПолучитьСписок() – метод получения списка настроек для выбранного объекта настройки;
● Удалить() – удаление определенной настройки выбранного объекта настройки.
Стандартное хранилище сохраняет настройки в системных таблицах информационной базы.
В качестве ключа объекта настройки и в качестве ключа настройки системное хранилище настроек принимает строку.
В качестве настроек системное хранилище принимает любое значение, которое может быть помещено в хранилище значений.
Примечание. При использовании методов Сохранить() , Удалить() и УстановитьОписание() объекта СтандартноеХранилищеНастроекМенеджер следует учитывать, что если объект, к которому относятся настройки (например, форма), в текущем сеансе уже использовался, то изменения произойдут только в следующем сеансе.
Совет. При существенном программном изменении настроек (например, при копировании настроек от одного пользователя другому) рекомендуется предложить пользователю выполнить перезапуск клиентского приложения.4. Сохранение настроек форм
Разработчик может управлять сохранением данных форм в настройках. Для этого при разработке формы ему необходимо воспользоваться следующими свойствами формы:
● Сохранение данных формы в настройках – при помощи данного свойства разработчик формы может включить возможность сохранения данных формы (с возможностью выбора настройки, в которую будут сохраняться данные). Если у формы включена необходимость сохранения, то форма предоставляет команды сохранения/загрузки настроек.
● Автоматическое сохранение данных в настройках – указывает необходимость автоматического сохранения настроек при закрытии формы и восстановлении при открытии формы. При этом не важно, используется или нет список настроек.
Если для формы установлена возможность сохранения данных, то необходимо указать, какие реквизиты формы должны сохраняться (колонка Сохранение на закладке Реквизиты редактора формы).
При сохранении настроек в качестве ключа объекта используется полное имя формы. В настройках сохраняется объект типа Соответствие, в котором в качестве ключей находятся пути к сохраняемым реквизитам, а в качестве значений – их (реквизитов) значения.5. Сохранение настроек отчетов
У объектов Отчет и Внешний отчет имеются свойства метаданных Хранилище вариантов и Хранилище настроек. В данных свойствах указывается, в какие хранилища нужно сохранять варианты и настройки отчета соответственно. Если хранилища не указаны, то используются хранилища, указанные в свойствах конфигурации. Если в свойствах конфигурации также не указаны конкретные объекты ХранилищеНастроек , то используется системное хранилище.
Форма отчета предоставляет команды сохранения и загрузки вариантов и настроек отчетов.
При необходимости сохранять в настройках компоновки данных или пользовательских настройках компоновки данных некоторую дополнительную информацию можно воспользоваться свойствами ДополнительныеСвойства объектов НастройкиКомпоновкиДанных и ПользовательскиеНастройкиКомпоновкиДанных . Свойство ДополнительныеСвойства представляет собой объект типа Структура .6. Сохранение настроек динамических списков
Пользовательские настройки динамических списков сохраняются в хранилище, которое указано в свойствах конфигурации ( ХранилищеПользовательскихНастроекДинамическихСписков ). Если в свойствах конфигурации не указано хранилище настроек, то используется системное хранилище.
Возможностью автоматического сохранения пользовательских настроек динамического списка управляет свойство Автоматическое сохранение пользовательских настроек реквизита формы типа ДинамическийСписок . Когда свойство установлено в значение Истина, пользовательские настройки автоматически сохраняются при закрытии формы и загружаются при ее открытии.
Форма динамического списка предоставляет команды сохранения и загрузки пользовательских настроек. Также динамический список предоставляет команду для установки стандартных настроек. В случае выполнения данной команды в динамический список попадут настройки, которые находятся в свойстве Список.КомпоновщикНастроек.Настройки.
Для динамического списка возможен вызов события ПриОбновленииСоставаПользовательскихНастроекНаСервере в следующих случаях:
● При открытии формы динамического списка;
● После завершения редактирования пользовательских настроек, если изменился состав настроек.7. Порядок разработки хранилища настроек
Далее приводится рекомендованный порядок разработки хранилищ настроек:
1. Определяется, какое хранилище (см. начало раздела) будет использоваться. Например, будет реализовано хранилище настроек данных форм конфигурации.
2. Определяется перечень объектов метаданных, которые будут использовать это хранилище, и определяется перечень хранимой в хранилище информации, ее структура и типы. Эта информация поможет нам правильно выбрать объект метаданных, в данных которого будут храниться наши настройки.
3. На основании информации из п. 2 создается объект (и его структура), который будет хранить настройки. Пусть наши настройки хранятся в элементах справочника. Так как в нашем случае структура сохраняемых данных крайне разнородна, то нет смысла реализовывать отдельный набор реквизитов для хранения настроек каждой формы. Поэтому настройки будут храниться в реквизите справочника типа ХранилищеЗначения .
4. Создается объект типа ХранилищеНастроек , и для него выполняется реализация форм сохранения и загрузки. Тем самым обеспечивается интерактивность при сохранении и восстановлении настроек.
5. Для созданного объекта ХранилищеНастроек выполняется реализация обработчиков событий, связанных с сохранением и восстановлением настроек. Если не выполнить эту операцию, то не будут происходить собственно операции чтения/записи настроек. Для решения этой задачи нужно реализовать обработчики событий ОбработкаСохранения и ОбработкаЗагрузки в модуле созданного объекта типа ХранилищеНастроек.
6. В объектах, выделенных в п. 2 (или в свойствах конфигурации), заполняются соответствующие свойства, тем самым указывая объектам, в каких хранилищах будут храниться настройки. В нашем примере необходимо заполнить свойство конфигурации Хранилище настроек данных форм ссылкой на объект, созданный на шаге 4.
7. При необходимости выполняется реализация обработчиков событий, связанных с сохранением и восстановлением настроек в тех прикладных объектах, где это необходимо.8. Работа с хранилищем настроек из встроенного языка
В данном примере рассматривается копирование настроек текущего пользователя другим пользователям системы. В качестве источника настроек используется ХранилищеСистемныхНастроек .
ПРИМЕЧАНИЕ. Пример, приведенный ниже, не является законченным. Он предназначен для демонстрации работы с стандартным хранилищем настроек.
Список имен пользователей передается параметром процедуры СкопироватьНастройки() в виде массива.Процедура СкопироватьНастройки(СписокПользователей )
ОписаниеНастроек = Новый ОписаниеНастроек ;
ВыборкаНастроек = ХранилищеСистемныхНастроек.Выбрать ();
Пока ВыборкаНастроек.Следующий() Цикл
Для каждого Пользователь Из СписокПользователей Цикл
ОписаниеНастроек.Представление = ВыборкаНастроек.Представление ;
ХранилищеНастроек.Сохранить(ВыборкаНастроек.КлючОбъекта, ВыборкаНастроек.КлючНастроек, ВыборкаНастроек.Настройки, ОписаниеНастроек);
КонецЦикла;
КонецЦикла;
КонецПроцедурыПример обработки 1С с сохранением настроек табличного поля
Здравствуйте, уважаемые посетители! На этом блоге уже не раз было написано о работе с табличным полем в 1С8. В двух статьях «Как отобразить флажок в строках табличного поля в системе 1С8?» было рассказано о первом и втором способах отображения флажка в табличном поле. В конце статьи вы можете найти дополнительные ссылки на ресурсы этого сайта, которые помогают еще больше разобраться с темой табличного поля. Если вам интересно, вы можете посмотреть, как реализовано сохранение настройки списка значений с пометками в системе 1С:Предприятие 7.7. А сегодня я хочу поделиться небольшой обработкой, которая нагдядно демонстрирует сохранение настроек табличного поля с типом значения «ТаблицаЗначений» в системе 1С:Предприятие 8.2.
Содержание
Внешний вид обработки обработки сохранения настроек табличного поля следующий:

Небольшое описание работы обработки сохранения настроек табличного поля
Обработка показывает возможность сохранение настроек табличного поля. При ее открытии происходит восстановление заранее сохраненных значений размеров столбцов, высоты ячеек, направления сортировки (упорядочивания) в столбцах табличного поля. Эти значения сохраняются при последнем сеансе работы пользователя 1С. Если пользователь открывает обработку впервые, то для таблицы остаются значения, которые определены для нее по умолчанию.
Бывает, что настройки пользователей 1С не сохраняются и при следующем сеансе работы появляются настройки по умолчанию. Чтобы решить эту проблему необходимо провести тестирование и исправление базы данных в Конфигураторе.
Вы можете проверить работу обработки:
- Изменив размеры столбцов, для этого нужно подвести мышь к шапке таблицы установить ее между двумя колонками до появления курсора с двумя стрелочками по сторонам.
- Поменяв высоту ячеек, для этого нужно на табличном поле правой кнопкой мыши вызвать контекстное меню и выбрать пункт «Настройка списка…». Затем в появившийся форме в поле «Высота:» указать нужную вам высоту.
- Поставив новый режим изменения размера. Содержит признак изменения размера колонки: Изменять (Change), НеИзменять (DontChange). Устанавливается по той же схеме, как и в предыдущем пункте.
- Определив положение колонки по отношению к предыдущей. Содержит варианты расположения колонки табличного поля по отношению к предыдущей: ВТойЖеКолонке (SameColumn), НаСледующейСтроке (OnNextRow), НоваяКолонка (NewColumn). Устанавливается по той же схеме, как и во втором пункте.
- Сменив направление упорядочивания с помощью кнопок сортировки строк в панели обработки.
После изменения настроек табличного поля нужно закрыть обработку и опять открыть. Когда обработка откроется второй раз вы увидите, что ваши изменения сохранились.
Описание программного кода обработки на встроенном языке 1С
Когда пользователь открывает обработку срабатывает процедура «ПриОткрытии» и сохраненные заранее настройки восстанавливаются. Если пользователь открывает обработку первый раз, то восстановления настроек не происходит, а устанавливаются стандартные настройки.
Когда пользователь закрывает обработку срабатывает процедура «ПриЗакрытии» и настройки сохраняются.
Если пользователь нажимает на одну из кнопок сортировки, тогда происходит сортировка либо по убыванию (ПанельСпискаДелСортировкаУбыв), либо по возрастанию (ПанельСпискаДелСортировкаВозр) в зависимости от нажатой кнопки. Также сохраняются значения настроек сортировки.
Если в Конфигураторе открыть свойства табличного поля, то можно найти свойство «ИзменятьПорядокСтрок» (ChangeRowOrder). Это свойство табличного поля разрешает изменять порядок строк. Если снять флажок, то на панели задач обработки исчезают кнопки сортировки строк. Это полезно знать, если нужно заменить стандартные кнопки на свои собственные, как в нашей обработке.
Здесь опубликован не весь программный код обработки для сохранения настроек табличного поля. Но вы можете посмотреть его, да и запустить саму эту обработку, если скачаете её по ссылке. Если у вас другие данные или другая конфигурация, то можно помочь изменить обработку под ваши нужды, обращайтесь. Ещё были даны ответы на вопросы, касающиееся работы с табличным полем здесь. Понравилась ли вам обработка? Что можно изменить, что добавить? Не стесняйтесь делиться об этом в комментариях!
- Ключ объекта – текстовая строка, составленная из полного имени отчета и строки «/КлючТекущегоВарианта» («/CurrentVariantKey»).