Язык @-формул в LotusDomino R 6.

Команды открытия объектов


@Command( [FileOpenDatabase]; "сервер" :

     "база_данных"; "вид"; "ключ"; "окно"; "флаг" )

@Command( [FileOpenDatabase]; "сервер" :

     "база_данных"; "навигатор";

     "окно_навигатора"; "окно"; "флаг" )

Область применения: нельзя применять в формулах диалогового окна. Можно использовать в Web-приложениях при условии, что параметр "сервер" есть пустая строка. Если используется синтаксис с третьим параметром "вид", то следующей командой в формуле обязательно должна быть [OpenDocument].

Открывает указанную базу данных с использованием заданного вида или навигатора.

Все параметры, за исключением ключевого слова, являются необязательными, однако если необходимо задать шестой параметр, а с третьего по пятый опустить, то необходимо все равно задать их как пустые строки.

Параметр "сервер" определяет имя сервера, содержащего базу данных, если он равен пустой строке, то предполагается, что БД расположена на локальном компьютере.

Параметр "база_данных" задает имя файла базы данных. Если он:

  • задан как пустая строка, то просматриваются все окна в порядке их возникновения. Если в каком-либо окне открыта база или ее иконка выбрана в рабочем пространстве, то открывается именно эта первая найденная база;
  • если ни в одном окне это условие не выполняется, либо команда вызвана только с одним - ключевым словом, то выдается диалоговое окно выбора базы данных для открытия.
  • Аргумент "вид" задает имя или алиас вида/папки, которые должны открыться первыми при открытии базы данных. Если параметр "вид" опущен, то будет открыт либо вид по умолчанию или вид, которым последний раз открывал именно этот пользователь.

    "Ключ" задает значение, которое должно соответствовать значению в первой отсортированной колонке вида. В случае такого соответствия на первый такой документ устанавливается световой маркер вида. Если параметр опущен, то никакой документ не выбирается.




    При задании параметру "окно" значения "1" указанная база будет открываться в новом окне, даже в случае, если она уже была открыта с использованием указанного вида.

    Параметр "флаг" при значении "1" запрещает добавлять иконку для открываемой базы на рабочее пространство, при условии, что ее там раньше не было.

    Аргумент "навигатор" задает имя навигатора, которые должны отображаться при открытии базы данных, "окно_навигатора"

    равное "1" заставляет его открываться в полноэкранном режиме.

    Пример 1. Команда открывает локальную базу данных "D:\Book\123\Glossary.nsf" по виду с алиасом "Rusterm", который в первой отсортированной колонке имеет документ со значением "Вид личный".

    @Command( [FileOpenDatabase]; "" :

       "D:\\Book\\123\\Glossary.nsf"; "Rusterm";

       "Вид личный" )

    Пример 2. Открывается эта же база, но по навигатору "Main", который открывается в полноэкранном режиме.

    @Command( [FileOpenDatabase]; "" :

       "D:\\Book\\123\\Glossary.nsf"; "Main"; "1" )

    @Command( [FileOpenDBRepID];

         "идентификатор_реплики"; "сервер"; "вид";

         "ключ"; "окно"; "флаг" )

    @Command( [FileOpenDBRepID];

         "идентификатор_реплики"; "сервер";

         "навигатор"; "окно_навигатора"; "окно";

         "флаг" )

    Область применения: нельзя применять в формулах диалогового окна.

    Открывает базу, указанную идентификатором реплики, с использованием заданного вида или навигатора.

    Все параметры, за исключением ключевого слова, являются необязательными.

    Параметры "вид", "ключ", "окно", "флаг", "навигатор"

    и "окно_навигатора" имеют такой же синтаксис и семантику, что и в команде [FileOpenDatabase].



    Параметр "идентификатор_реплики"

    определяет идентификатор реплики нужной базы данных, "сервер"

    - указывает предполагаемый сервер, на котором эта база находится.

    Для поиска базы данных по идентификатору реплики используется следующий алгоритм, сначала просматривается рабочее пространство пользователя, затем база ищется на сервере "сервер", и уже потом на остальных доступных в текущей сессии серверах.

    @Command( [OpenDocument]; "флаг"; UNID;

                            "ширина_окна" : "высота_окна" )

    Область применения: вид/папка базы данных должны быть открыты в текущем окне. В открытом виде/папке должен присутствовать открываемый документ.

    Открывает документ на чтение/редактирование по его универсальному идентификатору.

    Все параметры, кроме ключевого слова, необязательны.

    Параметр "флаг" при значении "1" вызывает требуемый документ в режиме редактирования, при "0" - в режиме чтения. Значение по умолчанию "0".

    Аргумент UNID задает универсальный идентификатор документа. В случае если он опущен, то открывается текущий документ в виде/папке.

    Параметр "ширина_окна" : "высота_окна"

    задает в дюймах соответственно высоту и ширину окна, в котором будет создаваться документ. Параметр не имеет смысла, когда выбран MDI (Multiple Document Interface многооконный интерфейс в рамках главного окна) интерфейс, и окно имеет установленное свойство - максимальный размер. В случае если этот параметр опущен или равен нулю, то окно имеет размеры, сохраненные последним пользователем.

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

    В Web-приложениях [OpenDocument] может быть использована исключительно без параметров UNID и "ширина_окна" : "высота_окна", и только если ей предшествует команда [OpenView] или [FileOpenDatabase] с определенным набором параметров:

    • для [FileOpenDatabase] (см. стр. 254) применим только вариант синтаксиса с параметром "вид", но не "навигатор", причем должен быть еще задан параметр "ключ", и "сервер" в виде пустой строки. Остальные параметры должны быть опущены;




    • для [OpenView] (см. стр. 258) должны быть заданы параметры "вид" и "ключ". Остальные параметры должны быть опущены.


    • В обоих случаях параметр "вид"

      должен быть задан явно (т.е. не в виде пустой строки), а в качестве "ключа"

      может быть использован псевдоидентификатор $first, который соответствует первому документу в виде.

      Пример 1. В виде с именем "View1" четвертый столбец определяется по формуле @Text( @DocumentUniqueID ), а первый столбец сортировочный. Тогда формула, примененная в акции вида, сначала запросит значение ключа из первой колонки вида, затем найдет по ключу UNID этого документа, и, наконец, откроет этот документ на редактирование.

      ch := @Prompt( [OkCancelEdit]; "Введите искомое

         значение"; "Введите значение для поиска документа";

         "" );

      ch1 := @DbLookup( "" : "NoCache"; ""; "View1"; ch; 4 );

      @Command( [OpenDocument]; "1"; ch1 )

      Пример 2. В Web-приложении следующая формула открывает первый документ в виде People базы данных Domino Directory текущего сервера:

      @Command([FileOpenDatabase]; "" : "names.nsf"; "People"; "$first");

      @Command([OpenDocument]; "0")

      Пример 3. В текущей БД имеется скрытый вид «(By UNID)», первая колонка которого имеет сортировку и определяется по формуле @Text( @DocumentUniqueID ). В Web-приложении формула, примененная в акции формы, откроет на редактирование родительский документ по отношению к текущему.

      @Command([OpenView]; "(By UNID)"; @Text( $Ref ));

      @Command([OpenDocument]; "1")

      @Command( [OpenView]; "вид"; "ключ"; "окно" )

      Область применения: БД должна быть открыта или ее иконка должна быть выделена в рабочем пространстве. Можно использовать в Web-приложениях.

      Открывает вид/папку для текущей базы данных. Все параметры за исключением ключевого слова необязательны.



      Аргумент "вид" задает имя или алиас вида/папки, если он опущен, то открывается либо вид по умолчанию, либо вид, которым последний раз открывал текущий пользователь. Параметр "ключ"

      определяет значение, которое должно соответствовать информации из первой отсортированной колонки вида. В случае успешного поиска на первый такой документ устанавливается световой маркер вида.

      При задании параметру "окно"

      значения "1" вид будет открываться в новом окне, даже в случае, если он уже был открыт в другом окне.

      Для использования команды в Web-приложениях параметр "окно" должен быть опущен, а "ключ"

      может иметь значение псевдоидентификатора $first, который соответствует первому документу в виде.

      Пример. Формула, при использовании в акции формы, в процессе выполнения открывает вид для того, чтобы возможно стало выполнить команду [OpenDocument] (см. пример к этой команде).

      ch := @Prompt( [OkCancelEdit]; "Введите искомое

         значение"; "Введите значение для поиска документа";

         "" );

      ch1 := @DbLookup( "" : "NoCache"; ""; "View1"; ch; 4 );

      @Command( [OpenView]; "View1" );

      @Command( [OpenDocument]; "1"; ch1 )

      @Command( [OpenFrameset];

            "имя_набора_фреймов" )

      Область применения: предназначена для использования в акциях формы и видов. Можно использовать в Web-приложениях.

      Открывает определенный набор фреймов текущей базы данных.

      Параметр "имя_набора_фреймов"

      обязательный. Он определяет имя или алиас открываемого набора фреймов.

      Пример. Команда, используемая в акции вида, открывает набор фреймов с именем "Main" для текущей базы данных.

      @Command( [OpenFrameset]; "Main" )

      @Command( [OpenNavigator]; "навигатор";

                "окно_навигатора" )

      Область применения: БД должна быть открыта или ее иконка должна быть выделена в рабочем пространстве. Можно использовать в Web-приложениях при опущенном третьем параметре.



      Открывает указанный навигатор в текущей базе данных.

      Аргумент "навигатор" задает имя или алиас навигатора, а "окно_навигатора" равное "1" заставляет его открываться в полноэкранном режиме.

      @Command( [OpenPage]; "страница" )

      Область применения: БД должна быть открыта или ее иконка должна быть выделена в рабочем пространстве. Предназначена для использования в акциях формы и видов. Можно использовать в Web-приложениях.

      Открывает определенную страницу текущей базы данных.

      Параметр "страница" обязательный. Он определяет имя или алиас открываемой страницы.

      Пример. Команда, используемая в акции вида, открывает страницу с именем "First" для текущей базы данных.

      @Command( [OpenPage]; "First" )

      @Command( [HelpAboutDatabase] )

      @Command( [HelpUsingDatabase] )

      Область применения: БД должна быть открыта или ее иконка должна быть выделена в рабочем пространстве.

      Открывают соответственно документы "О базе данных" и "Об использовании базы данных" для текущей базы данных.

      Данные команды иногда применяются в приложениях в формулах навигаторов и акций.

      @Command( [OpenHelpDocument]; "сервер" :

          "база_данных"; "вид"; "ключ" )

      @Command( [OpenHelpDocument];

           [тип_справочника]; "вид"; "ключ" )

      Область применения: справочная БД должна быть одна на сервере или в локальной директории. Первый столбец указанного вида должен быть сортировочным. Можно использовать в Web-приложениях в формулах кнопок.

      Открывает определенный вид, указанной справочной базы данных, и становится на нужный документ.

      Все параметра за исключением ключевого слова необязательны.

      В первом варианте явно задается местоположение справочной базы данных. Параметр "сервер" задает имя сервера, если это пустая строка, то считается, что справочная БД расположена локально. "База_данных"

      задает имя файла справочной базы данных. Если этот параметр опущен, то ищется справочная база по клиентской части.



      Второй вариант определяет справочную базу данных из установленных, с помощью ключевого слова [тип_справочника]. Данный флаг может принимать следующие значения:

      • [ClientHelp] - для справочной базы о программном обеспечении рабочей станции;


      • [DesignerHelp] - для справочной базы о программном обеспечении разработчика приложений;


      • [AdminHelp] - для справочной базы о программном обеспечении администратора системы.


      • Аргумент "вид" задает имя или алиас вида/папки, которые должны открыться первыми при открытии базы данных.

        "Ключ" задает значение, которое должно соответствовать значению в первой отсортированной колонке вида. В случае такого соответствия на первый такой документ устанавливается световой маркер вида.

        Пример. Формула запрашивает у пользователя тип справочной базы, затем интересующий его термин, и после этого выдает справочную информацию по нему из соответствующей базы по индексу "Index".

        Ch := @Prompt( [OkCancelCombo]; "Выбор базы";

           "Выберите справочную базу данных.";

           "Справка по клиенту"; "Справка по клиенту" :

           "Справка по дизайнеру":

           "Справка по администрированию" );

        ch1 := @Prompt( [OkCancelEdit]; "Введите искомое

           значение"; "Введите значение для поиска  документа";

           "" );

        @If( ch = "Справка по клиенту";

           @Command( [OpenHelpDocument];[ClientHelp];

           "Index"; ch1 ); ch = "Справка по дизайнеру";

           @Command( [OpenHelpDocument]; [DesignerHelp];

           "Index"; ch1); @Command( [OpenHelpDocument];

           [AdminHelp]; "Index"; ch1 ))

        @Command( [FileExit] )

        Область применения: нельзя применять в формулах диалогового окна. Всегда выполняется последней в формуле.

        Выполняет команду File - Exit (Файл - Выход из Notes).

        В случае если в каком-либо окне присутствует не сохраненный отредактированный документ или элемент дизайна выдает диалоговое окно с вопросом о сохранении изменений.

        В приложениях данная команда иногда применяется в главном полноэкранном навигаторе для выхода в операционную систему.

        J @Command( [ExitNotes] )

        Область применения: нельзя применять в формулах диалогового окна.

        Выполняет команду File - Exit (Файл - Выход из Notes). Аналогична @Command( [FileExit] ) за тем лишь исключением, что выполняется немедленно в формуле, а не после всех остальных команд.


        Содержание раздела