OpenObject - Revision history

Admin: 1 revision imported

2021-11-20T17:08:39Z

1 revision imported

1>Admin at 06:43, 16 September 2021

2021-09-16T06:43:09Z

Admin: 1 revision imported

2021-02-07T06:52:16Z

1 revision imported

Admin at 15:48, 2 June 2019

2019-06-02T15:48:33Z

New page

{{infobox function
|name=OpenObject
|object=[[Функции общего назначения]]
|caption=Загрузка модулей
|type=1
|status=2
|db=0
|exception=Невозможно превратить в строку или число, неверный путь, отсутствует заданный модуль, не объект DB
|visual=1}}
{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общее_описание_языка|Общее описание]]
* [[Объекты]]
* [[Функции общего назначения]]}}
Функция позволяет загружать и инициировать выполнение модуля и формы, связанных с заданным объектом, при этом сам объект загружается в форму для редактирования или просмотра. Модуль может быть загружен как модально к текущему потоку (если текущий поток не является корневым), так и создавать новый поток, передавая ему два аргумента. В случае модального исполнения, функция не возвратит результат до тех пор, пока модуль не закончит работы, при этом, модуль может возвратить результат и изменить переданные параметры, если они представляли собой переменные. Функция может возвратить особую строку с результатом, если требуемый объект был заблокирован другим пользователем (см. ниже возвращаемое значение). Функция не может использоваться для локальных клиентов, не связанных с базой данных. Некоторые отличия этой функции от [[LoadModule]], а также особенности поведения модуля и формы, открытых этой функцией:
* Система пытается автоматически блокировать загружаемый объект. После блокировки объект, если он не является новым, будет загружен заново из базы данных, чтобы исключить вероятность устаревания информации. При закрытии формы, система автоматически разблокирует объект, если он был заблокирован.
** При открытии объекта в режиме просмотра блокировка оного не производится, открытому таким образом объекту присваивается признак, не разрешающий его запись в базу данных (см. [[DB.Save]]).
* В открытом модуле объект доступен с помощью комбинации [[Form.Object]], которая будет работать корректно даже до того, как форма была загружена (к примеру, внутри функции ''OnOpen'' после загрузки модуля).
* Статус объекта (флаг того, что он был модифицирован, дата его периодических реквизитов, его строковое представление и пр.) задает заголовок открытой формы по умолчанию. При изменении свойств объекта (к примеру после записи объект теряет флаг модифицированности), заголовок меняется автоматически.
* Если в объекте присутствует по крайней мере один периодический реквизит, в заголовок формы будет также добавлена дата загрузки периодических реквизитов. Изменение периода загрузки реквизитов с помощью функции [[DB.UsePeriod]] автоматически обновит представление данных реквизитов на форме.
* Модуль и форма, используемые системой по умолчанию задаются в [[Студия/Конфигурация данных проекта|Студии]] и зависят от типа открываемого объекта. К примеру, для элемента может использоваться одна форма по умолчанию, а для папки другая.
Загрузка модуля проходит следующие этапы:
{{Load module stages}}

== Синтаксис ==
<code>
'''OpenObject'''(''<Объект базы данных (DB)>'',''<Режим просмотра (INT)>'',''<Способ вызова (INT)>''{{OptionalByRef|,<Параметр>,<Опция>}}{{Optional|,<Имя модуля (STRING)>,<Имя формы (STRING)>}}):''<Результат модального выполнения>''
</code>
==== Аргументы ====
* <code>''<Объект базы данных (DB)>''</code> - Объект базы данных, открытие модуля и формы которого необходимо произвести.
* <code>''<Режим просмотра (INT)>''</code> - 0, если объект открывается для редактирования (будет произведена попытка его блокировки перед открытием), 1, если объект открывается в режиме просмотра.
* <code>''<Способ вызова (INT)>''</code> - Способ вызова открываемого модуля. Возможны следующие значения:
** 0 -- модуль будет загружен модально, если вызов не происходит из корневого модуля. Модальные модули не возвращают управления до тех пор, пока их выполнение не будет завершено. Для визуальных клиентов, модальная форма открывается в той же группе закладок, в которой была открыта вызывавшая форма, при этом создает запрет на активацию последней, до тех пор, пока модальная форма не будет закрыта. Табличные формы, которые могла создать любая из форм, при этом, будут доступны.
** 1 -- модуль создает новый поток (для визуального клиента форма модуля будет помещена в новую группу закладок) в случае, если модуль с таким же путем, именем и именем формы (или объект с таким же идентификатором, при этом, все новые объекты одного вида имеют одинаковые идентификаторы) уже не открыт. Если подобный модуль уже открыт, будет произведена его визуальная активация на экране и вызов визуального события ''OnReopen''.
** 2 -- модуль создает новый поток (для визуального клиента форма модуля будет помещена в новую группу закладок).
** 10 -- модуль будет загружен модально к основному окну системы. При показе такой формы, доступ к любым формам любых потоков будет заблокирован до того момента, как данная форма будет закрыта. Последующие вызовы функций загрузки модулей ([[LoadModule]], [[OpenObject]] и пр.) не разрешены. Данный способ загрузки используется для простых диалоговых окон (которые могут иметь минимальные возможности для редактирования данных) и совпадает по поведению с окнами, получаемыми функциями типа [[Box]].
* <code>''<Параметр>,<Опция>''</code> - {{ByRef}} {{Optional}} Аргументы передаются в вызываемый модуль без изменения, и могут использоваться по усмотрению разработчика. Аргументы будут доступы начиная с первого вызова модуля под именами '''Param''' и '''Option'''. При открытии/загрузке объектов базы данных первый аргумент (''Param'') рекомендуется использовать для указания на родителя (Parent) текущего элемента или списка элемента справочников. Система сама может пытаться использовать по умолчанию значение этого аргумента, как родителя справочника при загрузке объектов (это поведение, однако, может быть изменено). Если аргументы представлены переменными и модуль вызывается в модальном режиме, вызываемая программа может изменить значения этих переменных и, после того, как вызываемый модуль закончит работу, измененные значения будут переданы в исходных переменных.
* <code>''<Имя модуля (STRING)>''</code> - {{Optional}} Имя загружаемого модуля, если этот параметр не указан, будет использовано имя, заданное в [[Студия/Конфигурация данных проекта|Студии]].
* <code>''<Имя формы (STRING)>''</code> - {{Optional}} Имя загружаемой формы, если этот параметр не указан, будет использовано имя, заданное в [[Студия/Конфигурация данных проекта|Студии]]. Если форма не будет использоваться (загруженный модуль будет закрыт, так как функция ''OnOpen'' возвратит 0, либо произойдет исключение и пр.), т.е. загрузка будет прервана до начала загрузки визуальной части, этот параметр не имеет значения.

==== Возвращаемое значение ====
Функция возвращает значение переменной '''ModalResult''', которая доступна для изменения в вызываемом модуле. Переменная будет возвращена только в случае, если модуль вызывается в модальном режиме. Если объект открывался в режиме редактирования (<Режим просмотра>=0), функция может возвратить сл. строки:
* <code>"LOCKED@RO"</code> (только для режимов <Способ вызова> 1 или 2), если объект заблокирован другим пользователем и текущий пользователь решил открыть его в режиме просмотра.
* <code>"LOCKED@CL"</code> (для любых режимов <Способ вызова>), если объект заблокирован другим пользователем и текущий пользователь отказался от попытки его открыть (отменил функцию загрузки объекта).

== Примеры ==
<pre>
//Открывается документ аДок в режиме редактирования, если он уже не был открыт, иначе произойдет активация открытого документа.
OpenObject(аДок,0,1);

//Родитель текущего элемента справочника открывается для редактирования, при этом, если попытка открытия удалась, текущий элемент закрывается (если он не был изменен и не новый).
if OpenObject(Эл.Parent(),0,1)="LOCKED@CL" then
Exit;
ElseIf Эл.Selected()=1 Then
Form.Close(0);
Endif;
</pre>

← Older revision	Revision as of 17:08, 20 November 2021
(No difference)

@@ Line 34: / Line 34: @@
 ** 1 -- модуль создает новый поток (для визуального клиента форма модуля будет помещена в новую группу закладок) в случае, если модуль с таким же путем, именем и именем формы (или объект с таким же идентификатором, при этом, все новые объекты одного вида имеют одинаковые идентификаторы) уже не открыт. Если подобный модуль уже открыт, будет произведена его визуальная активация на экране и вызов визуального события ''OnReopen''.
 ** 2 -- модуль создает новый поток (для визуального клиента форма модуля будет помещена в новую группу закладок).
-** 10 -- модуль будет загружен модально к основному окну системы. При показе такой формы, доступ к любым формам любых потоков будет заблокирован до того момента, как данная форма будет закрыта. Последующие вызовы функций загрузки модулей ([[LoadModule]], [[OpenObject]] и пр.) не разрешены. Данный способ загрузки используется для простых диалоговых окон (которые могут иметь минимальные возможности для редактирования данных) и совпадает по поведению с окнами, получаемыми функциями типа [[Box]].
+** 10 -- модуль будет загружен модально к основному окну системы. При показе такой формы, доступ к любым формам любых потоков будет заблокирован до того момента, как данная форма будет закрыта. Последующие вызовы функций загрузки модулей ([[LoadModule]], [[OpenObject]] и пр.) в режимах, не совпадающих с 10 или 11, не разрешены. Данный способ загрузки используется для простых диалоговых окон (которые могут иметь минимальные возможности для редактирования данных) и совпадает по поведению с окнами, получаемыми функциями типа [[Box]].
 * <code>''<Параметр>,<Опция>''</code> - {{ByRef}} {{Optional}} Аргументы передаются в вызываемый модуль без изменения, и могут использоваться по усмотрению разработчика. Аргументы будут доступы начиная с первого вызова модуля под именами '''Param''' и '''Option'''. При открытии/загрузке объектов базы данных первый аргумент (''Param'') рекомендуется использовать для указания на родителя (Parent) текущего элемента или списка элемента справочников. Система сама может пытаться использовать по умолчанию значение этого аргумента, как родителя справочника при загрузке объектов (это поведение, однако, может быть изменено). Если аргументы представлены переменными и модуль вызывается в модальном режиме, вызываемая программа может изменить значения этих переменных и, после того, как вызываемый модуль закончит работу, измененные значения будут переданы в исходных переменных.
 * <code>''<Имя модуля (STRING)>''</code> - {{Optional}} Имя загружаемого модуля, если этот параметр не указан, будет использовано имя, заданное в [[Студия/Конфигурация данных проекта|Студии]].

← Older revision	Revision as of 06:52, 7 February 2021
(No difference)