This content was uploaded by our users and we assume good faith they have the permission to share this book. If you own the copyright to this book and it is wrongfully on our website, we offer a simple DMCA procedure to remove your content from our site. Start by pressing the button below!
Предисловие автора Книга, которую Вы держите в руках, посвящена вопросам программирования на языке @-формул. Данный язык широко используется при создании приложений под управлением Lotus Domino/Notes версии R 6 программного продукта компании IBM Company. Книга состоит 3 частей и двух сегментов приложений. В первой части (главы 1- 5) рассматривается синтаксис языка @-формул, его лексические элементы, последовательность выполнения формул и механизмы обработки ошибок. Во второй части (глава 6) приведены наиболее употребляемые в разработках @-функции с примерами их использования. Третья часть содержит часто используемые @-команды, так же с наглядными примерами. Сегмент приложений содержит полные алфавитные списки @-функций, @-команд, контекст их применения, а так же имеющихся ограничения их использования на различных платформах. Примеры, используемые в настоящей книге, тестировались на версии Lotus/Domino R 6.0.1 под управлением Windows-2000 (в некоторых случаях использовался Linux Red Hat 8). Тестировании Web-приложений выполнялось в браузере MS Internet Explorer 5.0. Автор отдает себе отчет в том, что книга не лишена недостатков, и имеет к себе претензии по стилю изложения и оформления материала. Ряд ее разделов хотелось бы улучшить, дополнить и снабдить более интересными примерами. Однако в условиях необычайно быстрого развития продукта лучше скорее дать в руки читателей информацию в том виде, как она есть сейчас, чем отложить выпуск книги еще на один-два месяца. Автор будут искренне рад Вашим замечаниям и предложениям по содержанию книги и любой информации технического характера по затронутым в книге вопросам. Направляйте их по e-mail: [email protected] или «оставляйте» на WWW-сервере нашей компании http://www.intertrust.ru. Автор выражают искреннюю благодарность и признательность всем, кто оказывал прямую или косвенную помощь в работе над книгой. Особые благодарности ведущим сотрудникам компании InterTrust Co.: Ионцеву Н. Н., Панову В. А., Ардабьеву И. Н., Иванову Д. Ю., Кадникову А. О. – без помощи которых, книга выглядела бы другой. Специальные благодарности: Бреусу И. Б., Поляковой Г. Д., Полякову В. Г. и Перлич Н. А. за существенную помощь, оказанную при написании настоящей книги, а также сыну Роману и дочери Лане за терпение и сочувствие во время работы над книгой. С уважением, Е. Поляков
1 Введение Формулы или @-формулы состоят из одного или более предложений - операторов (statements), которые обычно выполняются по порядку (более подробно это будет рассмотрено в пункте "4.4"). Префикс @происходит от частого использования в таких формулах вызовов @-функций. В приложениях Domino формулы широко используются в следующих целях:
•
отбор документов при селективных репликациях;
•
отбор документов для включения в вид;
•
вычисление значений для показа в документах, видах и папках;
•
определение видимости абзаца формы, абзаца в RichText-поле документа, объекта в области размещения, акции в форме или виде;
•
вычисление, преобразование и проверка значений полей документов;
•
добавление и удаление полей в документах;
•
определение формы, используемой для открытия документа в виде;
•
определение вычисляемых субформ в форме;
•
выполнение последовательности действий при запуске агента, клике по кнопке панели инструментов, акции в виде, активного участка в навигаторе, акции, кнопки или активного участка в форме.
В Notes версий 3.x @-формулы были практически единственным средством для вычислений и автоматизации обработки информации. В 4-й версии появились, по крайней мере, еще два способа: один более простой, но ограниченный - простые действия (simple actions), другой более сложный, но богатый по своим возможностям - объектно-ориентированный язык программирования LotusScript. Пятая версия Domino в дополнение к языку LotusScript дала разработчикам возможности использования объектноориентированного языка Java, который в последнее время стал фактически стандартом для создания Internet-приложений.
В R 6 язык @-формул значительно обновился и стал более похож на процедурный язык (появились операторы цикла, разрешено повторное присваивание значений временным переменным, операторы присваивания допускают вложенность, и т. д.). Кроме этого появились новые элементы дизайна, поддерживающие язык @-формул (например, формула поля Input Enabled [разрешить/запретить ввод в поле]).
Обратите внимание, что новые или модифицированные в версии R 6 @функции и @-команды помечены значком ϑ перед заголовками. Java и LotusScript обеспечивают множество операций, невозможных для @-формул. Например, модификацию списка управления доступом к базе (ACL), но часто использование @-формул бывает проще и эффективнее, а во многих местах @-формулы остались единственным вариантом. Например, в кнопках панели инструментов, при селективных репликациях, для определения видимости объектов, в колонках, критериях отбора и формулах формы видов, в формулах полей.
2 Синтаксис формул Формула состоит из одного или более операторов (statements), разделяемых символом точка с запятой («;»). Синтаксис формул должен подчиняться следующим правилам:
•
формула должна начинаться с ключевого слова, вызова @-функции, переменной или константы;
•
формула должна заканчиваться переменной, константой или @-функцией;
•
аргументы @-функций отделяются друг от друга с помощью символа «;»;
• •
• •
список аргументов функций заключается в скобки. Если аргументы не требуются, скобки можно опустить;
допускается размещать произвольное количество пробелов и переводов строки (в том числе ни одного) между операторами формул и выполнения операций;
за ключевым словом должен следовать хотя бы один пробел;
регистр (прописные или строчные буквы) не имеет значения, кроме как внутри текстовых констант. Ключевые слова автоматически преобразуются в верхний регистр при сохранении формулы.
3 Лексические элементы формул Каждый оператор формулы может состоять из:
•
переменных;
•
констант;
•
операторов выполнения операций (operators), не путать с операторами формул (statements);
•
встроенных @-функций;
•
ключевых слов.
3.1 Переменные Переменные бывают двух типов: поля и временные переменные (также называемые временными полями).
3.1.1 Поля Поля - наиболее часто используемые переменные в формулах. Формула имеет доступ к полям обрабатываемого документа. Для ссылки на значение поля нужно вставить в формулу название поля. При этом важно не забывать о типе данных поля. Большинству функций требуются определенные типы аргументов, а операторам - определенные типы операндов. Для определения типа и имени поля можно обратиться к дизайну конкретной БД. При использовании полей в качестве переменных в формулах, наиболее часто встречаются ошибки для полей типа RichText и полей с множественными значениями (multi-values field). RichText-поля, как правило, не могут использоваться как переменные. Тем не менее, в формуле агента можно присвоить значение такому полю с помощью ключевого слова FIELD, а функция @DbLookup может получить содержимое RichText-поля из другого документа. Функцию @IsAvailable( FieldName ) можно использовать для установления факта наличия в документе поля (в том числе RichText) с таким именем.
Для multi-values-полей следует помнить, что только достаточно ограниченное число @-функций и операторов работают со списками. Для определения является ли значение поля списком можно воспользоваться функцией @Elements( FieldName ). Если возвращаемое значение больше единицы, это говорит о том, что значение поля действительно список. Формулы могут модифицировать значение полей в документе только в том случае, если эти действия не противоречат списку управления доступом к текущей БД. Имена полей в формулах могут использоваться различными путями:
•
• •
для определения значений по умолчанию. При создании нового документа, если в форме установлено "наследование" полей, возможны ссылки на поля в документе, который был открыт или выделен в момент создания. Эта возможность широко используется в Domino при разработке форм для документов-ответов, при создании новых документов "по образцу"; в выражениях для получения новых значений с помощью операторов. Например, формула в колонке вида: FirstName + " " + LastName, где FirstName и LastName - поля в документах, содержащие фамилию и имя; для задания аргументов функций. Здесь возможны два принципиально различных варианта:
• •
название поля используется для ссылки на содержащееся в поле, например, @Text( BirthDate );
значение,
название поля используется как текстовая строка, например формула возвращает содержимое поля Status в документе, найденном по ключу "Virus Check":
Оператор с ключевым словом FIELD присваивает значение полю, если оно уже существует в документе, в противном случае создается новое поле с таким именем. Его тип данных определяется типом присваиваемого значения. Таким же образом можно и удалить поле из документа: FIELD FieldName := @DeleteField;
Поля, значения которых не определены, имеют значение пустой строки (""). Это правило справедливо для полей любых типов, включая и нетекстовые поля. В связи с этим возникает достаточно много ошибок несовместимости типов данных. Для решения этой проблемы рекомендуется для нетекстовых полей определять формулу значения поля по умолчанию.
3.1.2 Предопределенные поля В документах Domino могут присутствовать поля, содержащие определенную служебную информацию. Например, $UpdatedBy, $Revisions, $Ref, $Conflict, Form и т.д. Не все из этих полей (и не во всех контекстах) могут быть использованы в качестве переменных @-формул (для каждого конкретного случая необходимо обращаться к документации). Так, например, в акции формы формула @Prompt( [Ok]; "First Editor"; @Subset( $UpdatedBy; 1 )) действительно выдаст окно с именем первого автора документа, однако формула @SetField( "$UpdatedBy"; "Ivan I Ivanov" ) не изменит значения поля $UpdatedBy. Следует заметить, что сразу после выполнения данной формулы, если посмотреть значение поля $UpdatedBy (например, через окно свойств), то его значение действительно будет "Ivan I Ivanov", но по выходу из режима редактирования (даже с сохранением) Lotus сам восстановит значение указанного поля. Наиболее часто из предопределенных полей в @-формулах используется поле Form. Данное поле содержит имя формы, по которой текущий документ должен отображаться/модифицироваться по умолчанию. Поле Form может использоваться в @-формулах так же как и любое другое не предопределенное поле.
3.1.3 Временные переменные Временные переменные доступны только в пределах формулы, в которой они определены (от определения до конца формулы) и в течение одного выполнения этой формулы. Создание и инициализация временной переменной аналогично инициализации поля, но без ключевого слова FIELD: VariableName := Value;
Тип данных временной переменной соответствует типу значения в правой части оператора присваивания. Этот тип может быть Text, Time, Number или Boolean. Последний - логический - возвращается некоторыми @-функциями
и может принимать значения True (Истина - эквивалентно числу 1) или False (Ложь - эквивалентно числу 0). В R 6 снято ограничении на то, что в пределах одной формулы переменная с одним и тем же именем не должна более одного раза встречаться в левой части оператора присваивания. Для изменения значение временной переменной в процессе выполнения формулы можно использовать как оператор присваивания, так и функцию @Set: VariableName := 1; . . . VariableName := 2;
так и : VariableName := 1; . . . @Set( VariableName; 2 );
3.2 Константы В формулах можно использовать константы трех типов: текстовые, числовые и типа дата-время. Список значений также может использоваться в качестве константы.
Текстовые константы в формулах заключаются в двойные кавычки: "Text constant". В R 6 текстовые константы можно заключать в фигурные скобки. {Text constant}. Чтобы многократно повторить один и тот же символ используйте функцию @Repeat. Обратный слеш «\» внутри текстовой константы служит Esc-символом. Таким образом, если текст в константе, заключенной в двойные кавычки, должен содержать символы «"» или «\» перед ними нужно вставлять добавочный символ «\». В некоторых случаях после сохранения формулы с фигурными скобками, выступающими в качестве ограничителей текстовой константы, последние преобразуются к «\"».
Числовые константы могут состоять из специальных символов, неразделенных пробелами. соблюдаться следующие правила:
• •
символов цифр и При этом должны
первый символ «+» или «-» определяет знак числа, соответственно положительное значение, или отрицательное; целые числа состоят только из символов цифр, неразделенных пробелами;
нецелые числа могут быть представлены в обычной и математической нотации. Для обычной нотации десятичная точка может находиться перед, после или внутри последовательности символов цифр, неразделенных пробелами. Для математической нотации – число может содержать суффикс из символа «Е» и следующих за им чисел, определяющих показатель степени со знаком или без. Например, 123, -123, 1.23, -0.123, 1.23E-12.
Дата-время (Time-date) константы должны быть заключены в квадратные скобки. Например, [5:30], [30.3.93] или [30.3.93 5:30]. Формат представления даты и времени (порядок следования, разделители и т.д.) должен соответствовать стандартам, установленным в операционной системе. При использование сокращенного формата даты для года, например, [dd.mm.yy], если yy < 50 - считается, что это 20yy год, в противном случае 19yy год. Используйте полный формат даты для года, если это необходимо. Результат вычитания двух значений типа дата-время есть целое число, представляющее разницу во времени между этими значениями в секундах. Например, формула: @Prompt( [OK]; "Проба"; @Text( [30.3.93 5:30]- [30.3.93 5:29] ));
выдаст окно со значением 60.
3.3 Операторы выполнения операций В таблице, приведенной ниже, перечислены все допустимые в @формулах операторы в порядке убывания их приоритета. Горизонтальные линии отделяют группы операторов с разным приоритетом. Если в одном выражении встречаются операторы одного приоритета, они выполняются слева направо. Изменить порядок выполнения можно с помощью круглых скобок.
Оператор
Название, описание
Приоритет
:=
Присваивание. В R 6 допустимы вложенные операторы присваивания
Если бы в первом операторе формулы не взять в скобки (Country := "Египет"), то значение переменной Country было бы Египет\Хургада. Более наглядно последовательность выполнения вложенных операторов видна из следующего примера: A := 2; B := 3; C := 4; D := 5; E := @Text( A * B := C + D ); @Prompt([Ok]; "A"; @Text(A)); - выдаст 2 @Prompt([Ok]; "B"; @Text(B)); - выдаст 9, т.к. 4+5 = 9 @Prompt([Ok]; "C"; @Text(C)); - выдаст 4 @Prompt([Ok]; "D"; @Text(D)); - выдаст 5 @Prompt([Ok]; "E"; E); - выдаст 18, т.к. 2*9 = 18
В левой части от оператора присваивания как префикс перед переменной типа поля (но не временной переменной) могут стоять ключевые слова DEFAULT, ENVIRONMENT, или FIELD. Для вложенных операторов присваивания допустимо только ключевое слово FIELD. FIELD Categories := @UpperCase(FIELD Country := "Египет" + "\\" + "Хургада");
Оператор двоеточие «:» используется для объединения двух значений одного типа данных в список. Каждый из операндов сам может быть списком. Результат содержит все элементы первого операнда, затем все элементы второго. При многократном использовании в одном выражении можно объединить в список несколько значений: "Moscow" : "London" : "New York" : "Tokyo"
В R 6 появился новый оператор квадратные скобки «[]», который позволяет выделить N-й элемент списка по его индексу: my_list := "Moscow" : "London" : "New York" : "Tokyo"; @Prompt([Ok]; "Информация"; my_list[2]) – выдаст London
В качестве индекса может выступать константа, переменная или выражение, имеющие числовое значение (десятичные числа округляются до ближайшего целого). Первый элемент списка имеет индекс – 1. При выходе значения индекса за границы слева и справа, возвращается сообщение об ошибке «Array index out of bounds» («Индекс массива выходит за границы»).
Оператор выделения элемента списка может применяться для любых типов данных, которые могут принимать значение списков (текст, числа, дата/время), даже если значение скалярно (т.е. не список). Для типов данных, которые не могут принимать значение списков (Rich text поля), допустимо использование только индекса 1. Bозвращаемое значение в этом случае равно текущему уже сохраненному значению Rich text поля без изменений. Rem "поле my_date имеет тип Data/Time содержит значение 26.04.1964, и не допускает принятие множественных значений типа список «Allow multiple values»"; @Prompt([Ok]; 12.04.1964
"Информация";
@Text(my_date[1]));
-
выдаст
Оператор выделения элемента списка не может быть использован в левой части оператора присваивания. Таким образом нельзя изменить значение списка присваиванием нового значения оператору выделения элемента списка (т.е. VariableName[1] := "New Value” – приведет к состоянию ошибки ). В правой части оператора присваивания оператор выделения элемента списка допустим. my_list := "Moscow" : "London" : "New York" : "Tokyo"; my_list := my_list[3] : "Volgograd" : my_list[1]; @Prompt([Ok]; "Информация"; @Implode(my_list; "-")) – выдаст New York-Volgograd-Moscow
В документации сказано, что оператор выделения элемента списка, который следует за оператором объединения списков, должен быть заключен в круглые скобки. Но все работает и без этого, и не совсем понятно зачем это нужно, ведь оператор выделения элемента списка имеет более высокий приоритет, чем оператор объединения списков. Операции (и операторы) со списками возможны двух типов: Попарно (Pair-wise) - первый с первым, второй со вторым и т.д. Если один из списков короче, вместо недостающих элементов используется последний. Все со всеми (Permuted) - каждый с каждым - перебираются все комбинации в следующем порядке: первый элемент первого списка со всеми элементами второго, затем второй элемент первого списка со всеми второго и т.д. Обозначение: перед обычным знаком операции вставляется символ «*». При операциях сравнения списков в обоих случаях для получения положительного результата всей операции достаточно положительного результата в одной паре.
Пример. Сравнение двух списков на равенство и неравенство может привести к одинаковому результату! "A":"B"
= "A":"C"
"A":"B" != "A":"C"
- Истина, т.к. "A" = "A" - тоже Истина, т.к. "B" != "C"
3.4 Порядок выполнения вычислений В выражении все входящие в него значения должны быть одного типа. Порядок вычислений соответствует общепринятому в математике. Сначала вычисляются выражения в скобках (при наличии вложенных скобок в первую очередь выполняются вычисления в самых внутренних скобках), затем выполняются операции с высшим приоритетом. При равенстве приоритетов вычисления выполняются слева направо. Пример. В результате вычисления переменной а присвоится значение 20. a := (12 + (24-3)*2)/3 + 6/3;
Необходимо помнить, что оператор объединения списка имеет один из наиболее высоких приоритететов, поэтому элементы списка, которые являются выражениями, необходимо брать в скобки. Пример. a := 1:2:3:4 + 1:2:-3:4; В результате вычисления переменной а присвоится значение 2:4:0:0. Дело в том, что элементы 3 и 4 сначала были объединены в список, а затем к этому списку применяется операция изменения знака. Соответственно для выражения 1:2:3:4 + 1:2:(-3):4 значение будет 2:4:0:8.
3.5 Ключевые слова DEFAULT имя_поля := значение Область применения: без ограничений. На время выполнения формулы присваивает полю с именем имя_поля соответствующее значение по умолчанию. Данная конструкция устанавливает, что если в документе не задано поле с именем имя_поля, то до конца формулы или до присвоения этому полю другого значения будет считаться, что оно содержит соответствующее значение. Если же поле с именем имя_поля в документе присутствует, то конструкция не оказывает никакого воздействия.
ENVIRONMENT переменная_окружения := "значение" Область применения: нельзя использовать в формулах отбора, колонок, видимости объекта и навигатора. Ограниченно применима в формулах всплывающих окон. В Web-приложениях выдает пользовательские Web-переменные окружения. Присваивает значение текстовой строки переменной_окружения (среды). Данные переменные сохраняются либо в файле NOTES.INI (для операционных систем Windows, OS/2 и UNIX), или в Notes Preferences файле (для Macintosh). Действие ключевого слова аналогично выполнению встроенной @-функции @SetEnvironment. Для возврата значений таких переменных используется функция @Environment: FIELD FieldName := @Environment( "EnvVariable" )
В Web-приложениях, используя предопределенные имена полей, с помощью функций работы с переменными окружения можно получить пользовательские Web-переменные окружения. В данном случае используется механизм CGI (Common Gateway Interface).
ϑ FIELD имя_поля := значение Область применения: нельзя использовать в формулах отбора, колонок, видимости объекта, заголовка окна, формы и навигатора. Присваивает значение полю с именем имя_поля. Данное поле сохраняется в документе (в отличие от временных переменных). Может быть использовано как для создания новых, так и для изменения существующих полей. При создании новых полей разработчик должен сам следить за тем, чтобы имя_поля было уникально в пределах текущего документа. В R 6 язык снято ограничение, запрещающее использование ключевого слова FIELD в качестве параметров других функций (например, @Do или @If). Соответственно допускается и вложенное использование FIELD. Для предыдущих версий (включая R5) это ограничение действительно. Пример. В R 6 полю a1 и временной переменной c присвоится значение “123”, а полю a2 - “12345”. Field a2 := @Do( c:= Field a1 := "123"; c + "45");
В документации на данное ключевое слово приведено два замечания. Первое - рекомендует внутри других функций использовать вместо ключевого слова FIELD функцию @SetField. Во втором говорится, что в определенных случаях формула должна возвращать некое значения (например, формула
кнопки). Поэтому для предупреждения возникновения ошибки типа "No Main or Selection expression in formula" (нет главного выражения или оператора отбора в формуле) рекомендуется добавить после оператора с ключевым словом FIELD новый оператор возвращающий значение (например, "" или Select @All). Строгое следование данным замечаниям действительно на 100% избавит от описываемых ошибок. Однако с другой стороны, в R 6 снято ограничение, запрещающее использование ключевого слова FIELD в качестве параметров других функций, и кроме этого ключевое слово FIELD теперь возвращает значение. Помимо этого при сохранении формул, требующих возвращаемого значения (например, формула кнопки), Domino обычно добавляет в конец формулы функцию @True. Данное правило выполняется не всегда, например, если определить обработчик события onLoad формы на языке @-формул в виде «FIELD a2 := "45";», то в результате как раз и получим сообщение об ошибке "No Main or Selection expression in formula".
REM [ "комментарий" ] ϑ REM [ { комментарий } ] Область применения: без ограничений. Позволяет включить в формулу одну или несколько строк комментариев. В R 6 комментарии стало можно заключать в фигурные скобки. Это достаточно удобно при отладке @-формул, когда надо закомментировать какой-то фрагмент текста, а внутри него уже встречаются двойные кавычки. Символ «\» (обратный слеш) используется внутри комментария как Escсимвол, аналогично текстовым константам. REM "Это строка \"комментария\"!"; REM {и это строка \\комментария};
SELECT формула Область применения: разрешается использовать только в формулах отбора и агентах. Определяет критерий для отбора документов, которые будут обрабатываться. Используется в формулах отбора видов, формулах селективной репликации, формулах агентов. Обрабатываются только те документы, для которых формула, возвращает значение "Истина". Ключевое слово SELECT должно быть самым первым оператором в формуле. Для агентов критерий отбора может так же определяться в его окне свойств (например, All unread documents in view – все непрочитанные документы в виде), а также в объекте Document Selection из объектнособытийной панели агента. Тем не менее, даже в этом случае в теле агента можно использовать ключевое слово SELECT. Критерий отбора документов для
агента будет тогда определяться путем объединения перечисленных условий. При селективной репликации наблюдается похожая картина с использованием ключевого слова SELECT.
Пример 1. Выбор всех документов: SELECT @All
Пример 2. Отбор документов в вид или при репликациях. Выбираются все документы, созданные по форме "Описание фирмы" и все их "потомки" ответные документы всех уровней иерархии. SELECT Form = "Описание фирмы" | @AllDescendants;
При использовании в формуле операции сравнения со значением поля, которого в документе нет, такая формула всегда возвращает значение 0 (FALSE). Для решения проблемы можно воспользоваться функциями @IsAvailable или @IsUnavailable. Ключевое слово всегда должно быть стоять первым в операторе. При запоминании формулы ключевые слова всегда преобразуются к верхнему регистру. В операторах с ключевыми словами DEFAULT, ENVIRONMENT и FIELD значения имя_поля и переменная_окружения не должны быть текстовыми константами.
3.6 Функции @-функции - это способ обращения из формул к встроенному в Domino набору процедур, выполняющих специализированные вычисления или производящих определенные действия в интерфейсе Notes. Формат вызова функций: @FunctionName( Arg1; Arg2; ...; ArgN );
Список аргументов заключается в скобки. Если аргументы не требуются, скобки опускаются. Друг от друга аргументы отделяются точкой с запятой. В большинстве случаев они должны иметь определенный тип данных. Некоторым функциям, например, @Command, @PostedCommand, @DocMark, @GetPortsList, @PickList, @MailSend, @Name, @Prompt требуются аргументы - ключевые слова. Они заключаются в квадратные скобки. Примеры. @Prompt( [OK]; Title; Subject ); @Name( [CN]; AUTHOR ); @Command( [EditClear] );
Большинство @-функций в результате выполнения возвращают значение определенного типа. Иногда тип результата зависит от типов аргументов и еще каких-либо условий. Пример. @Prompt( [OkCancelList]; Title; Subject; Default; List ) по кнопке OK возвращает выбранную строку текстового списка. Если ничего не выбрано, то возвращает истину (число 1), если нажата кнопка OK, или ложь (число 0), если нажат Cancel.
@-Команды - специальные функции, вызывающие немедленный отклик в интерфейсе пользователя. С помощью @-команд можно выполнить практически все стандартные команды меню. Кроме того, имеется ряд специализированных команд. Область применения @-команд - "Run once"агенты, кнопки, акции, гиперобъекты и кнопки панели инструментов. Заметьте, что некоторые из команд действуют не во всех указанных контекстах. Нельзя использовать @-команды в контексте, где отсутствует диалог с пользователем (например, агенты по расписанию, фоновые агенты, формулы полей и т.д.). В Domino 4-й версии и выше есть две @-функции для выполнения команд: @Command( [ИмяКоманды]; параметр1; ...; параметрN ) @PostedCommand( [ИмяКоманды]; параметр1; ...; параметрN )
Их первый аргумент - ключевое слово, определяющее имя команды. От него зависит состав остальных параметров. Различие между @Command и @PostedCommand заключается в порядке их выполнения в формуле (более подробно рассмотрено в пункте "4.4"). Пример. Формула кнопки панели инструментов открывает БД на любом доступном сервере по ее ID реплики. Если база открыта успешно, формула выполняется дальше - создается новый документ и т.д. REM "Если базу открыть не удалось, - Return"; @If( @Command( [FileOpenDBRepID]; "C3256310:002881A3" ); ""; @Return( "" )); @Command( [Compose]; ""; "Main Topic" ); @Command( [EditGotoField]; "Subject" ); @Command( [EditInsertText]; "New subject" ); @Command( [EditGotoField]; "Body" )
Примечание 1: когда имя БД (или другое имя файла) включается в команду в качестве параметра, пути доступа к файлам должны быть указаны в соответствии с требованиями операционной системы рабочей станции или сервера, на котором хранится БД. Если БД хранится на компьютере, работающем в Windows или OS/2, используйте формат записи: "Сервер" : "Каталог\\Database.NSF", где Database.NSF - имя файла БД.
Примечание 2: при включении в формулу в качестве параметра имени вида или формы, не указывайте символ подчеркивание в имени, даже если он в параметре явно присутствует. Для вида "_Туры\_По дате" при использовании его в формуле применяется следующий синтаксис: "Туры\\По дате"
3.6.1 Побочные эффекты Некоторые функции при выполнении вызывают «побочные эффекты». Основное предназначение @-функции произвести некоторые вычисления и возвратить определенное значение. Если функция помимо этого выполняет еще какие-либо действия, например, выводит диалоговое окно, то говорят что это функция с "побочным эффектом". Ниже приводится таблица с такими функциями. @-функция
Побочный эффект
@Command, @PostedCommand
Чаще всего выполняется команда меню Domino
@DbColumn, @DbCommand,
Доступ в текущую или другую базу для поиска и получения данных
@DbLookup @DDEInitiate, @DDEExecute,
DDE - диалог с другим приложением.
@DDEPoke, @DDETerminate @MailSend
Текущий документ отправляется почтой Domino или создается и отправляется почтовое сообщение.
@Prompt, @PickList @DialogBox
Открывается диалоговое окно, результат функцией только по окончании диалога.
возвращается
Если установлена переменная окружения NoExternalApps = 1, то не будет работать ни одна формула, содержащая функции из этого списка. Пользователь не увидит сообщения об ошибке, формула просто не будет выполняться.
Доступ на модификацию к другим базам данных (Ability to modify other database)
Доступ на чтение к другим базам данных (Ability to read other database databases)
Доступ к ECL рабочей станции (Access to Workstation Security ECL)
Возможность отправки почты (Ability to send mail)
Доступ к внешним программам (Access to external programs)
Доступ к базам данных сторонних фирм (Access to non-Notes databases)
Доступ к переменным окружения (Access to environment variables)
Функция
Доступ к текущей базе данных (Access to current database)
Список управления выполнением (ECL) влияет на работу ряда @функций. Ниже приводится таблица, где по горизонтали перечисляются эти функции, а по вертикали указаны флаги доступа ECL. Если на пересечение соответствующей строки и столбца стоит символ "+", это говорит о том, что данная функция при отсутствии соответствующего флага выполняться не будет.
@DbColumn (ODBC)
+
@DbCommand
+
@DbLookup
+
@DbLookup (ODBC)
+
@DDEExecute
+
@DDEInitiate
+
@DDEPoke
+
@DDETerminate
+
@DeleteDocument
+
@DeleteField
+
@EditECL
+
@EditUserECL
+
ENVIRONMENT
+
@Environment
+
@GetProfileField
+
@MailSend
+
@RefreshECL @SetDocField
+ +
+
@SetEnvironment @SetProfileField
+
@Unavailable
+
@UpdateFormula Context
+
@URLGetHeader
+
@URLOpen
+
+
+
Аналогичные ограничения существуют и для @-команд:
3.6.3 Ограничения применимости @-функций и команд для Web-приложений В Web-приложениях следующие @-функции не работают, или результат их применения отличается от обычного при использовании в клиенте Notes.
В документации сказано, что @Unique не поддерживается в Web-приложениях. Однако из опыта функция работает как в случае генерации случайных текстовых строк, так и при удалении из списка повторяющихся значений (правда, возможно не во всех контекстах)
@UserPrivileges @UpdateFormulaCont ext @Platform
Возвращает только платформу для сервера. Для того, чтобы различать пользователей Notes и Web используйте функцию @ClientType.
Аналогичные ограничения существуют и для @-команд. Большинство из них нельзя применять в Web-приложениях, т.к. @-команды ориентированы на интерфейс рабочей станции Lotus Notes. Исключение составляют команды:
Некоторые из перечисленных выше команд (например, [ViewExpand] или [Folder]) могут использоваться при программировании под Web только в контексте апплетов видов.
4 Как выполняются формулы 4.1 Порядок выполнения Domino выполняет действия в формулах слева направо, сверху вниз, завершая каждый оператор, перед тем как перейти к следующему, за исключением любого использования функции @PostedCommand и функции @Command с определенными значениями аргументов. Эти функции всегда выполняются после выполнения всех остальных операторов (более подробно рассмотрено в пункте "4.4"). (1)
Statement1;
(2)
Statement2;
(3)
Statement3;
(4)
Statement4;
(5)
Statement5;
Вы можете прервать процесс выполнения, используя функцию @Return. В R 6 язык формул стал поддерживать операторы циклов (@For, @While, @DoWhile и @Transform), которые позволяют выполнить несколько раз определенную последовательность операторов. Так же можно "пропустить" во время выполнения какие-либо операторы с помощью функции @If. Пишите формулы в том порядке, в котором они должны выполняться. Если оператор должен работать только при выполнении некоторого условия, используйте функцию @If для проверки этого условия: @If( Condition_1; TRUE_Statement_1; ...; ...; Condition_N; TRUE_Statement_N; FALSE_Statement );
Чтобы заставить Domino выполнить несколько операторов при заданном условии, вставьте функцию @Do внутрь @If: @If( Condition; @Do( Statement_1; ...; Statement_N ); FALSE_Statement );
4.2 Формулы, возвращающие значения Большинство типов @-формул, если классифицировать их по месту применения (типу объекта, в котором они определяются), в результате выполнения должны возвращать значение. Значение может быть возвращено либо последним оператором формулы, либо функцией @Return, которая возвращает свой аргумент. В любом случае последним оператором в такой формуле должен быть оператор, возвращающий значение. Это может быть переменная, константа, @-функция или выражение, составленное с помощью операторов из перечисленных элементов. Операторы с ключевыми словами (кроме некоторых случаев с SELECT и FIELD) не возвращают значений, поэтому не могут стоять последними в таких формулах. Следующие типы формул должны возвращать результат:
• • • •
Replication formula (формула селективной репликации). Результат - истина или ложь в критерии SELECT для каждого документа базы; Form formula (формула формы). Результат - имя формы для открытия документа; Selection formula (формула отбора документов в виде). Результат - истина или ложь в критерии SELECT для каждого документа базы; Column formula (формула колонки). Результат должен быть пригоден для преобразования в текст;
•
Hide action formula (формула скрытия акции). Результат - истина или ложь;
•
Formula pop-up (формула "всплывающего" окна). Результат - текст;
• • • • 30
Window title formula (формула заголовка окна). Результат должен быть пригоден для преобразования в текст или число, за исключением случая, когда формула состоит из одного поля, любого типа; Section access formula (формула доступа к секции). Результат - имя или список имен; Insert subform formula (формула вычисляемой субформы). Результат - имя субформы (текст); Section title formula (формула заголовка секции). Результат - текст или число, за исключением формул, состоящих из одного поля любого типа;
Hidden paragraph formula (формула видимости объекта). Результат истина или ложь; Default value formula (значение поля по умолчанию). Результат должен быть пригоден для сохранения в данном поле; Input translation formula (формула преобразования значения поля). Результат должен быть пригоден для сохранения в данном поле; Input validation formula (формула проверки значения поля). Результат истина или ложь; Input enabled formula (формула разрешения ввода значения в поле). Результат - истина или ложь; Computed field formula (формула вычисляемого поля). Результат должен быть пригоден для сохранения в данном поле; Keyword field formula (формула ключевых слов). Результат – значение или список значений, пригодный для сохранения в данном поле; Image resource formula (формула загружаемого изображения). Результат имя изображения из ресурсов дизайна; Computed text formula (формула вычисляемой надписи). Результат - текст.
Приведенный выше список не полностью описывает все типы формул, которые должны возвращать результат. В качестве примера можно привести формулу скрытия столбца в виде или формулу строки аутлайна. К сожалению, в документации отсутствует структурированное описание данных контекстов применения формул.
4.3 Формулы, выполняющие последовательность действий Перечисленные ниже типы формул могут не возвращать значения в результате выполнения, поскольку его обычно некуда возвращать. Такие формулы только выполняют заданную последовательность операторов. Будем называть такие @-формулы @-программами:
•
Agent formula (формулы агентов) - выполняются при запуске соответствующего агента. Формула выполняется для каждого документа,
удовлетворяющего критерию отбора документов агента и внутренним условиям алгоритма агента;
• • •
•
Action formula (формула акций) - выполняются соответствующую кнопку-акцию в виде или форме;
при
Button formula (формула кнопки) допустима навигаторе, форме или RichText-поле документа;
использования
для
нажатии
на
в
Toolbar button formula (формулы кнопки панели инструментов) выполняются однократно, по нажатию на соответствующую кнопку. До версии R6 эти кнопки назывались SmartIcon buttons (кнопки активных пиктограмм); Action hotspot formula (формула навигаторах, формах и RichText-полях.
гиперобъекта)
применяется
в
4.4 Выполнение формул, содержащих вызовы @-команд Функция @PostedCommand используется в 4-й и выше версиях Domino как замена для @Command 3-х с целью обеспечения совместимости, поскольку @Command 4-й и выше версии выполняется иначе. Формула с @Command, написанная в 4-й и выше версии не может быть выполнена в 3-й.
При выполнении указанных в формуле действий Domino всегда выполняет функции @PostedCommand (как @Command в 3-й версии) в последнюю очередь. Если в формуле имеется несколько вызовов функции @PostedCommand, они обрабатываются в порядке появления, но после всех остальных операторов и @-функций. Даже если для изменения порядка действий используется @Do, функции @PostedCommand выполняются в последнюю очередь.
Например, предположим, что приведенная ниже формула содержит ряд выражений, заключенных в скобки внутри функции @Do: FIELD X := @If( условие; @Do( @PostedCommand1; @Prompt; @PostedCommand2 );
При вычислении, если условие истинно, указанные в @Do действия будут выполняться в следующем порядке: (1) @Prompt (2) @PostedCommand1 (3) @PostedCommand2
@Do выполняет все, не относящиеся к @PostedCommand действия в порядке слева направо; а после их завершения выполняет все @PostedCommand в том же порядке. Предположим, вы пишете формулу, которая должна выполнять @PostedCommand, проверку @If, а затем несколько других действий, за которыми следует еще одна @PostedCommand. Domino выполнит действия в такой последовательности: проверка условия и соответствующее действие, затем прочие "обычные" действия, затем обе @PostedCommand. Программа (4) @PostedCommand( [имя_команды]; параметр ); (1) @If( Условие; True_действие; False_действие ); (2) FIELD X := "Текст"; (3) FIELD Y := "Следующий текст"; (5) @PostedCommand( [имя_команды] )
Чтобы "заставить" Domino выполнить первую @PostedCommand перед проверкой @If и следующими за ней действиями, можно создать формулуподпрограмму (ее нужно определить в "Run once" - агенте) и запускать ее с помощью дополнительной @PostedCommand: Программа (в акции, гиперобъекте, Run once - агенте)
Вызовы функций @Command происходят при выполнении формулы в том порядке, в котором встречаются (вместе с другими операторами и @функциями). Однако имеются исключения из этого правила. Перечисленные ниже в таблице типы @Command выполняются аналогично @PostedCommand, то есть после всех остальных действий. В R 6 добавлен целый ряд однотипных команд, которые выполняют те же действия, но немедленно, а не после других команд:
Команда, выполняющаяся после всеx остальных @-команд
5 Обработка ошибок в формулах Синтаксические ошибки "отлавливаются" Domino при нажатии кнопки , требующей принять изменения в формуле, либо при закрытии окна редактирования формулы. Сообщение об ошибке выводится либо в диалоговом окне (Рис. 5.1), либо в нижнем колонтитуле окна с формулой (Рис. 5.2). Затем в формуле выделяется фрагмент, вызвавший ошибку. Вот некоторые примеры:
•
No main or selection expression in formula (в формуле нет "главного" выражения) - случается, если последний оператор в формуле, которая по своему назначению должна возвращать значение (подробности в разделе "4.2"), не может этого делать (например, оператор с ключевым словом). Самое простое "формальное" решение такой проблемы - добавить в формулу в качестве последнего оператора константу "" (пустую строку).
Пример. В формуле поля Field1 (см. ниже), значение которого не важно, должно быть изменено значение поля Field2. В результате выполнения формулы поле Field2 получит значение NewValue, а поле Field1 - "". FIELD Field2 := NewValue; "";
• • •
An operator or semicolon was expected but non was encountered - здесь должен быть оператор (арифметический, логический и т. п.) или точка с запятой. @If must have an odd number of arguments - функция @If должна иметь нечетное число аргументов. Unknown [KeyWord] for @Function... - неизвестное ключевое слово в качестве аргумента функции.
Рис. 5.1 Сообщение о синтаксической ошибке: конец формулы достигнут ранее конца текстовой константы или константы типа дата/время
Рис. 5.2 Сообщение о синтаксической ошибке: неизвестное ключевое слово для @-функции: '[WindowCascade);@Prompt([OK]'
Ошибки во время выполнения формулы
(Run-time)
могут быть поделены на три группы:
•
•
•
Неожиданные ошибки проектирования, которые не должны встречаться пользователю. Например, если вызов функции содержит недостаточное число параметров, во время выполнения будет выведено сообщение: "Insufficient arguments for @function". Ошибки проектирования, которые не отслеживает Domino, также не должны влиять на работу пользователя. Например, если вы пытаетесь показать с помощью @Prompt значение числового типа, @Prompt работает, но показывает пустое значение. Ожидаемые ошибки, которые могут быть вызваны пользователем или какими-либо "внешними" условиями, например, пользователь ввел в диалоговом окне имя несуществующей базы. Такие ошибки нельзя предотвратить совсем, но их можно предвидеть и включить в формулы соответствующие проверки.
Для отладки Run-time ошибок в Domino не предусмотрен соответствующий механизм, аналогичный отладчику LotusScript. Предлагаемые пути решения:
•
36
для организации точек останова и вывода результирующих значений использовать функцию @Prompt, которую после успешной отладки удалить из тела формулы. Следует помнить, что @Prompt применим не везде (например, в формуле отбора документов). В этом случае предлагается записать отлаживаемую формулу в элемент дизайна, в котором функция @Prompt работает (например, кнопку-акцию или кнопку панели инструментов). После отладки - перенеси формулу в нужный вам объект дизайна;
в качестве альтернативы функции @Prompt, можно создать в форме поля, куда будут записываться промежуточные результаты выполнения формулы. После отладки удалить эти поля.
Следующие выполнения:
• • • • • •
функции
помогают
обрабатывать
ошибки
периода
@IsError( value ) - возвращает 1 (True), если значение value, которое содержится в поле или переменной, или получается в результате вычисления выражения, содержит ошибку; @IfError( выражение1, выражение2 ) – возвращает значение выражения1, если выражение1 не содержит ошибки, и значение выражения2 или пустую строку, если в при вычислении выражения1 произошла ошибка; @Error - генерирует ошибку, например, чтобы сделать "ошибочным" значение поля; @Failure( message ) - показывает сообщение в окне при проверке значения поля (используется только в формулах проверки редактируемых полей); @Success - всегда возвращает значение 1 (True) (используется только в формулах проверки редактируемых полей); @Return( value ) - прерывает выполнение формулы и возвращает значение value, например, в случае положительного результата проверки на какуюлибо ошибку.
Domino генерирует состояние ошибки в случае, когда пользователь вводит в поле значение, не соответствующего предусмотренного разработчиком типа данных. Например, в числовое поле вводится нечисловое значение. Ситуация ошибки генерируется при попытке сохранения такого документа. При этом выдается сообщение "Cannot convert text to a number" (не могу преобразовать текст в число). Разработчик может изменить текст сообщения с помощью функции @Failure, использую ее в формуле проверки значения поля. Для формул, отличных от формул полей (например, формул агентов или кнопок), для проверки содержимого полей не требуется возникновения ситуации сохранения документа. В этом случае соответствующие проверки и возможная генерация ошибки происходит немедленно, по факту запуска данной формулы.
6 Описание @-функций Domino Мы подробно рассмотрим около 200 наиболее часто используемых при разработке приложений @-функций Domino. Всего же @-функций Domino более 250. Полный список всех @-функций, с кратким их описанием дан в приложении 8. В описание @-функций указывается на их область применения или контекст. Это достаточно важный момент, т.к. не все функции работают в определенных элементах дизайна. В документации имеются специальные документы, которые содержат сводные таблицы области применения для @-функций. Следует, однако, заметить, что в этих таблицах присутствуют не все функции из вновь появившихся. В этом случае, если к тому же в описании конкретной функции не указано никаких ограничений, то в области применения в настоящей книге будет указано: «В DOMINO R 6.0.1 НЕ ДОКУМЕНТИРОВАНА», и далее возможно дополнительная информация о контексте, почерпнутая из других источников или личного опыта автора.
6.1 Функции - базовые конструкции языка формул @If( условие_1; действие_1; условие_2; действие_2; .. . ; условие_99; действие_99; действие_иначе ) Область применения: без ограничений. Проверяет условия. Если условие истинно (TRUE), выполняется действие, указанное сразу же после условия. Если же условие ложно (FALSE), выполняется переход к проверке следующего условия и т.д. Как только находится истинное условие, выполняется связанное с ним действие и игнорируется оставшаяся часть выражения. Если ни одно из условий не истинно, выполняется действие_иначе. Возвращается значение выполненного действия. Можно указать до 99 условий и соответствующих им действий, и только одно действие, которое выполняется, если не верно ни одно из указанных условий. В своей простейшей форме функция имеет вид: @If( условие; действие; действие_иначе ). Допускается и форма @If( условие ), в этом случае никакие действия не выполняются.
Пример 1. Проверяется значение в поле CostOfGoods. Если значение больше или равно 12.45 - условие истинно, и возвращается строка "Сверх бюджета". Если значение меньше 12.45 - условие ложно и возвращается строка "Соответствует". @If( CostOfGoods >=12.45; "Сверх бюджета"; "Соответствует" )
Пример 2. Если CostOfGoods меньше 12.45 - возвращается пустая строка. @If( CostOfGoods >= 12.45; "Сверх бюджета"; "" )
Пример 3. Если значение в поле CostOfGoods больше 12.45 возвращается строка "Сверх бюджета"; если нет, проверяется следующее условие. Второе условие снова проверяет значение в поле CostOfGoods, и если значение меньше 12.45 - возвращается строка "Соответствует". Если же значение равно 12.45 - возвращается строка "На пределе допустимого". @If( CostOfGoods > 12.45; "Сверх бюджета"; CostOfGoods < 12.45; "Соответствует"; "На пределе допустимого" )
Пример 4. Сначала проверяется, действительно ли документ новый (еще не сохранялся в базе). Если условие истинно, возвращается значение поля NewNoteTitle. Если первое условие ложно, проверяется, является ли текущим вид "Авторы". Если да, возвращается значение поля ByAuthorTitle. Если оба условия ложны, возвращается значение поля StandardTitle. @If( @IsNewDoc; NewNoteTitle; @ViewTitle = "Авторы"; ByAuthorTitle; StandardTitle )
@Do( выражение_1; выражение_2; ... ; выражение_n ) Область применения: нельзя использовать в формулах отбора и колонок. Используется для последовательного вычисления нескольких выражений. Вычисляет выражения слева направо и возвращает значение последнего выражения.
Если @Do содержит функцию @PostedCommand или вариант функции @Command, выполняющейся последней в формуле, то такие команды будут выполняться после всех остальных выражений, входящих в формулу. Несколько @PostedCommand будут выполняться в порядке их появления в @Do.
Пример. Эта формула открывает диалог, выясняющий, желает ли пользователь редактировать текущий документ. Если пользователь выберет Yes, появится другой диалог, запрашивающий имя пользователя. Если в нем пользователь выберет Cancel, выполнение формулы будет прекращено; если же пользователь введет имя и выберет Ok, документ будет открыт в режиме редактирования. Если же пользователь выберет No в первом диалоге, появится следующий диалог. Будет сообщено, что пользователь решил не редактировать документ, и произойдет переход к следующему документу в виде. @If( @Prompt(
[YesNo];
"Вопрос";
"Редактировать
этот
документ?" ); @If( @Prompt( [OkCancelEdit]; "Положительный ответ"; "Вы выбрали редактирование документа. Если имя указано верно, нажмите OK"; @Username ) != "ERR_CANCEL"; @PostedCommand( [EditDocument] ); @Return( "" ) ); @Do( @Prompt( [Ok]; "Отрицательный ответ"; "Вы отказались редактировать документ. Нажмите OK для перехода к следующему." ); @PostedCommand( [NavigateNext] ) ) )
@Select( число; значение_1; значение_2; ... ; значение_N ) Область применения: без ограничений. Возвращает значение в позиции, заданной параметром число. Если число больше количества значений N, возвращает последнее значение. Если значение в указанной позиции является списком, возвращает весь этот список. Пример 1.Возвращается 3. @Select( 3; 1; 2; 3 )
Пример 4. Возвращается список "Осло" : "Париж" : "Нью-Йорк" : "Амстердам", если поле TrainingCenters содержит список названий этих городов. @Select( 3; SalesOffices; ServiceOffices; TrainingCenters )
@Return( значение ) Область применения: нельзя использовать в формулах колонок. Немедленно прекращает выполнение формулы и возвращает указанное значение. В качестве параметра значение можно указать другую функцию, например, @Error, текстовую строку, например, "Выполнение остановлено", пустую строку ("") или логическое значение (TRUE или FALSE).
@Return наиболее часто используется в формулах полей, агентов, кнопок и кнопок панели инструментов совместно с @If для определения, завершать ли выполнение формулы немедленно (т.е. выполнять @Return) или продолжать выполнение оставшейся части формулы.
Пример 1. Открывает диалог, предлагающий пользователю сделать выбор "да/нет". Если пользователь выберет Yes, будет открыт следующий в виде документ; если пользователь выберет No, выполнение формулы будет остановлено. @If( @Prompt( [YesNo]; "Продолжить?"; "Хотите продолжить чтение почты?" ); @PostedCommand( [NavigateNext] ); @Return( "" ) )
Пример 2. Проверяет наличие переменной среды OrderNumber в файле NOTES.INI пользователя. Если переменная отсутствует, с помощью @SetEnvironment она помещается в файл со значением, равным нулю. Если переменная в файле присутствует, @Return прекращает выполнение формулы и возвращает значение этой переменной. @If( @Environment( OrderNumber ) = ""; @SetEnvironment( "OrderNumber"; "0" ); @Return( @Environment( "OrderNumber" )) )
ϑ @Eval( строка ) Область применения: формально без ограничений, однако применение функции в формулах отбора и колонок может привести к непредсказуемым результатам. В момент выполнения рассматривает строку как @-формулу, компилирует и выполняет ее. Возвращает значение последнего выражения в формуле, представленной строкой, или ситуацию ошибки, если таковая произошла. На момент выполнения в формуле строки, ей доступны все переменные определенные до @Eval. В документации предлагается использовать данную функцию в контексте агентов и кнопок, и не рекомендуется в формулах отбора и колонок (в этих контекстах результат вычислений может быть непредсказуемым). Пример. Присвоит переменной a значение 5, а x - football x := "foot"; c:=3; a := @Eval("x := x + \"ball\";2+c"); @Prompt([OK]; "1"; @Text(a)); REM {выведет 5}; @Prompt([OK]; "2"; x); REM {выведет football}
ϑ @UpdateFormulaContext Область применения: предназначена для использования в интерактивных приложениях, не работает в контекстах, где не допустимо использование @Command. Не работает в Webприложениях. В рамках интерфейса клиента Notes используется для обновления контекста текущей формулы. Например, в рамках формулы мы создаем по форме новый документ, то без использования @UpdateFormulaContext до конца формулы под текущим документом будет подразумеваться тот, из которого была вызвана формула. Если же мы применим @UpdateFormulaContext, то текущим станет новый документ. Пример. Формула используется в акции формы базы Test1.nsf, расположенной на локальной станции. Первый @Prompt вернет значение "~test.nsf", второй тоже самое значение – "~test.nsf", а третий "CN=dominornext/O=Inttrust~Test\test.nsf" @Prompt([Ok]; "1"; @Implode(@DbName; "~")); @Command([Compose]; "dominornext/Inttrust" : "Test\\Test.nsf"; "Form"); @Prompt([Ok]; "2"; @Implode(@DbName; "~")); @UpdateFormulaContext; @Prompt([Ok]; "3"; @Implode(@DbName; "~"));
6.2 Функции выполнения циклов В R 6 появились четыре @-функции, которые реализуют соответственно организацию циклов по счетчику, циклов с пред и постусловием и цикл по элементам списка.
ϑ @For( инициализация_цикла; условие_цикла; изменение_счетчика; оператор1 [; …; операторN] ) Область применения: нельзя использовать в формулах отбора, колонок, видимости объекта, редактируемой секции, заголовка окна, всплывающих окон и области размещения. Осуществляет выполнение цикла по счетчику. Выражение инициализация_цикла определяет начальное значение счетчика цикла, условие_цикла – выражение, значение которого должно быть 1 (TRUE) – для продолжения вычислений, и 0 (FALSE) – для выхода из цикла,
изменение_счетчика – выражение, в котором изменяется счетчик цикла, оператор1, …, операторN – операторы тела цикла. Общее число операторов цикла не должно превышать 252. Возвращаемое суммарное значение оператора @For есть 1 (TRUE), если ошибок при выполнении не произошло, и ситуация ошибки «unexpected data type» («неожидаемый тип данных»), если условие_цикла на каком-либо шаге вернет нечисловое значение. Пример 1. Вычисление суммы чисел от 1 до 100. summa := 0; rez := @For(i := 1; i <= 100; i := i + 1; summa := summa + i); @Prompt([OK]; "Инфо"; "Сумма чисел от 1 до 100 = " + @Text( summa )); REM {выдаст Сумма чисел от 1 до 100 = 5050}; @Prompt([OK]; "Инфо"; @Text( rez )); REM {выдаст 1}
Из опыта: в теле цикла можно самостоятельно менять переменную цикла; по выходу из цикла значение счетчика сохраняется; если изначально условие цикла не выполняется, то операторы цикла не выполняются. В случае написания бесконечного цикла, система автоматически выполнит выход из «зацикливания», либо по таймауту, либо по переполнению памяти. В документации сказано, что циклы не предназначены для работы в формулах колонках видов и отбора документов. Однако, опять же из опыта (по крайней мере в R 6.0.1), в этих контекстах они работают. Перед использованием циклов в формулах отбора и колонок (особенно в серверных БД) следует очень хорошо подумать, дабы не «повесить» сервер. Пример 2. Приведенная ниже формула используется в колонке вида. В документах вида присутствует поле my_num, которое может принимать множественные значения типа число. В формуле колонки вида считается среднеарифметическое значение поля my_num для каждого документа. Следует заметить, что формула работает и при задании для этого столбца сортировок и категоризаций. summa := 0; @For(i:=1; i <= @Elements(my_num); i := i + 1; summa := summa + my_num[i]); summa/@Elements(my_num)
Пример 3. Несколько видоизмененный пример 2. Формула используется в формуле отбора, и отбирает только те документы, у которых среднеарифметическое значение поля my_num больше 10. summa := 0; @For(i:=1; i <= @Elements(my_num); i := i + 1; summa := summa + my_num[i]); select summa/@Elements(my_num) > 10
ϑ @While( условие_цикла; оператор1 [; …; операторN] ) Область применения: нельзя использовать в формулах отбора, колонок, видимости объекта, редактируемой секции, заголовка окна, всплывающих окон, формы и области размещения. Осуществляет выполнение цикла с предусловием. Выражение условие_цикла должно принимать значение 1 (TRUE) – для продолжения вычислений, и 0 (FALSE) – для выхода из цикла, оператор1, …, операторN – операторы тела цикла. Общее число операторов цикла не должно превышать 254. Возвращаемое суммарное значение оператора @While есть 1 (TRUE), если ошибок при выполнении не произошло, и ситуация ошибки «unexpected data type» («неожидаемый тип данных»), если условие_цикла на каком-либо шаге вернет нечисловое значение. Если условие цикла неверно изначально – цикл не выполнится ни разу. Пример. Вычисление суммы чисел от 1 до 100. summa := 0; i := 0; rez := @While(i < 100; i := i + 1; summa := summa + i); @Prompt([OK]; "Инфо"; "Сумма чисел от 1 до 100 = " + @Text( summa )); REM {выдаст Сумма чисел от 1 до 100 = 5050}; @Prompt([OK]; "Инфо"; @Text( rez )); REM {выдаст 1}
ϑ @DoWhile( оператор1 ; [ …; операторN;] условие_цикла ) Область применения: нельзя использовать в формулах отбора, колонок, видимости объекта, редактируемой секции, заголовка окна, всплывающих окон и области размещения. Осуществляет выполнение цикла с постусловием. Выражение условие_цикла должно принимать значение 1 (TRUE) – для продолжения вычислений, и 0 (FALSE) – для выхода из цикла, оператор1, …, операторN – операторы тела цикла. Общее число операторов цикла не должно превышать 254. Возвращаемое суммарное значение оператора @DoWhile есть 1 (TRUE), если ошибок при выполнении не произошло, и ситуация ошибки «unexpected data type» («неожидаемый тип данных»), если условие_цикла на каком-либо шаге вернет нечисловое значение. Если условие_цикла неверно изначально – цикл выполнится один раз. Пример. Вычисление суммы чисел от 1 до 100. summa := 0; i := 0; rez := @DoWhile(i := i + 1; summa := summa + i; i < 100); @Prompt([OK]; "Инфо"; "Сумма чисел от 1 до 100 = " + @Text( summa )); REM {выдаст Сумма чисел от 1 до 100 = 5050}; @Prompt([OK]; "Инфо"; @Text( rez )); REM {выдаст 1}
ϑ @Transform( список; ссылка_на_элемент_списка; функция ) Область применения: нельзя использовать в формулах отбора, колонок, видимости объекта, редактируемой секции, заголовка окна, всплывающих окон и области размещения. Осуществляет выполнение цикла по всем элементам списка. Ссылка_на_элемент_списка позволяет в теле функции обратиться к конкретному элементу списка. Функция должна возвращать значение для каждого элемента списка. Суммарное возвращаемое значение @Transform и есть список, получившийся поэлементным применением функции к списку. Тип возвращаемого значения @Transform определяется на первой итерации, по типу возвращаемого значения функции на первом элементе списка. Все последующие значения должны быть такого же типа. Если на какой-то итерации
функция вернет список, то этот список так же добавится в возвращаемое значение. @Transform возвращает состояние ошибки если на какой-то итерации таковая произошла при выполнении функции. Если на какой-то итерации функция вернет в качестве значения @Nothing, то этим самым на данной итерации в результирующий список не добавится значения на этой итерации. Пример. Выровняет все элементы по правому краю, если длина строки больше 5, произойдет усечение до 5-ти символов слева, иначе недостающие слева символы дополнятся символом тире. Переменной b присвоится значение “12345” : ”123--” : ”12---” : ”12345”. a := "
1234567
": " 123" : "
12
" : "
12345
";
b := @Transform( a; "x" ; @If(@Length(@Trim(x)) > 5; @Left(@Trim(x);5); @Trim(x) + @Repeat("-"; 5 - @Length(@Trim(x)))));
ϑ @Nothing Область применения: нельзя использовать в формулах отбора, колонок, видимости объекта, редактируемой секции, заголовка окна, всплывающих окон, формы и области размещения. В контексте функции @Transform возвращает значение, которое не добавляется в результирующий список. Во всех остальных контекстах возвращает пустую строку. Пример 1. Изменим пример, относящийся к функции @Transform, таким образом, чтобы в случае, когда исходный элемент списка имел длину больше 5, то такие значения в выходной список не должны попадать. Переменной b присвоится значение ”123--” : ”12---” : ”12345”. a := "
1234567
" : " 123" : "
12
" : "
12345
";
b := @Transform( a; "x" ; @If(@Length(@Trim(x)) > 5; @Nothing; @Trim(x) + @Repeat("-"; 5 - @Length(@Trim(x)))));
6.3 Функции определения и преобразования типов данных ϑ @IsNull( значение ) Область применения: нельзя использовать в формулах заголовка окна. Возвращает 1 (TRUE), если параметр является пустой строкой и 0 (FALSE) во всех остальных случаях, включая состояние ошибки (@Error) и список из пустых строк. Пример 1. Возвращает 1. @IsNull( "" );
Пример 2. Возвращает 0, если в поле Dept содержится любое отличное от "" значение. @IsNull( Dept );
Пример 3. Возвращает 0. @IsNull( "" : "" );
Пример 4. Возвращает 0, без сообщения об ошибке. @IsNull( 4/0 );
@IsText( значение ) @IsText( список_значений ) Область применения: без ограничений. Возвращает 1 (TRUE), если параметр является строкой или списком строк, в противном случае возвращает 0 (FALSE).
@IsTime( значение ) @IsTime( список_значений ) Область применения: без ограничений. Возвращает 1 (TRUE), если параметр является величиной или списком величин "дата-время"; в противном случае возвращает 0 (FALSE). Пример 1. Возвращает 1, если поле DueDate содержит величину "датавремя". @IsTime( DueDate )
@IsNumber( значение ) @IsNumber( список_значений ) Область применения: без ограничений. Возвращает 1 (TRUE), если параметр является числом или числовым списком, в противном случае возвращает 0 (FALSE).
@TextToTime( строка ) @TextToTime( список_строк ) Область применения: без ограничений. Преобразует, если возможно, текстовую строку в величину "дата-время". Только "Today", "Tomorrow" и "Yesterday" ("Сегодня", "Завтра" и "Вчера") являются допустимыми строками для указания относительных дат. При невозможности преобразования строки функция возвращает пустое значение. Если аргумент не является строкой или списком строк (дата/время или число), то возвращается состояние ошибки, которую можно обработать с помощью функции @IsError. Если аргумент есть список строк, возвращает список, получившийся поэлементным применением функции. Эту функцию удобно использовать для преобразования даты из текстового поля в величину, для вычислений в поле "дата-время". Пример 1. Возвращает [8.10.90 2:40:00]. @TextToTime( "8.10.90 2:40" )
Пример 2. Возвращает текущую дату, например [04.05.95]. @TextToTime( "Today" )
Пример 3. Возвращает значение «[12.12.2003] : [] : [01.01.1901]». @TextToTime( "12.12.2003" : "ccc" : "01.01.1901" )
Пример 4. Переменной b присвоится значение 1. a :=
ϑ @ToTime( значение ) ϑ @ToTime( список_значений ) Область применения: нельзя использовать в формулах заголовка окна. Преобразует, если возможно, значение или список_значений в величину "дата-время" или список величин "дата-время" соответственно. В отличие от @TextToTime в качестве аргумента может воспринимать значения или списки значений типа дата/время. В этом случае возвращается сам аргумент. Еще одно отличие (и значительно более существенное) этой функции от @TextToTime состоит в том, что ошибки преобразования значений с помощью @ToTime могут быть обработаны функцией @IfError, в то время как ошибки, возвращаемые @TextToTime, функцией @IfError не обрабатываются. Если специально не обрабатывать ошибки преобразования, то функция возвращает окно с сообщением об ошибке либо «The value cannot be convert to a Time/Date» (значение не может быть преобразовано к типу дата/время), либо «Unable to interpret Time or Date» (невозможно интерпретировать значение даты или времени). Это состояние ошибки можно обработать с помощью функции @IsError или @IfError. Пример 1. Возвращает [12.02.2003 12:20:00]. @ToTime( "12.02.2003 12:20" )
Пример 2 Возвращает [29.10.2003] если формула выполнялась 29 октября 2003 года. @ToTime( "Today" );
Пример 3. Возвращает значение [16.04.1987]. @ToTime( [16.04.1987] )
Пример 4. Присвоит полю а1 значение [01.01.1000], а полю a2 – «[01.01.1900] : [] : [31.12.1999]». a := @ToTime( "01.01.1900" : "Date" : "31.12.1999" ); b := @TextToTime( "01.01.1900" : "Date" : "31.12.1999" ); @SetField("a1"; @If( @IsError( a ); [01.01.1000]; a)); @SetField("a2"; @If( @IsError( b ); [01.01.1000]; b));
Пример 5. Переменной b будет присвоено значение «[11.01.2222] : [26.04.1964] : [14.01.3333]», а переменной c – «[11.01.2222] : [] : [14.01.3333]». a := "11.01.2222" : "ccc" : "14.01.3333"; b := @Transform( a; "x"; @IfError(@ToTime( x ); [26.04.1964])); c := [26.04.1964]))
@Transform(
a;
"x";
@IfError(@TextToTime(
x
);
@TextToNumber( строка ) @TextToNumber( список_строк ) Область применения: без ограничений. Преобразует, если возможно, текстовую строку в число. Эту функцию удобно использовать для преобразования числа в текстовом поле в число, для вычислений в числовом поле. При использовании в качестве аргумента списка строк, возвращает список, получившийся поэлементным применением функции. Если строка, или элемент списка строк, начинается с цифры, то такой аргумент будет преобразован в число, даже если он содержит символы букв (они будут отброшены). Если аргумент начинается с буквы, то будет возвращено @Error. Пример 1. Возвращает 123 как число. @TextToNumber( "123" )
Пример 2. Возвращает @ERROR, если содержимого поля Cost нельзя преобразовать в число. @TextToNumber( Cost )
Пример 3. Возвращает список 345 : @ERROR : -26.7 . @TextToNumber( "+345ABC" : "QWE123" : "-26.7" )
ϑ @ToNumber( значение ) ϑ @ToNumber( список_значений ) Область применения: нельзя использовать в формулах заголовка окна. Преобразует, если возможно, значение или список_значений в число или числовой список соответственно. В отличие от @TextToNumber в качестве аргумента может воспринимать числа и числовые списки. В этом случае возвращается сам аргумент. Еще одно отличие (и значительно более существенное) этой функции от @TextToNumber состоит в том, что ошибки преобразования значений с помощью
@ToNumber могут быть обработаны функцией @IfError, в то время как ошибки, возвращаемые @TextToNumber, функцией @IfError не обрабатываются. Если специально не обрабатывать ошибки преобразования, то функция возвращает окно с сообщением об ошибке либо «The value cannot be converted to a Number» (значение не может быть преобразовано к числу», либо «Cannot convert text to a number» (невозможно преобразовать текст к числу). Это состояние ошибки можно обработать с помощью функции @IsError или @IfError. Пример 1. Возвращает окно с сообщением об ошибке: «Cannot convert text to a number». @ToNumber( "2" : "45" : "e34" )
Пример 2. Возвращает список «12 : (-3) : 4». @ToNumber( "12" : "-3" : "4" )
Пример 4. Переменной b будет присвоено значение «2 : 45 : 0», а переменной c – «2 : 45 : @ERROR». a := "2" : "45" : "e34"; b := @Transform( a; "x"; @IfError(@ToNumber( x ); 0)); c := @Transform( a; "x"; @IfError(@TextToNumber( x ); 0));
ϑ @Text( значение ) @Text( список_значений ) @Text( значение; формат ) @Text( список_значений; формат ) Область применения: без ограничений. При использовании в качестве первого аргумента полей типа Rich Text не работает в формулах колонок. Преобразует любое значение в текстовую строку или список текстовых строк. В R 6 в качестве значения может выступать поля типа Rich Text. При этом после применения функции в результате получим текстовое значение поля без вложенных файлов и элементов форматирования, за исключением символов табуляции и пробелов. Однако в этом случае @Text нельзя применять в формулах колонок. Так же не следует забывать перед применением @Text нужно предварительно сохранить документ, иначе функция вернет значение Rich Text-поля действительного на момент последнего сохранения. Из личного опыта, при преобразовании Rich Text к plain text с помощью функции @Text в начале строки возвращаемого значения присутствует лишние символы LF + CR.
В варианте с двумя параметрами преобразованное значение имеет формат, заданный строкой формат. Строка формат должна заключаться в кавычки. Интерпретация строки формат зависит от типа преобразуемых данных. Если первый параметр уже является текстом, строка формат игнорируется. При использовании в качестве первого аргумента списка строк, возвращает список, получившийся поэлементным применением функции. Строка формат для значений дата-время. Имеются четыре отдельные категории составляющих времени и даты для строки формат: Dx, Tx, Zx, Sx. Можно включать до четырех составляющих, но только по одной из каждой категории. Когда неизвестен ожидаемый формат первого параметра (присутствуют ли в нем только даты, или только времени, или обе компоненты), то рекомендуется использовать формат типа Sx (вместо Dx или Tx).
Символ
Значение
D0
Год, месяц и день
D1
Месяц и день, год, если это не текущий год
D2
Месяц и день
D3
Год и месяц
T0
Час, минута и секунда
T1
Час и минута
Z0
Всегда переводить время в этот временной пояс
Z1
Показывать пояс только вне текущего пояса
Z2
Показывать пояс всегда
S0
Только дата
S1
Только время
S2
Дата и время
S3
Дата, время или время "Сегодня", время "Завтра"
Пример 1. Формула могла бы вернуть "11.04.95 10:43". @Text( @Now )
Пример 2. Возвращает "28.2":"27.2", если сегодня - 28 февраля. @Text( @Now : @Yesterday; "d1s0" )
Пример 3. Возвращает "10:50:30 ZE3", если время - 10:50:30 в поясе GMT + 3. @Text( @Now; "d1s1z2" )
Пример 4. Возвращает "04.93 10:43". @Text( @Now; "d3t1" )
Строка формат для числовых значений. Для числовых значений строка формат составляется с помощью комбинаций следующих категорий, разделенных запятыми.
Символ
Значение
G
Общий формат (только значащие цифры)
F
Фиксированный формат (стандартное количество знаков после точки)
S
Научный формат (E-запись)
C
Формат валюты (два знака после точки)
,
С разделителями тысяч (формат США)
%
Процент
()
Отрицательные числа в скобках
Число
С точностью до знака число
Пример 5. Возвращает "123.45". @Text( 123.45 )
Пример 6. Возвращает "1 800 345.23 р.", если значение в поле Sales равно 1800345.23 . @Text( Sales; "C,2" )
Пример 7. Возвращает "8.00e+02". @Text( 800; "S" )
ϑ @TimeToTextInZone( дата_время; часовой_пояс [; формат] ) Область применения: без ограничений. Преобразует значение дата_время из формата дата/время в текст с учетом часового пояса. Параметр часовой_пояс задается в каноническом формате (см. замечания к функции @GetCurrentTimeZone, стр. 93).
Необязательный текстовый параметр формат определяет присутствующие в возвращаемом значении компоненты даты и времени. В качестве допустимых символов строке можно использовать следующие комбинации:
Символ
Значение
D0
Год, месяц и день
D1
Месяц и день, год, если это не текущий год
D2
Месяц и день
D3
Год и месяц
T0
Час, минута и секунда
T1
Час и минута
S0
Только дата
S1
Только время
S2
Дата и время
S3
Дата, время или время "Сегодня", время "Завтра"
В рамках параметра формат можно использовать до трех комбинации параметров форматирования из групп Dx, Tx и Sx, но только по одной из каждой группы. Когда неизвестен ожидаемый формат параметра дата_время (присутствуют ли в нем только даты, или только времени, или обе компоненты), то рекомендуется использовать формат типа Sx (вместо Dx или Tx). Пример 1. Возвращает значение "26.04.1964 16:24:27", если в поле Tz типа Time zone находится значение, соответствующее «(GMT+07:00) Krasnoyarsk» (канонический формат «Z=-7$DO=1$DL=3 -1 1 10 -1 1$ZX=48$ZN=North Asia»), и формула выполняется на компьютере, находящемся в часовом поясе «(GMT+03:00) Moscow, St. Petersburg, Volgograd». @TimeToTextInZone([26.04.1964 12:24:27]; Tz)
Пример 2. Модифицированный пример 1, с теми же условиями для часовых поясов возвращает "26.04 16:24". @TimeToTextInZone([26.04.1964 12:24:27]; Tz; "D2T1")
ϑ @TimeZoneToText( часовой_пояс [; формат] ) Область применения: без ограничений. Преобразует значение часового_пояса из канонического формата к тексту. Необязательный параметр формат может содержать следующие символы:
Символ
Значение
S
Возвращаемое значение соответствует сокращенному формату часового пояса. Например, "GMT+03:00".
A
Алиас для локального времени. Например, если формула выполняется в том же часовом поясе что и первый параметр, то возвращается значение "Local time".
Если параметр формат опущен, то возвращается полный формат часового пояса. Например, «(GMT+03:00) Moscow, St. Petersburg, Volgograd». Пример 1. Возвращает значение "(GMT+07:00) Krasnoyarsk", если в поле Tz типа Time zone находится значение, соответствующее «(GMT+07:00) Krasnoyarsk» (канонический формат «Z=-7$DO=1$DL=3 -1 1 10 -1 1$ZX=48$ZN=North Asia»). @TimeZoneToText( Tz )
Пример 2. Модифицированный пример 1 возвращает " GMT+07:00". @TimeZoneToText( Tz;"S" )
@Explode( строка ) @Explode( список_строк ) @Explode( строка; строка_разделитель ) @Explode( список_строк; строка_разделитель ) @Explode( строка; строка_разделитель; флаг1 ) @Explode( список_строк; строка_разделитель; флаг1 ) ϑ @Explode( строка; строка_разделитель; флаг1; флаг2 ) ϑ @Explode( список_строк; строка_разделитель; флаг1; флаг2 ) @Explode( диапазон_дат ) @Explode( список_диапазонов_дат ) Область применения: без ограничений. @Explode( строка ) возвращает список, составленный из подстрок текстовой строки. В этом варианте в качестве разделителя подстрок используются пробелы, запятая, точка с запятой. @Explode( строка; строка_разделитель ) действует аналогично предыдущему варианту, но для определения конца подстроки используется один из указанных в строке_разделителе символов. @Explode( строка; строка_разделитель; флаг1 ) действует аналогично предыдущему варианту, и если значение флага1 равно 0 (FALSE), то из результирующего списка исключаются элементы тождественно равные пустой строке. Если флаг1 равен 1 (TRUE), то пустые строки не исключаются. По умолчанию параметр флаг1 установлен в 0 (FALSE). В R 6 добавлен новый флаг2. При установке его в 1 (TRUE), функция @Explode будет воспринимать символ перехода на новую строку как разделитель подстрок, даже если ее нет в строке_разделителе. Если флаг2 равен 0 (FALSE), то функция не будет воспринимать символ перехода на новую строку как разделитель подстрок, при условии, что ее нет в строке_разделителе. По умолчанию параметр флаг2 установлен в 1 (TRUE). @Explode( диапазон_дат ) возвращает список текстовых строк, представляющих значения дат из диапазона_дат. При задании диапазона дат не забывайте о синтаксисе значений типа "дата-время". Значение [26.04.64 30.05.68] соответствует синтаксису, а "26.04.64 - 30.05.68" - нет. Если в качестве первого аргумента использовать список текстовых строк или диапазонов дат, в этом случае возвращаемое значение будет представлять список, полученный поэлементным применением функции.
Пример 1. Возвращает "Отчет" : "за" : "неделю", если в поле Topic содержится "Отчет за неделю". @Explode( Topic )
Пример 2. Возвращает "Защита диссертаций в МВТУ" : " МФТИ" : " МГУ", если в поле Headline содержится "Защита диссертаций в МВТУ, МФТИ, МГУ". @Explode( Headline; "," )
Пример 3. Возвращает "" : "Привет" : "" : "всем", если в поле Country "+Привет++всем". @Explode( Country; "+"; 1 )
Пример 4. Возвращает "Привет" : "всем", если в поле Country "+Привет++всем". @Explode( Country; "+"; 0 )
Пример 6. Возвращает для переменной a число элементов 4, а для b – 5 Country := "+При"+@NewLine+"вет++всем"; a := @Explode( Country; "+";1;0 ) ; @Prompt([OK];"Elements a"; @Text(@Elements(a))); b := @Explode( Country; "+";1;1) ; @Prompt([OK];"Elements b"; @Text(@Elements(b)));
@Implode( список_строк ) @Implode( список_строк; строка_разделитель ) Область применения: без ограничений. Сцепляет все элементы списка_строк в одну строку. При задании с одним параметром элементы списка_строк в возвращаемой строке разделены пробелом, при задании второго параметра, элементы разделены строкой_разделителем. Если функции передается строка, а не список, то возвращается исходная строка. Пример 1. Возвращает "Париж Москва Берлин", если в поле Сity содержится "Париж" : "Москва" : "Берлин". @Implode( City )
Пример 2. Возвращает "Париж+/-Москва+/-Берлин", если в поле Сity содержится "Париж" : "Москва" : "Берлин". @Implode( City; "+/-" )
Пример 3. Возвращает "Европейские столицы/Париж : Европейские столицы/Москва : Европейские столицы/Берлин", если в поле Categories содержится "Европейские столицы", а в поле Сity содержится "Париж" : "Москва" : "Берлин". @Implode( Categories + "/" + City ; " : " )
@Char( код_символа ) Область применения: без ограничений. Код символа должен быть числом и лежать в интервале от 0 до 255. Дробные значения автоматически усекаются до целого. Преобразует код символа в односимвольную строку в соответствии с 850-й кодовой страницей IBM. Символы с кодами меньше 9 не работают в формулах колонок видов. Пример. Возвращает "A". @Char( 65 )
@Ascii( строка ) @Ascii( список_строк ) @Ascii( строка; [AllInRange] ) @Ascii( список_строк; [AllInRange] ) Область применения: без ограничений. Преобразует строку или список строк, представленных в кодировке LMBCS (Lotus Multi-Byte Character Set), соответственно в строку или список строк в кодировке ASCII. В случае задания второго параметра [AllInRange] при условии, что в строке или списке_строк присутствуют символы, коды ASCII которых не попадают в интервал от 32 до 127, возвращаемое значение будет пустая строка. Функция сначала преобразует первый аргумент в строку или список строк ASCII, заменяя символы с кодами меньше 32 и больше 127 на символ "?", и затем в случае задания второго аргумента рассматривает полученное значение, и если в нем встретился символ "?", возвращает пустую строку. Поэтому если в исходной строке присутствовал символ "?" и аргумент [AllInRange] указан, то возвратится значение "". Пример 1. Возвращает "Hello - ??????". @Ascii( "Hello - Привет" )
Пример 2. Возвращает "", если значение в поле Claim равно "one" : "два". @Ascii( Claim; [AllInRange] )
Пример 3. Возвращает "". @Ascii( "What is new ?"; [AllInRange] )
6.4 Функции для работы со строками @Length( строка ) @Length( список_строк ) Область применения: без ограничений. Если параметром является строка, @Length возвращает количество символов в строке. Если параметром является список_строк, @Length возвращает количество символов в каждой строке как числовой список. Пример 1. Возвращает 45. @Length( "The boy crossed the wide, but gentle, stream." )
Пример 3. Возвращает 16 : 10 : 17, если содержимое полей From, Topic, и Date, соответственно, “Stephen Brewster", "News Flash", и [04.11.89 16:45:10]. @Length( From : Topic : @Text( Date ))
@LowerCase( строка ) @LowerCase( список_строк ) @UpperCase( строка ) @UpperCase( список_строк ) @ProperCase( строка ) @ProperCase( список_строк ) Область применения: без ограничений. @LowerCase преобразует все символы строки к нижнему регистру, @UpperCase - к верхнему, а @ProperCase - первый символ каждого слова - к верхнему, а остальные символы - к нижнему. При использовании в качестве аргумента списка строк, возвращают список, получившийся поэлементным применением функций. Пример 1. Возвращает "juan mendoza". @LowerCase( "Juan Mendoza" )
Пример 2. Возвращает "ROBERT T. SMITH". @UpperCase( "Robert T. Smith" )
Пример 3. Возвращает список "Every Child" : "Loves Toys". @ProperCase( "every CHILD" : "LOves toys" )
@NewLine Область применения: нельзя использовать в формулах отбора, колонок, видимости объекта, формы, заголовка окна, области размещения и в контексте функции @Prompt (внутри функции @Prompt используйте для перевода строки функцию @Char с параметрами, соответствующими символу возврата каретки для данной платформы). В Web-приложениях не работает в формулах отбора, формы и заголовка окна. Вставляет символ перехода на новую строку (возврат каретки) в текстовую строку. Пример 1. Присвоит полю Subject значение, первой строкой которого будет "Привет", а второй "всем". @SetField( "Subject"; "Привет" + @NewLine + "всем" )
Пример 2. При использовании в формуле, выполняющейся на компьютере под Windows, выдаст окно, в первой строке которого будет "Hello", а во второй "world". @Prompt( [Ok]; "Информация"; "Hello" + @Char( 13 ) + @Char( 10 ) + "world" )
@Repeat( строка; число_повторов; максимальное_число_символов ) @Repeat( список_строк; число_повторов; максимальное_число_символов ) Область применения: без ограничений. Длина возвращаемой строки не должна превышать 1024 символа, в противном случае возникает ошибка. Возвращает строку, полученную из исходной путем многократной операции конкатенации самой с собой. Число конкатенаций равно числу_повторов. Третий параметр необязателен, если он присутствует, то полученная строка обрезается до числа символов, равных максимальному_числу_символов. Если в качестве первого аргумента выступает список_строк, возвращаемое значение есть список, полученный поэлементным применением функции.
@Trim( строка ) @Trim( список_строк ) Область применения: без ограничений. Удаляет пробелы в начале и в конце строки и лишние пробелы внутри строки. Если параметром является список_строк, функция удаляет элементы типа пустой строки из результирующего списка. Пример 1. Возвращает "БОРИС ИВАНОВ". @Trim( @UpperCase( "Борис
Иванов " ))
Пример 2. Возвращает "БОРИС ИВАНОВ". @UpperCase( @Trim( "Борис
Иванов " ))
Пример 3. Возвращает "Пример использования функции", даже если исходное содержимое поля Topic выглядит как " Пример использования функции ". @Trim( Topic )
Пример 4. Возвращает "Бостон" : "Торонто" : "Сантьяго" : "США" : "Канада" : "Чили", если список в поле Сity содержит "Бостон" : "Торонто" : "Сантьяго"; поле StateOrProvince не содержит ничего; а поле Сountry содержит список "США" : "Канада" : "Чили". @Trim( City : StateOrProvince : Country )
Пример 5. Возвращает "45" как текстовую строку, если содержимым поля Date является [8.29.89 16:30:45], или любая другая величина "дата-время", в которой количество секунд равно 45. @Trim( @Text( @Second( Date )))
6.4.1 Определение вхождения подстроки в строку @Begins( строка; подстрока ) @Begins( строка; список_подстрок ) Область применения: без ограничений. Определяет, является ли заданная подстрока (или хотя бы один из элементов списка_подстрок) началом строки. Возвращает 1 (TRUE), если подстрока содержится в строке, начиная с первого символа, или 0 (FALSE),
если нет. Учитывает регистр. Допустимо также использование в качестве первого аргумента списка строк. В этом случае проверяется, начинается ли хотя бы какой-нибудь элемент списка строк с подстроки или элемента списка_подстрок. Пример 1. Возвращает 1. @Begins( "Привет всем"; "Привет" )
Пример 2. Возвращает 0. @Begins( "Привет всем"; "привет" )
Пример 3. Проверяет поле Topic. Если это поле начинается со строки "объявление", возвращает строку "Объявление". В противном случае возвращает строку "В первую очередь". @If( очередь" )
@Contains( строка; подстрока ) @Contains( строка; список_подстрок ) Область применения: без ограничений. Определяет, является ли подстрока (или хотя бы один из элементов списка_подстрок) частью строки. Возвращает 1 (TRUE), если подстрока содержится в строке; в противном случае возвращает 0 (FALSE). Учитывает регистр. Допустимо также использование в качестве первого аргумента списка строк. В этом случае проверяется, содержится ли в хотя бы каком-нибудь элементе списка строк подстрока или элемента списка подстрок. Пример 1. Возвращает 1. @Contains( "Привет всем"; "вс" )
Пример 2. Проверяет, содержит ли поле Topic одно из словосочетаний "Я хочу", "Мне нужно", или "Я должен иметь". Если да, возвращает строку "Требуется вежливый отказ", в противном случае возвращает "Не медлить с ответом". @If( @Contains( Topic; "Я хочу" : "Мне нужно" : "Я должен иметь" ); "Требуется вежливый отказ"; "Не медлить с ответом" )
Пример 3. Возвращает 1. @Contains( "Hello" : "world" : "Пока и привет всем"; "Bye" : "привет" )
@Ends( строка; подстрока ) @Ends( строка; список_подстрок ) Область применения: без ограничений. Определяет, находится ли заданная подстрока (или хотя бы один из элементов списка_подстрок) в самом конце строки. Возвращает 1 (TRUE), если да, или 0 (FALSE), если нет. Учитывает регистр. Допустимо также использование в качестве первого аргумента списка строк. В этом случае проверяется, заканчивается ли хотя бы какой-нибудь элемент списка строк с подстроки или элемента списка_подстрок. Пример 1. Возвращает 1. @Ends( "Привет всем"; "ем" )
Пример 2. Возвращает 0. @Ends( "Привет всем"; "" )
Пример 3. Проверяет, имеются ли строки "Уланов" или "Туликов" или "Никонов" в конце содержимого поля Signature. Если да, возвращает строку "Подпись удостоверена"; в противном случае, возвращает строку "Подпись не удостоверена". @If( @Ends( Signature; "Уланов" : "Туликов" : "Никонов"); "Подпись удостоверена"; "Подпись не удостоверена" )
Пример 4. Возвращает 1. @Ends( "Hello" : "world" : "Пока и привет всем"; "Bye" : "orld" )
@Matches( строка; образец ) Область применения: без ограничений. Проверяет строку на соответствие строке образцу. Строка образец может содержать ряд символов обобщения и знаков логических операций. @Matches возвращает 1 (TRUE), если строка соответствует образцу, или 0 (FALSE), если не соответствует. Допустимо также использование в качестве первого и второго аргумента списка строк. В этом случае возвращается 1 (TRUE), если хотя один элемент списка строк соответствует образцу или одному из элементов списка образцов. Перечень допустимых символов обобщения и знаков логических операций:
Пример 3. Преобразует содержимое поля State в нижний регистр и возвращает 1 для любого значения в поле, содержащего "монт", например, "Вермонт" или "Монтана". @Matches( @LowerСase( State ); "*монт*" )
Пример 4. Формула возвращает число 224, если в поле Division содержится "Центр" или "Урал". Если содержимое поля Division иное, формула возвращает число 124. @If( @Matches( Division; "Центр|Урал" ); 224; 124 )
@Like( строка; образец ) @Like( строка; образец; строка_индикатор ) Область применения: без ограничений. поддерживается драйвером NotesSQL ODBC.
Функция
Проверяет указанную строку на соответствие строке образцу. Строка образец может содержать ряд символов обобщения. @Like возвращает 1 (TRUE), если строка соответствует образцу, или 0 (FALSE), если не соответствует. Третий параметр строка_индикатор не обязателен, он необходим в том случае, если в строке образце нужно указать для поиска символ, входящий в список символов обобщений. В этом случае такой символ предваряется в строке-образце строкой_индикатором. Допустимо также использование в качестве первого и второго аргумента списка строк. В этом случае возвращается 1 (TRUE), если хотя один элемент списка строк соответствует образцу или одному из элементов списка образцов. Перечень допустимых символов обобщения:
Символ
Использование
C
Соответствует любому такому же символу С, но не самому символу "С"
_
(символ подчеркивания) Соответствует любому одному символу
%
Соответствует любой строке (любому количеству символов)
Пример 1. Возвращает 0. @Like( "Большая проверка"; "_проверка" )
Пример 2. Возвращает 1. @Like( "Большая проверка"; "%проверка" )
Пример 3. Возвращает 1. @Like( "Count of people"; "/C%"; "/" )
6.4.2 Выделение и замена части строки @Left( строка; число ) @Left( строка; подстрока ) @Left( список_строк; число ) @Left( список_строк; подстрока ) Область применения: без ограничений.
Если второй параметр является числом, @Left возвращает указанное количество символов от начала строки. Если число больше длины строки или отрицательное, то возвращается сама строка. Для числа равного нулю возвращается пустая строка. Если оба параметра являются строками - функция возвращает все символы из строки слева от заданной подстроки, или пустую строку, если подстрока не найдена в строке. Если первый параметр является списком, то возвращается список, создаваемый поэлементным применением функции. Функция учитывает регистр. Пример 1. Возвращает "Лео". @Left( "Леонард Эйлер"; 3 )
Пример 2. Возвращает "Леонард Эй", если в поле Contact содержится строка "Леонард Эйлер". @Left( Contact; "ле" )
Пример 3. Возвращает "Али", если в поле Author содержится "Алистер Маклин". @Left( Author; 3 )
@LeftBack( строка; число ) @LeftBack( строка; подстрока ) @LeftBack( список_строк; число ) @LeftBack( список_строк; подстрока ) Область применения: без ограничений.
Если параметрами являются строка и число, то @LeftBack возвращает все символы слева, считая от указанного числа символов от конца строки. Если число больше длины строки или отрицательное, то возвращается пустая строка. Для числа равного нулю - возвращается сама строка. Если параметрами являются две строки, то возвращаются все символы из строки слева от подстроки или пустая строка, если подстрока не найдена в строке. Если первый параметр является списком - возвращается список, создаваемый поэлементным применением функции. Учитывает регистр.
Пример 1. Возвращает "Леонард Эй". @LeftBack( "Леонард Эйлер"; 3 )
Пример 2. Возвращает "Леонард". @LeftBack( "Леонард Эйлер"; " " )
Пример 3. Возвращает "Алистер Мак", если в поле Author содержится "Алистер Маклин". @LeftBack( Author; 3 )
@Right( строка; число ) @Right( строка; подстрока ) @Right( список_строк; число ) @Right( список_строк; подстрока ) Область применения: без ограничений.
Если параметрами являются строка и число, то возвращается указанное число символов, считая от конца строки. Если число больше или равно длине строки или отрицательно, то возвращается сама строка. Для числа равного нулю возвращается пустая строка. Если оба параметра являются строками, функция просматривает строку слева направо в поисках подстроки, и возвращает символы справа от подстроки или пустую строку, если подстрока не найдена в строке. Если первый параметр является списком - возвращается список, создаваемый поэлементным применением функции. Пример 1. Возвращает "лер", 3 крайних правых символа в строке. @Right( "Леонард Эйлер"; 3 )
Пример 2. Возвращает "Эйлер", т.е. все символы справа от пробела. @Right( "Леонард Эйлер";" " )
Пример 3. Возвращает "лин", если в поле Author содержится "Алистер Маклин". @Right( Author; 3 )
Пример 4. Возвращает "акадабра". @Right( "Абракадабра"; "бр" )
@RightBack( строка; число ) @RightBack( строка; подстрока ) @RightBack( список_строк; число ) @RightBack( список_строк; подстрока ) Область применения: без ограничений.
Если параметрами являются строка и число, то функция просматривает строку слева направо, и возвращает все символы правее указанного числа символов. Если число отрицательное или больше или равно длине строки, то возвращается пустая строка. Для числа равного нулю
возвращается исходная строка. Если оба параметра являются строками, то функция просматривает строку справа налево, и возвращает символы справа от подстроки. Если первый параметр является списком - возвращается список, создаваемый поэлементным применением функции. Пример 1. Возвращает "нард Эйлер". @RightBack( "Леонард Эйлер"; 3 )
Пример 2. Возвращает пустую строку. @RightBack( "Леонард Эйлер"; "" )
Пример 3. Возвращает "а". @RightBack( "Абракадабра"; "бр" )
Пример 4. Возвращает "стер Маклин", если в поле Author содержится "Алистер Маклин". @RightBack( Author; 3 )
@Middle(строка; начальный_индекс; число_символов ). В этой форме синтаксиса строка является просматриваемой строкой текста, начальный_индекс определяет стартовый номер символа в строке, считая слева направо от начала строки, с которого начинается отсчет возвращаемых символов, а число_символов указывает количество возвращаемых символов. Если число_символов положительное, то возвращаются символы, начиная с символа с номером начальный_индекс + 1, и отсчет идет слева направо. Если число_символов отрицательное, возвращаются символы, начиная с символа с номером начальный_индекс, и отсчет идет справа налево. Если число_символов больше чем от начального_индекса до (или от) границы строки, то возвращается реальное число символов до (или от) границы строки. Для отрицательного начальног_индекса отсчет идет от конца строки справа налево. Более детально поведение функции в данном варианте синтаксиса дано в следующей таблице:
Положительный, лежит в интервале [ 1; длина строки ).
Положительный, лежит в интервале [ 1; длина строки ).
Положительный, лежит в интервале [ 1; длина строки ).
Положительный, лежит в интервале [ 1; длина строки ). Положительный, больше или равен длине строки.
Число символов
Выполняемые действия
Пример
Положительное, меньше или равное длине строки минус начальный индекс.
Первый индекс возвращаемого значения определяется как начальный индекс плюс 1. Длина строки возвращаемого значения равна числу символов.
@Middle("1 23456789"; 4; 3); возвращает "567"
Положительное, больше чем длина строки минус начальный индекс.
Первый индекс возвращаемого значения определяется как начальный индекс плюс 1. Длина строки возвращаемого значения равна длине строки минус начальный индекс.
@Middle("1 23456789"; 4; 33); возвращает "56789"
Отрицательное, модуль меньше чем начальный индекс.
Первый индекс возвращаемого значения определяется как начальный индекс минус модуль числа символов плюс 1. Длина строки возвращаемого значения равна числу символов.
@Middle("1 23456789"; 4; -3); возвращает "234"
Отрицательное, модуль больше или равен начальному индексу.
Первый индекс возвращаемого значения равен 1. Длина строки возвращаемого значения равна начальному индексу.
@Middle("1 23456789"; 4; -33); возвращает "1234"
Положительное
Возвращается пустая строка.
@Middle("1 23456789"; 10; 3); возвращает ""
(здесь индекс считается от начала строки слева направо)
Первый индекс возвращаемого значения определяется как длина строки минус модуль числа символов плюс 1. Длина строки возвращаемого значения равна числу символов.
@Middle("1 23456789"; 10; -3); возвращает "789"
Положительный, больше или равен длине строки.
Отрицательное, модуль больше или равен длине строки.
Отрицательный, модуль лежит в интервале [ 1; длина строки ).
Отрицательный, модуль лежит в интервале [ 1; длина строки ).
Отрицательный, модуль лежит в интервале [ 1; длина строки ).
Отрицательный, модуль лежит в интервале [ 1; длина строки ).
Положительное, меньше чем модуль начального индекса.
Первый индекс возвращаемого значения определяется как длина строки минус модуль начального индекса плюс 1. Длина строки возвращаемого значения равна числу символов.
@Middle("1 23456789"; -4; 3); возвращает "678"
Положительное, больше или равно модулю начального индекса.
Первый индекс возвращаемого значения определяется как длина строки минус модуль начального индекса плюс 1. Длина строки возвращаемого значения равна модулю начального индекса.
@Middle("1 23456789"; -4; 33); возвращает "6789"
Отрицательное, модуль меньше чем длина строки минус модуль начального индекса.
Первый индекс возвращаемого значения определяется как длина строки минус модуль начального индекса минус модуль числа символов плюс 1. Длина строки возвращаемого значения равна числу символов.
@Middle("1 23456789"; -4; -3); возвращает "345"
Отрицательное, модуль больше или равен длине строки минус модуль начального индекса.
Первый индекс возвращаемого значения равен 1. Длина строки возвращаемого значения равна длине строки минус модуль начального индекса.
Отрицательный, модуль больше или равен длине строки.
Отрицательное
Возвращается пустая строка
@Middle("1 23456789"; -10; -3); возвращает ""
@Middle(строка; начальный_индекс; подстрока). В этой форме синтаксиса строка является просматриваемой строкой текста, начальный_индекс определяет стартовый номер символа в строке, с которого начинается отсчет возвращаемых символов, а подстрока определяет окончание возвращаемого значения. Для отрицательного начального_индекса отсчет идет от конца строки справа налево. Если подстрока не входит в строку или лежит левее начального_индекса, то возвращается пустая строка. Если начальный_индекс положителен, и больше или равен длине строки, то возвращается пустая строка. Если начальный_индекс отрицателен, и его модуль больше или равен длине строки (а так же при нулевом значении начального_индекса), отсчет идет с первого символа строки. Более детально поведение функции в данном варианте синтаксиса дано в следующей таблице:
Положительный, лежит в интервале [ 1; длина строки ).
Положительный, лежит в интервале [ 1; длина строки ).
Положительный, больше или равен длине строки.
Ноль
Подстрока
Выполняемые действия
Пример
(здесь индекс считается от начала строки слева направо) В строке лежит правее начального индекса.
Первый индекс возвращаемого значения определяется как начальный индекс плюс 1. Длина строки возвращаемого значения равна первый индекс подстроки минус начальный индекс.
@Middle("12 3456789"; 4; "89"); возвращает "567"
В строке не присутствует или первый индекс подстроки меньше или равен начальному индексу.
Возвращает пустую строку.
@Middle("12 3456789"; 4; "777" ); возвращает ""
Любая
Возвращает пустую строку.
@Middle("12 3456789"; 10; "89" ); возвращает ""
Возвращает строку от начала строки до первого индекса подстроки.
@Middle(строка; подстрока; число_символов). В этой форме синтаксиса строка является просматриваемой строкой текста, а подстрока определяет конкретный текст, после первого вхождения которого, начинается отсчет возвращаемого количества символов. Если число_символов положительное, то возвращаются символы, начиная со следующего после последнего символа из подстроки и отсчитывая от нее слева направо. Если число_символов отрицательное, возвращаются символы, начиная с символа перед первым символом из подстроки, и отсчитывая от нее справа налево. Если подстрока не входит в строку, то возвращается пустая строка. Если число_символов больше чем от первого индекса подстроки до (или от) границы строки, то возвращается реальное число символов до (или от) границы строки. Пример 1. Возвращает "Car". Указана позиция первого пробела в строке "North Carolina", и отсчет начинается с первого символа после позиции. @Middle( "North Carolina"; " "; 3 )
Пример 2. Возвращает "or". Указана позиция подстроки "th", и отсчет начинается с первого символа, считая справа налево, после всей подстроки. @Middle( "North Carolina"; "th"; -2 )
Пример 3. Возвращает "акад". @Middle( "Абракадабра"; "бр"; 4 )
Пример 4. Возвращает "Абр". @Middle( "Абракадабра"; "акад"; -25 )
@Middle(строка; подстрока1; подстрока2). В этой форме синтаксиса строка является просматриваемой строкой текста, а подстрока1 определяет конкретный текст, после первого вхождения которого начинается отсчет возвращаемого значения. Подстрока2 определяет окончание возвращаемого значения. Если подстрока1 и подстрока2 совпадают, то для окончания возвращаемого значения ищется второе вхождение подстроки1 в строку. Если подстрока1 не входит в строку, то возвращается пустая строка.
Если подстрока2 не входит в строку или лежит левее подстроки1, то возвращается текст с первого символа, следующего за подстрокой1, до конца строки. Для всех вариантов синтаксиса, если первый параметр является списком, то возвращается список, создаваемый поэлементным применением функции. Пример 1. Возвращает "акада". @Middle( "Абракадабра"; "бр"; "бр" );
Пример 2. Возвращает "4567". @Middle( "123,4567,8,90"; ","; "," );
Пример 3. Возвращает пустая строка. @Middle( "123,4567,8,90"; "777"; "," );
Пример 4. Возвращает "4567,8,90". @Middle( "123,4567,8,90"; ","; "777" );
Пример 5. Возвращает "4567,8,90". @Middle( "123,4567,8,90"; ","; "23,4" );
@MiddleBack(строка; начальный_индекс; число_символов). В этой форме синтаксиса строка является просматриваемой строкой текста, начальный_индекс определяет стартовый номер символа в строке, считая справа налево от конца строки, после которого начинается отсчет возвращаемых символов, а число_символов указывает количество возвращаемых символов.
Если число_символов положительное, то возвращаются символы, начиная с символа с номером начальный_индекс - 1, и отсчет идет слева направо. Если число_символов отрицательное, то возвращаются символы, начиная с символа с номером начальный_индекс, и отсчет идет справа налево. Если число_символов больше чем от начального_индекса до (или от) границы строки, то возвращается реальное число символов до (или от) границы строки. Для отрицательного начального_индекса отсчет идет от начала строки слева направо. Более детально поведение функции в данном варианте синтаксиса дано в следующей таблице:
Отрицательное, модуль меньше чем длина строки минус начальный индекс плюс 1.
Первый индекс возвращаемого значения определяется как начальный индекс плюс модуль числа символов минус 1. Длина строки возвращаемого значения равна числу символов.
Положительное, меньше чем длина строки минус модуль начального индекса минус 1.
Первый индекс возвращаемого значения определяется как длина строки минус модуль начального индекса минус 1. Длина строки возвращаемого значения равна числу символов.
Положительное, больше или равное длине строки минус модуль начального индекса минус 1.
Первый индекс возвращаемого значения определяется как длина строки минус модуль начального индекса минус 1. Длина строки возвращаемого значения равна длине строки минус модуль начального индекса минус 1.
Отрицательное, модуль меньше чем модуль начального индекса плюс 1.
Первый индекс возвращаемого значения определяется как длина строки минус модуль начального индекса плюс модуль числа символов минус 1. Длина строки возвращаемого значения равна числу символов.
@MiddleBack(строка; начальный_индекс; подстрока). В этой форме синтаксиса строка является просматриваемой строкой текста, начальный_индекс определяет стартовый номер символа в строке, считая справа налево от конца строки, с которого начинается отсчет возвращаемых символов, а подстрока определяет «хвост» возвращаемого значения. Для отрицательного начального_индекса отсчет идет от начала строки слева направо. Если подстрока не входит в строку или лежит правее начального_индекса, то возвращается строка от начала строки до начального_индекса включительно. Если начальный_индекс положителен, и больше или равен длине строки, то возвращается пустая строка. Если начальный_индекс отрицателен, и его модуль больше или равен длине строки (а так же при нулевом значении начального_индекса), отсчет идет с первого символа строки. Более детально поведение функции в данном варианте синтаксиса дано в следующей таблице:
Начальный индекс
Подстрока
Выполняемые действия
Пример
(здесь индекс считается от конца строки справа налево) Положительный, лежит в интервале [ 1; длина строки ). Положительный, лежит в интервале [ 1; длина строки ).
84
В строке лежит левее начального индекса.
Возвращает строку от последнего индекса подстроки плюс 1 до начального индекса включительно.
@MiddleBack(строка; подстрока; число_символов). Здесь строка является просматриваемой строкой текста, подстрока определяет конкретный текст, после первого вхождения которого начинается отсчет возвращаемого количества символов, а число_символов указывает количество возвращаемых символов. Если число_символов положительное, то возвращаются символы, начиная со следующего после последнего символа из подстроки, и отсчитывая от него слева направо. Если число_символов отрицательное, то возвращаются символы, начиная с символа перед первым символом из подстроки, и отсчитывая от него справа налево. Если подстрока не входит в строку, то возвращается пустая строка. Если число_символов больше чем от первого индекса подстроки до (или от) границы строки, то возвращается реальное число символов до (или от) границы строки. Пример 1. Возвращает "Car". Указана позиция первого пробела в строке "North Carolina", и отсчет начинается с первого символа после позиции. @MiddleBack( "North Carolina"; " "; 3 )
Пример 2. Возвращает "or". Указана позиция подстроки "th", и отсчет начинается с первого символа, считая справа налево, после всей подстроки. @MiddleBack( "North Carolina"; "th"; -2 )
Пример 3. Возвращает "кадa". @MiddleBack( "Абракадабра"; "бр"; -4 )
Пример 4. Возвращает "Абракад". @MiddleBack( "Абракадабра"; "аб"; -25 )
@MiddleBack(строка; подстрока1; подстрока2). В этой форме синтаксиса строка является просматриваемой строкой текста, а подстрока1 определяет конкретный текст, после первого вхождения которого начинается отсчет возвращаемого значения. Подстрока2 определяет «хвост» возвращаемого значения.
Если подстрока1 и подстрока2 совпадают, то в качестве «хвоста» возвращаемого значения ищется второе вхождение подстроки1 в строку.
Если подстрока1 не входит в строку, то возвращается пустая строка. Если подстрока2 не входит в строку, или лежит правее подстроки1, то возвращается текст с первого символа, следующего за подстрокой1, до начала строки. Для всех вариантов синтаксиса, если первый параметр является списком, то возвращается список, создаваемый поэлементным применением функции. Пример 1. Возвращает "акада". @MiddleBack( "Абракадабра"; "бр"; "бр" );
Пример 2. Возвращает "8". @MiddleBack( "123,4567,8,90"; ","; "," );
Пример 3. Возвращает пустая строка. @MiddleBack( "123,4567,8,90"; "777"; "," );
Пример 4. Возвращает "123,4567,8". @MiddleBack( "123,4567,8,90"; ","; "777" );
Пример 5. Возвращает "567,8". @Middle( "123,4567,8,90"; ","; "23,4" );
Пример 6. Возвращает "Мак" : "Мак" : "Кри" : "Сим", если в поле Committee содержатся четыре значения: "Алистер Маклин" : "Росс Макдональд" : "Агата Кристи" : "Жорж Сименон". @MiddleBack( Committee; " "; 3 )
@Word( строка; разделитель; номер_слова ) @Word( список_строк; разделитель; номер_слова ) Область применения: без ограничений. Функция просматривает исходную строку слева направо и возвращает "слово", позиция которого в строке соответствует номеру_слова. Под "словом" понимается символы, часть исходной строки, заключенные справа и слева в символы строки разделителя. Если в качестве первого аргумента выступает список_строк, возвращаемое значение есть список, получаемый поэлементным применением функции. Пример 1. Возвращает "применения". @Word( "Примеры применения функций"; " "; 2 )
Пример 2. Возвращает "функций" : "language", если в поле Topic содержится "Примеры<>применения<>функций" : "Notes<>formula<>language". @Word( Topic; "<>"; 3 )
Пример 3. Возвращает "в качестве первого аргумента", если это есть третья строка в поле Describe. @Word( Describe; @NewLine; 3 )
@ReplaceSubstring( исходный_список ; найти ; заменить_на ) Область применения: без ограничений. Выполняет замены в строке или списке строк исходный_список всех вхождений слов или фраз из списка строк найти на соответствующие слова или фразы из списка строк заменить_на. Учитывает регистр. Возвращает полученную строку или список строк. Если в списке найти больше элементов, чем в списке заменить_на, то "лишние" элементы из списка найти заменяются на последний элемент списка заменить_на. "Лишние" элементы списка заменить_на игнорируются. В процессе своей работы функция @ReplaceSubstring для каждого элемента из списка найти повторно пробегает исходный_список, таким образом можно выполнять циклические подстановки (см. Пример 4). Пример 1. Возвращается "I hate apples". @ReplaceSubstring( "I like apples" ; "like" ; "hate" )
Пример 2. Возвращается "I hate peaches". @ReplaceSubstring( "I like apples"; "like" : "apples"; "hate" : "peaches" )
Пример 3. Заменяет символы перехода на новую строку в поле Description на пробелы. @ReplaceSubString( Description; @Newline; " " )
Пример 4. Возможны возвращается "third". @ReplaceSubstring( "third" )
"многократные"
"first";
"first"
замены. :
В
этом
"second";
примере
"second"
:
ϑ @FileDir( строка ) Область применения: без ограничений. Выделяет и возвращает из своего параметра-строки имя директории или другими словами часть строки от начала до первого правого символа слеша (включая его), или если этого символа нет, то пустую строку. Если в качестве
параметра выступает текстовый список, то результат действия функции будет список, полученный поэлементным применением функции. Пример 1. Возвращает C:\ @FileDir("C:\\Database.nsf");
Пример 2. Возвращает - \ @FileDir("\\Database.nsf");
Пример 3. Возвращает путь к текущей БД. @FileDir(@Subset(@DbName;-1));
6.5 Функции для работы со значениями типа "дата-время" @Now ϑ @Now( флаги; список_имен_серверов ) Область применения: без ограничений. Возвращает текущие дату и время как значение типа "дата-время". Во втором варианте синтаксиса флаги могут принимать одно из следующих значений:
• •
[ServerTime] – при указании данного и следующего параметра время может браться по таймеру указанного сервера(ов); [LocalTimeOnError] - при указании данного параметра и возникновении ошибки время будет браться по таймеру локальной станции.
Параметр список_имен_серверов имеет смысл только при задании флага [ServerTime], и может быть как текстовой строкой, так и списком. В последнем случае возвращаемое значение функции может быть так же списком. Время берется по таймеру локальной станции в следующих случаях:
• • •
если функция используется без параметров; флаг [ServerTime] указан, но текущая база локальная и второй параметр не указан; флаг [LocalTimeOnError] указан, второй параметр задан, но произошла ошибка при попытке получить значение даты-времени с указанного сервера.
Соответственно серверное время может быть получено в следующих случаях:
• •
если текущая БД находится на сервере, флаг [ServerTime] указан, но второй параметр не указан; при задании флага [ServerTime] и указании второго действительного параметра. В этом случае не важно где находится текущая БД, необходимо только чтобы станция имела доступ к указанным серверам.
Использование @Now в формулах отбора и колонок может существенно снизить производительность приложения. Пример 1. Возвращает [21.01.95 17:30:45] в 17:30:45 21 января 1995. @Now
Пример 2. Может вернуть список [21.01.01 17:30:28] : [21.01.01 17:30:25]. @Now( "server2" );
[ServerTime]
:
[LocalTimeOnError];
"server1"
:
ϑ @TimeMerge( дата; время [; часовой_пояс]) Область применения: без ограничений. Возвращает значение аргументами функции.
типа
дата/время,
которое
определяется
Параметры дата и время имеют тип дата/время, и определят соответствующие компоненты возвращаемого значения. Необязательный параметр часовой_пояс задает тайм зону возвращаемого значения, тип данных этого параметра должен соответствовать каноническому значению требуемой тайм зоны. Иными словами, в качестве данного параметра можно использовать значение поля, тип которого тайм зона (поле Type = Time zone с закладки Filed Info окна свойств поля). Пример 1. Возвращает значение [16.06.2003 16:24:27]. @TimeMerge( [16.06.2003 12:20:00]; [26.04.1964 16:24:27] )
Пример 2. Возвращает значение [16.06.2003 16:24:27 ZE7], если формула выполняется на компьютере, находящемся в часовом поясе Красноярска.
@Today Область применения: без ограничений. При использовании в формулах полей, возвращает значение текущей даты по таймеру рабочей станции, а не сервера. Возвращает текущую дату. Аналогична формуле @Date( @Now ). Обычно используется в формулах значений по умолчанию для автоматического ввода текущей даты. При использовании в формулах колонок и отбора документов может значительно снизить производительность работы из-за пересчетов. Пример 1. Возвращает [02.19.95], если сегодня 19 февраля 1995 г. @Today
Пример 2. Устанавливает в поле ReceivedDate текущую дату. FIELD ReceivedDate := @Today;
@Tomorrow Область применения: без ограничений. При использовании в формулах полей, возвращает значение "дата-время" по таймеру рабочей станции, а не сервера. Возвращает значение "дата-время", соответствующее завтрашнему дню. При использовании в формулах колонок и отбора документов может значительно снизить производительность работы из-за пересчетов. Пример 1. Возвращает [27.04.95], если сегодня 26 апреля 1995 г. @Tomorrow
Пример 2. Устанавливает завтрашнюю дату в поле AnswerBack. FIELD AnswerBack := @Tomorrow;
@Yesterday Область применения: без ограничений. Использование функции в формулах колонок и отбора документов может иногда приводить к отображению недостоверных данных, особенно в момент перехода дат. При использовании в формулах полей, возвращает значение "дата-время" по таймеру рабочей станции, а не сервера. Возвращает величину "дата-время", соответствующую вчерашнему дню. Пример. Возвращает [31.12.94], если сегодня 1 января 1995 г., или [16.8.95], если сегодня 17 августа 1995 г. @Yesterday
@Zone @Zone( дата-время ) Область применения: без ограничений. Функция возвращает числовое значение, определяющее установки часового пояса с учетом перехода на летнее/зимнее время. При вызове @Zone без параметра, возвращает установки компьютера, на котором она выполнялась. При передаче в качестве аргумента значения дата/время определяет установки, действующие на момент создания этого значения. В аргументе должна обязательно присутствовать компонента времени, в противном случае функция @Zone вернет значение ноль. Если аргумент есть константа, то возвращаемое значение определяет установки, действующие на момент сохранения @-формулы. Возвращаемое значение имеет вид:
(+/-) mmhh.Flag
,
где знак для часовых поясов восточнее Гринвича (GMT) отрицателен, соответственно для поясов западнее GMT положителен. mm - минутная составляющая времени относительно GMT, а hh - часовая составляющая. В случае если часовой пояс смещен относительно GMT на целое число часов, компонента mm в возвращаемом значении отсутствует. Flag равен единице, если функция @Zone была вызвана без параметров, и на компьютере установлен переход на летнее/зимнее время, либо при вызове функции с аргументом, он «попал» в интервал с переходом на «смещенное» время. В противном случае Flag равен нулю. Функция @Zone бывает полезна в распределенных БД, расположенных на разных серверах в различных часовых поясах.
Пример 1. Возвращает (-3005.1) для компьютера, находящегося в Бомбее (GMT + 05:30) с включенным переходом на летнее/зимнее время. @Zone
Пример 2. Возвращает (6.1) для документа, который был создан в Мехико (GMT - 06:00) и дата его создания «попала» в «смещенное» относительно Гринвича летнее/зимнее время. @Zone( @Created )
Пример 3. Возвращает (-3), если приведенная функция была сохранена в форме, установленной на компьютере в Москве (GMT + 03:00), и дата сохранения не «попала» в «смещенное» относительно Гринвича летнее/зимнее время. @Zone( [12.07.96 07:15:00] )
Пример 4. Возвращает 0, так как в аргументе отсутствует компонента времени. @Zone( [12.07.96] )
ϑ @GetCurrentTimeZone Область применения: без ограничений. Функция возвращает текущие настройки часового пояса в каноническом формате. Канонический формат часового пояса предназначен для сохранения значений в новом для R 6 типе полей – Time zone, и, например, для часового пояса Москвы имеет следующий вид: «Z=-3$DO=1$DL=3 -1 1 10 -1 1$ZX=52$ZN=Russian». Для преобразования таких значений к тексту используется функция @TimeZoneToText. При выполнении функции на стороне сервера (например, в агенте по расписанию) возвращает настройки часового пояса сервера, в клиенте – соответственно рабочей станции. Пример 1. В формуле значения вычисляемого поля типа Time zone на рабочей станции с настройками часового пояса «(GMT+03:00) Moscow, St. Petersburg, Volgograd» с поднятым флагом «Automatically adjust clock for daylight saving changes» (автоматический переход на летнее время) возвращает значение «Z=-3$DO=1$DL=3 -1 1 10 -1 1$ZX=52$ZN=Russian». @GetCurrentTimeZone
Пример 2. В формуле значения вычисляемого текстового поля с настройками часового пояса из Примера 1 вернет значение «(GMT+03:00) Moscow, St. Petersburg, Volgograd». @TimeZoneToText(@GetCurrentTimeZone)
6.5.1 Функции, работающие с компонентами значения типа "дата-время" Все функции из настоящего раздела, за исключением @Second, «чувствительны» к значению часового пояса. Поэтому при обращении к документу, созданному в другом часовом поясе, вы можете получить на первый взгляд странный результат. Например, время создания документа, поздравляющего с наступлением нового года, может быть датировано годом старым. Однако ничего странного тут нет, Lotus хранит значения типа «датавремя» в формате по Гринвичу, а при выводе по умолчанию преобразует значение к текущему часовому поясу.
@Weekday( дата-время ) Область применения: без ограничений. Определяет день недели, на который «приходится» заданная величина дата-время, и возвращает соответствующее дню недели число. Номерами дней недели являются числа от 1 до 7, причем воскресенью соответствует 1, понедельнику - 2, и т.д. Пример 1. Возвращает 5. @Weekday( [29.9.88] )
Пример 2. Возвращает 2, если дата в поле ResponseDate приходится на понедельник. @Weekday( ResponseDate )
Пример 3. Возвращает строку "Работа в выходные", если содержимое поля ResponseDate соответствует субботе или воскресенью; в противном случае возвращает текстовую строку с датой создания документа. @If( @Weekday( ResponseDate ) = 7 | @Weekday( ResponseDate ) = 1; "Работа в выходные"; @Text( @Created ) )
@Day( дата-время ) Область применения: без ограничений. Извлекает день месяца из указанного значения даты-времени. Пример 1. Возвращает 15, если сегодня 15 июля или 15 августа или 15 сентября и т.д. @Day( @Now )
Пример 2. Возвращает строку "Оплачено не позже 15-го", если день месяца в поле PaymentReceived меньше или равен 15; в противном случае возвращает строку "Оплачено после 15-го". @If( @Day( PaymentReceived )<16; "Оплачено не позже 15-го"; "Оплачено после 15-го" )
@Month( дата-время ) Область применения: без ограничений. Извлекает номер месяца из указанной величины дата-время. Пример 1. Возвращает 1. @Month( [15.01.88] )
Пример 2. Возвращает номер (1-12) текущего месяца. @Month( @Now )
@Year( дата-время ) Область применения: без ограничений. Из указанной величины дата-время извлекает и возвращает год в соответствии с той тайм-зоной, в которой величина дата-время была получена. Результат является числом. Пример. Возвращает 1995. @Year( [29.9.95] )
@Hour( дата-время ) Область применения: без ограничений. Возвращает количество часов в параметре дата-время. Пример 1. Возвращает 9. @Hour( [9:30] )
Пример 2. Возвращает 8, если время в поле Date составляет 8:56:34. @Hour( Date )
Пример 3. Возвращает 9, если поле Date содержит дату-время 30.7.90 9:59:59. @Hour( Date )
Пример 4. Возвращает 3, если текущий документ был создан 15.2.92 в 3:00:12. @Hour( @Created )
@Minute( дата-время ) Область применения: без ограничений. Возвращает количество минут в параметре дата-время. Пример 1. Возвращает 30. @Minute( [9:30] )
Пример 2. Возвращает 56, если поле Time содержит 8:56:34. @Minute( Time )
Пример 3. Возвращает 59, если поле Date содержит 30.7.88 9:59:59. @Minute( Date )
Пример 4. Возвращает 00, если текущий документ был создан 29.9.94 3:00:12. @Minute( @Сreated )
@Second( дата-время ) Область применения: без ограничений. Извлекает и возвращает количество секунд в указанной величине датавремя в виде числового значения. Пример 1. Возвращает 45.
Пример 2. Возвращает 45, если текущее время 12:30:45. @Second( @Now )
Пример 3. Возвращает 45 как текстовую строку, если содержимое поля Date является величиной "дата-время", в которой количество секунд равно 45. @Text( @Second( Date ))
@Date( год; месяц; день ) @Date( год; месяц; день; час; минута; секунда ) @Date( дата-время ) Область применения: без ограничений. Возвращает заданную параметрами дату как величину типа дата/время, но содержащую только компоненту даты. Для указания отдельных составляющих даты и времени (год, месяц, день, час, минута, секунда) в первых двух формах записи @Date используются числа. В форме записи @Date( [датавремя] ) в качестве параметра используется величина типа дата/время. @Date отбрасывает из нее компоненту, относящуюся ко времени, оставляя только компоненту даты. В соответствии с синтаксисом константу типа дата/время записывают в квадратных скобках, например [31.10.95 12:00:00]. Пример 1. Возвращает [20.11.95]. @Date( 1995;11;20 )
Пример 2. Возвращает [20.01.95]. @Date( 1995;01;20;8;58;12 )
Пример 3. Возвращает [20.11.95]. @Date( [20.11.95 8:58:12] )
@Time( час; минута; секунда ) @Time( год; месяц; день; час; минута; секунда ) @Time( [дата-время] ) Область применения: без ограничений. Преобразует заданное параметрами время в величину типа "датавремя", но содержащую только компоненту времени. Пример 1. Возвращает [23:50:30]. @Time( 1951; 04; 11; 23; 50; 30)
Пример 2. Возвращает [09:19:24] в 9:19:24 каждый день.
Пример 3. Возвращает [09:19:24], если документ был создан в 9:19:24. @Time( @Created )
@Adjust( дата-время; год; месяц; день; час; минута; секунда; [флаг] ) Область применения: без ограничений. Функция "чувствительна" к часовому поясу. Изменяет указанную первым параметром величину дата-время на заданный интервал времени (год лет + месяц месяцев + день дней + час часов + минута минут + секунда секунд). Корректирующие величины могут быть положительными либо отрицательными. В формуле должны присутствовать все параметры (за исключением [флага]); если Вы не хотите изменять какой-то из них - просто укажите 0. Характерное использование @Adjust - вычисление даты исполнения документа по известной дате создания документа и заданному сроку исполнения, например, один месяц. Параметр [флаг] может принимать значения [InLocalTime] и [InGMT] (по умолчанию). Данный аргумент влияет на результирующее значение функции в случае, когда это значение и исходный параметр дата-время находятся по разные стороны от границы перехода с летнего времени на зимнее, и наоборот (при условии, что на компьютере установлен такой переход). Если [флаг] равен [InLocalTime], то происходит увеличение или уменьшение времени по Гринвичу на час, для [флага] равного [InGMT] такой корректировки не производится. ВНИМАНИЕ: в Domino для флага [InLocalTime] при больших значениях сдвигов параметра дата-время функция @Adjust может работать не вполне корректно. Сам IBM утверждает, что это не ошибка и сдвиги при этом флаге должны быть в рамках одного дня. Пример 1. Демонстрирует некорректное применение функции @Adjust с флагом [InLocalTime]. @Prompt( [Ok]; "InLocalTime"; @Text( @Adjust( [27.03.99 01:00]; -1; 1; 1; 0; 0; 0; [InLocalTime] ))); Rem "возвращает [28.04.97 01:00] "; @Prompt( [Ok]; "InGMT"; @Text( @Adjust( [27.03.99 01:00]; -1; 1; 1; 0; 0; 0; [InGMT] ))); Rem "возвращает [28.04.98 01:00] "
Пример 2. Возвращает [2.12.94]. Domino распознает 30 как день месяца и, увеличивая этот параметр на 2, автоматически изменяют месяц с 9 на 10. Затем месяц и год, соответственно, будут увеличены на 2. @Adjust( [30.9.92]; 2; 2; 2; 0; 0; 0 )
Пример 3. Возвращает [20.01.93]. Domino возвращает дату, которая на 2 года и 10 дней меньше указанной. @Adjust( [30.01.95]; -2; 0; -10; 0; 0; 0 )
Пример 4. Возвращает дату на месяц больше даты, указанной в поле Date. @Adjust( Date; 0; 1; 0; 0; 0; 0 )
Пример 5. Возвращает дату на месяц и день больше текущей. @Adjust( @Now; 0; 1; 1; 0; 0; 0 )
Пример 6. В 1999 году переход на летнее время осуществлялся 29.03.99 в 02:00. Поэтому первый оператор формулы выдаст окно со значением [29.03.99 02:00:00], а второй - [29.03.99 01:00:00]. @Prompt( [OK]; "InGMT"; @Text( @Adjust( [28.03.99 01:00:00]; 0; 0; 1; 0; 0; 0; [InGMT] ))); @Prompt( [OK]; "InLocalTime"; @Text( @Adjust( [28.03.99 01:00:00]; 0; 0; 1; 0; 0; 0; [InLocalTime] )))
6.6 Функции для работы с численными значениями В языке @-формул Lotus/Domino присутствует довольно большой набор функций для выполнения математических операций, такие как вычисление тригонометрических функций, генерация псевдослучайных чисел, округление и т.д. В этом разделе мы рассмотрим только те из них, которые, на наш взгляд, требуют пояснений, или новые и модифицированные в версии R 6.
@Sum( список_чисел_1; … ; список_чисел_N ) Область применения: без ограничений. Возвращает сумму всех элементов списка или нескольких списков, элементами которых являются числа. Обратите внимание, что отрицательные элементы списка должны заключаться в круглые скобки. Если значение списка_чисел берется из некоторого поля, следует проверить, чтобы поле не было пустым. В противном случае возникнет ошибка, так как Domino интерпретирует пустое числовое поле, как пустую строку.
Пример 3. Возвращает 100, если поле numPersons содержит список чисел 5: 10: 15: 20. @Sum( numPersons; numPersons )
ϑ @FloatEq( число1; число2 [; точность ] ) Область применения: нельзя использовать в формулах отбора. Сравнивает два числа с заданной точностью. По умолчанию параметр точность равен 0.0001. Функция возвращает 1 (TRUE), если разность между двумя числами меньше значения точности, или 0 (FALSE) в противном случае. Если первые два параметра списки, то для выполнения операции берутся только их первые элементы. Пример. Присвоит переменной a1 значение 1, b1 – 0. a := 19,001; b := 19,0009; c := 19,01; a1 := @FloatEq( a; b; 0,0002); b1 := @FloatEq( a; c);
@Max( число1; число2 ) ϑ @Max( список_чисел ) Область применения: без ограничений. В варианте с двумя параметрами возвращает максимальное из двух чисел или числовых списков. Для списков осуществляется попарное сравнение. Если один из списков короче другого, то он дополняется значением его последнего элемента. Второй вариант синтаксиса добавлен в R 6, он позволяет вернуть значение наибольшего элемента из списка_чисел. Пример 1. Возвращает 3. @Max( 3; -2);
@Min( число1; число2 ) ϑ @Min( список_чисел ) Область применения: без ограничений. В варианте с двумя параметрами возвращает минимальное из двух чисел или числовых списков. Для списков осуществляется попарное сравнение. Если один из списков короче другого, то он дополняется значением его последнего элемента. Второй вариант синтаксиса добавлен в R 6, он позволяет вернуть значение наименьшего элемента из списка_чисел. Пример 1. Возвращает -2. @Min( 3; -2);
Пример 2. Возвращает -5. @Min( 3 : 7 : (-5) : 9);
6.7 Функции для работы со списками @Elements( список ) Область применения: без ограничений. Возвращает в формате числа количество текстовых, числовых или дата/время элементов (значений) в списке. Для пустой строки и значений типа не список функция возвратит число 0. Пример 1. Возвращает 4, если поле SalesForce содержит список "Иванов": "Петров": "Сидоров": "Новиков". @Elements( SalesForce )
Пример 2. Возвращает 2. @Elements( "Новиков" : "Кузнецов" )
ϑ @Count( список ) Область применения: без ограничений. Возвращает число элементов в списке, аналогично @Elements, однако, в отличие от последней, для пустой строки и для значений типа не список вернет значение 1, а не 0. Пример 1. Возвращает 2. @Count( "Новиков" : "Кузнецов" )
Пример 2. Возвращает 0 для @Elements, и 1 для @Count. @Elements( "" ); @Count( "" );
@IsMember( строка; список_строк ) @IsMember( список_строк_1; список_строк_2 ) Область применения: без ограничений. Возвращает 1 (TRUE), если строка является элементом списка_строк; возвращает 0 (FALSE) в противном случае. Если оба параметра являются списками - возвращает 1, если все элементы списка_строк_1 содержатся в списке_строк_2. Функция учитывает регистр. Пример 1. Возвращает 1. @IsMember( "компьютер"; "принтер" : "компьютер" : "монитор" )
Пример 2. Возвращает 0. @IsMember( "монитор" )
"компьютер"
:
"Notes";
"Notes"
:
"принтер"
:
Пример 3. Возвращает 1, если "Отдел разработок" содержится в списке в поле Department, или 0, если нет. @IsMember( "Отдел разработок"; Department )
@IsNotMember( строка; список_строк ) @IsNotMember( список_строк_1; список_строк_2 ) Область применения: без ограничений. Возвращает 1 (TRUE), если строка не является элементом списка_строк; возвращает 0 (FALSE) в противном случае. Если оба параметра являются списками - возвращает 1, если ни один из элементов списка_строк_1 не содержится в списке_строк_2. Функция учитывает регистр. Обратите внимание, что @IsNotMember тождественно не равна отрицанию функции @IsMember в случае, если два аргумента есть списки. Пример 1. Возвращает 0. @IsNotMember( "компьютер"; "принтер" : "компьютер" : "монитор" )
Пример 2. Присваивает полю Dept значение "Маркетинг", если текущий пользователь не указан в списке в поле SalesDepartment; в противном случае присваивает полю Dept - "Сбыт". FIELD Dept := @If( @IsNotMember( @UserName; SalesDepartment ); "Маркетинг"; "Сбыт" );
@Member( строка; список_строк ) Область применения: без ограничений. Возвращает 0, если строка не содержится в списке_строк; возвращает величину от 1 до N, если строка содержится в списке_строк, причем величина от 1 до N определяется местоположением указанной строки в списке_строк. Пример 1. Возвращает 0. @Member( "Сбыт"; "Финансы" : "Сервис" : "Канцелярия" )
Пример 2. Если значение из поля ReportName содержится в списке из поля RequiredReading 12-м элементом, будет возвращено 12. Если значение из поля ReportName вообще не содержится в списке, возвращается 0. @Member( ReportName; RequiredReading )
Пример 3. Если имя, возвращаемое функцией @Author, содержится 4-м элементом в поле-списке EditorialBoard, возвращает 4. Если имя не содержится в списке - возвращает 0. @Member( @Author; EditorialBoard )
@Replace( список_строк; найти; заменить_на ) Область применения: без ограничений. Ищет в списке_строк значения, указанные в списке найти. Заменяет каждое найденное значение соответствующим значением из списка заменить_на. Возвращает исходный список со всеми произведенными изменениями (если никаких значений из списка найти в списке_строк не найдено, возвращает список_строк без изменений). Если список заменить_на короче списка найти, то элементы из списка найти, не имеющие соответствующих элементов в списке заменить_на, будут заменены в исходном списке на пустые строки. Это свойство может быть использовано для удаления элементов из списка. В этом случае список заменить_на задается пустым; сначала все элементы из списка найти заменяются на пустые, а затем функция @Trim() удаляет пустые элементы из полученного списка. Пример 1. Domino просматривает исходный список и, как только значение в исходном списке содержится в списке "найти", он заменяет это значение соответствующим значением из списка "заменить_на". В этом примере только "Оранжевый" в исходном списке будет заменен на "Черный". Результат будет выглядеть следующим образом: "Красный" : "Черный" : "Желтый" : "Зеленый". @Replace( "Красный" : "Оранжевый" : "Желтый" : "Зеленый"; "Оранжевый" : "Синий"; "Черный" : "Коричневый" )
Пример 2. Удаляет из списка в поле Categories все элементы, входящие во второй список. Если исходно в поле Categories был список "Брянск" : "Барнаул" : "Ростов" : "Смоленск", @Replace вернет "Брянск" : "" : "" : "Смоленск", а @Trim - "Брянск" : "Смоленск". Это результат присваивается полю Categories. FIELD Categories := @Trim( @Replace( Categories; "Ростов" : "Барнаул"; "" ));
@Subset( список; число ) Область применения: без ограничений. Если число положительное, возвращает указанное число значений, считая от начала списка. Для положительного числа большего, чем длина списка – возвращается исходный список. При нулевом значении числа генерируется ошибка «The second argument to @Subset must not be zero» (Второй аргумент @Subset не должен быть равен нулю). Если число отрицательное, возвращает указанное число значений, считая от конца списка.
Для отрицательного числа, модуль которого большего, чем длина списка – возвращается исходный список. В любом случае результат возвращает в порядке, определенном в списке. Пример 1. Возвращает "Краков" : "Новосибирск". @Subset( "Краков" : "Новосибирск" : "Франкфурт" : "Токио"; 2 )
Пример 3. Возвращает "Краков" : "Новосибирск" : "Франкфурт", если в поле BranchOffices находится список "Краков" : "Новосибирск" : "Франкфурт" : "Токио" : "Сингапур" : "Сидней". @Subset( BranchOffices; 3 )
@Unique @Unique( список_строк ) Область применения: без ограничений. При вызове функции без параметра возвращает случайным образом сгенерированную уникальную строку. При вызове с параметром список_строк, удаляет из него повторяющиеся значения. Учитывает регистр. В документации сказано, что функция не поддерживается в Web-приложениях. Однако как в первом, так и во втором варианте синтаксиса @Unique работает в Web (возможно не во всех контекстах). Пример 1. Может возвратить строку типа "SERR-42VQRW". @Unique
@Keywords( список_строк_1; список_строк_2 ) @Keywords( список_строк_1; список_строк_2; строка_разделитель ) Область применения: без ограничений. При использовании с третьим параметром может возвращать некорректный результат. Возвращает список, состоящий из всех тех элементов списка_строк_2, которые содержатся "в качестве слов" в списке_строк_1. Если ни один из элементов второго списка не содержится "в качестве слов" в первом, то возвращается пустая строка. Функция учитывает регистр.
Строка_разделитель содержит один или более символов, используемых для разделения слов в списке_строк_1. Например, " .," означает, что слова разделяются пробелом, запятой или точкой. В варианте с двумя параметрами для разделения слов используются символы из строки «?. ,!;:[](){}"<>» (символы: знак вопроса, точка, пробел, запятая, восклицательный знак, точка с запятой, двоеточие, открывающие и закрывающие квадратные, круглые и фигурные скобки, двойные кавычки и символы больше, меньше).
В случае, если искомое слово из списка_строк_2 стоит самым первым словом в любом элементе списка_строк_1, и задана строка_разделитель, то возвращается пустая строка. Для коррекции поведения функции в данном случае необходимо предварить ключевое слово в списке_строк_1 одним из символов из строки_разделителя (см. примеры 4 и 5). Аналогичное поведение будет и если не указать третий параметр или использовать в качестве его пустую строку.
Пример 1. Возвращается "Harvard" : "Yale" : "UCLA". @Keywords( "EPA Head speaks at Harvard,Yale" : "UCLA Chancellor Retires" : "Ohio State wins big game" : "Reed and University of Oregon share research facilities" ; "Harvard" : "Brown" : "Stanford" : "Yale" : "Vassar" : "UCLA" )
Пример 2. Возвращается пустая строка. @Keywords( "EPA Head speaks at Harvard,Yale" : "UCLA Chancellor Retires" : "Ohio State wins big game" : "Reed and University of Oregon share research facilities" ; "harvard" : "brown" : "stanford" : "vassar" : "ucla2" )
Пример 3. Возвращается "Yale". @Keywords( "EPA Head speaks at Harvard,Yale" : "UCLA Chancellor Retires" : "Ohio State wins big game" : "Reed and University of Oregon share research facilities"; "Harvard" : "Brown" : "Stanford" : "Yale" : "UCLA"; "," )
Пример 4. Возвращается пустая строка. @Keywords( "Mary Halen, Director of Sales" : "Sally Hall, VP of Marketing": "Joe Halzy, Order entry"; "Joe":"Sally";" ,")
Пример 5. Исправленный пример 4, возвращается "Joe". @Keywords( "Mary Halen, Director of Sales" : "Sally Hall, VP of Marketing": ",Joe Halzy, Order entry"; "Joe":"Sally";" ,")
ϑ @Compare( список_строк1; список_строк2 [; флаги] ) Область применения: нельзя использовать в формулах навигатора. Осуществляет попарное сравнение двух текстовых списков в соответствии с флагами. Если один из списков короче другого, то он дополняется значением его последнего элемента. Возвращаемое значение есть числовой список, каждый элемент которого определяется по следующему алгоритму:
•
0 - если соответствующие элементы списков эквивалентны с точки зрения флагов;
•
1 – если элемент первого списка больше второго;
•
(–1) – если второй список больше первого.
Флаги также представляют собой список, элементы которого могут принимать следующие значения:
•
•
•
[CASESENSITIVE] (значение по умолчанию) и [CASEINSENSITIVE] сравнение идет, соответственно, в режиме "чувствительном" или безразличном к регистру. Не допускается совместное использование обеих флагов; [ACCENTSENSITIVE] (значение по умолчанию) и [ACCENTINSENSITIVE] сравнение идет, соответственно, в режиме "чувствительном" или безразличном к диакритическим знакам (accent, диакритический знак - знак, который в ряде языков ставится над буквой, ниже буквы или “пересекает” букву для того, чтобы обозначить ее особое звучание). Не допускается совместное использование обеих флагов; [PITCHSENSITIVE] (значение по умолчанию) и [PITCHINSENSITIVE] сравнение идет, соответственно, в режиме "чувствительном" или безразличном к системе сортировки символов языка. Имеет смысл только для двухбайтовых кодировок восточных языков (таких как японский, корейский, упрощенный и классический китайский). Не допускается совместное использование обеих флагов.
Не совсем ясно, почему нельзя использовать эту функцию в контексте формул навигатора. Из опыта – она в них работает (правде, возможно не во всех случаях). Пример 1. Возвращается 0 : 0.
Пример 2. Возвращается так же 0 : (-1), т. к. "One" < " Two ". @Compare("One";"One":"Two"))
ϑ @Sort( список; флаги; формула ) Область применения: нельзя использовать в формулах навигатора. Функция осуществляет сортировку списка и возвращает отсортированный список. Функция может быть применена текстовым, дата/время и числовым спискам. Возвращаемое значение зависит от типа первого параметра функции. Флаги необязательный параметр, который задает порядок сортировки. Данный параметр может быть списком, элементы которого могут принимать одно из следующих значений:
• • • •
•
[Ascending] (значение по умолчанию) и [Descending] - для сортировки, соответственно, по возрастанию и убыванию. Не допускается совместное использование обеих флагов; [CaseSensitive] (значение по умолчанию) и [CaseInsensitive] для сортировки, соответственно, с учетом или без учета регистра. Не допускается совместное использование обеих флагов; [AccentSensitive] (значение по умолчанию) и [AccentInsensitive] для сортировки, соответственно, с учетом или без учета к диакритическим знакам. Не допускается совместное использование обеих флагов; [PitchSensitive] (значение по умолчанию) и [PitchInsensitive] для сортировки, соответственно, с учетом или без учета к системе сортировки символов языка. По поводу назначения предыдущих четырех флагов см. пояснения к функции @Compare стр. 108. Не допускается совместное использование обеих флагов; [CustomSort] в этом случае порядок сортировки определяется третьим параметром. Перекрывает действие любого другого флага.
При конфликте флагов, для определения действующего порядка сортировки будет использоваться последнее значение для взаимоисключающих значений. Например, если второй параметр функции определен как [Descending] : [PitchInsensitive] : [Ascending], то это реально соответствует флагу [PitchInsensitive] : [Ascending].
Параметр формула необязателен для всех случаев, за исключением использования флага [CustomSort]. В этом случае формула задает собственный порядок сортировки. В рамках формулы для генерации ссылок на сравниваемые элементы значений списка используются временные переменные $A и $B. Если по условиям сортировки необходимо чтобы элемент $A стоял в результирующем списке перед элементом $B, то формула должна вернуть 1 (True), для того чтобы $B стоял раньше $A формула должна вернуть 0 (False). Если формула вернет значение отличное от числового типа – генерируется сообщение об ошибке: «Incorrect data type for operator or @Function: Number expected» (Некорректный тип данных для оператора или @функции: ожидается число).
При сортировке значений элементов из списка типа дата-время, если элемент не содержит временную компоненту, то данный элемент эквивалентен любому элементу с той же датой и любым временным значением. Например, значения [12.12.2001], [12.12.2001 12:20:32] и [10.12.2001 – 01.01.2002] с точки зрения @Sort эквивалентны.
Если используется сортировка Unicode, то в рамках функции @Sort нельзя использовать следующие флаги и их комбинации:
•
[PITCHINSENSITIVE];
•
[CASESENSITIVE] : [ACCENTINSENSITIVE].
Подробнее о сортировка http://oss.software.ibm.com/icu/
Пример 3. Сортирует список следующим образом: сначала все нечетные числа в порядке возрастания, затем все четные числа в порядке возрастания. Возвращает окно с текстом «-15~7~7~21~4~6~6~12». a := 21 : 7 : 6 : (-15) : 12 : 6 : 4 : 7; b := @Sort(a; [CustomSort]; @If( @Modulo($A; 2) = 0; @If( @Modulo($B; 2) = 0; @If( $A >= $B ; 1; 0) ;1); @If( @Modulo($B; 2) = 0; 0; @if($A >= $B; 1; 0)) )); @Prompt([Ok]; "Sort list"; @Implode(@Text(b) ; "~"))
6.8 Работа с переменными окружения @Environment( переменная ) @Environment( список_переменных ) @Environment( переменная; значение ) @Environment( список_переменных; значение ) Область применения: нельзя использовать в формулах отбора, колонок, навигатора и Web-приложениях. Ограниченно применима в формулах всплывающих окон. Для присвоения переменным окружения значения при использовании в теле других функций (таких как @If или @Do) применяйте функцию @SetEnvironment. В формулах выполняющихся на сервере, например, в теле агента по расписанию, идет обращение к переменным окружения сервера, а не рабочей станции. Возвращаемое значение всегда есть текстовая строка. Устанавливает или возвращает значение переменной окружения. Переменные окружения хранятся в файле NOTES.INI (Windows, OS/2, UNIX) или Notes Preferences (Macintosh). Такой файл присутствует как на станции пользователя, так и на сервере. Ниже приведен фрагмент файла NOTES.INI, в
При использовании с одним параметром @Environment извлекает и возвращает текущее значение переменной окружения из файла NOTES.INI пользователя. Поскольку каждый пользователь имеет свой файл NOTES.INI, это значение может быть различным у каждого пользователя. Имя переменной задается как текстовая строка. Если в качестве параметра указан список имен переменных, возвращается список значений всех переменных из списка имен. При использовании с двумя параметрами @Environment позволяет присвоить значение переменной окружения в файле NOTES.INI пользователя. Значение должно быть либо текстовой строкой (например, "PO123"), либо формулой, возвращающей текст (например, @UserName или @Text( Total )). Если в качестве первого параметра ввести список имен переменных, каждой указанной в этом списке переменной будет присвоено заданное вторым параметром значение. Но если указать вторым параметром список значений, из него будет использовано только первое значение, а остальные будут игнорироваться. Функция возвращает ранее установленные значения указанных первым параметром переменных, или пусто, если эти переменные еще отсутствуют в файле NOTES.INI. @Environment предназначается для использования в формулах полей и форм, кнопок, кнопок панели инструментов и в агентах. Функцию удобно использовать для сохранения специфических установок пользователя, например, для последовательной нумерации документов, создаваемых каждым пользователем. Кроме того, эта функция дает способ передачи значений из одного агента в другой. Однако учтите, что максимальная длина значения переменной среды в файле NOTES.INI ограничена. Пример 1. Возвращает "8009", если таково значение переменной "OrderNumber" в файле NOTES.INI текущего пользователя. @Environment( "OrderNumber" )
Пример 2. Помещает переменную "OrderNumber" в файл NOTES.INI текущего пользователя и присваивает ей нулевое значение.
Пример 3. Демонстрирует механизм передачи параметров из одного агента в другой. Агент Set Group выводит диалоговое окно для выбора пользователем имени группы из первой колонки вида "Запросы\по группам". Полученное значение затем заносится в переменную окружения MacroTmp. После этого происходит запуск агента (Set Group Helper). Агент (Set Group Helper), в свою очередь, извлекает значение переменной MacroTmp из файла NOTES.INI и присваивает это значение полю Group для всех документов, удовлетворяющих критерию отбора агента. Агент Set Group выполняется однократно: GroupList:= @DbColumn( "":"NoCache"; ""; " Запросы\\По группам"; 1 ); Group:= @Prompt( [OKCancelEditCombo]; "Выберите группу"; "Выберите группу"; "Маркетинг"; GroupList ); Tmp1 := @Environment( "MacroTmp"; Group ); @PostedCommand( [ToolsRunMacro]; "(Set Group Helper)" );
Агент (Set Group Helper) выполняется согласно его критерию отбора: FIELD Group:= @Environment( "MacroTmp" );
@SetEnvironment( переменная; значение ) Область применения: нельзя использовать в формулах отбора, колонок, всплывающих окон и Web-приложениях. В формулах, выполняющихся на сервере, например, в теле агента по расписанию, идет обращение к переменным окружения сервера, а не рабочей станции. Возвращаемое значение всегда есть текстовая строка. Присваивает значение переменной среды в файле NOTES.INI (Windows, OS/2 или UNIX) или Notes Preferences (Macintosh) пользователя. Имеет тот же синтаксис и действует так же, как и @Environment( переменная; значение ).
6.9 Установка значения временной переменной ϑ @Set( переменная; значение ) Область применения: без ограничений. Присваивает значение временной переменной. Временная переменная определяется, существует и может использоваться только в пределах одной формулы. Имя переменной должно задаваться как текстовая строка.
В R 6 не требуется перед использованием @Set определить в формуле переменную. Для предыдущих версий (включая R5) это необходимо. Для определения переменной достаточно использовать ее в выражении присваивания, например, присвоить ей пустое значение в начале формулы: Имя_временной_переменной := "";
Пример. Формула проверяет, является ли поле FirstName пустым. Если да, то присваивает переменной FullName конкатенацию содержимого поля Title и поля LastName. Если же поле FirstName имеет непустое значение, переменной FullName присваивается конкатенация содержимого поля FirstName и поля LastName.
6.10 Функции для работы с текущим документом Достаточно большое количество @-функций производят операции с текущим документом (current document). В документации для этого термина дано следующее определение: текущий документ - это документ, который:
• 114
для акций форм, кнопок, гиперобъектов и формул полей - в настоящее время открыт;
для акций видов и папок - на нем стоит световой маркер; для агентов - в настоящее время обрабатывается агентом в соответствии с его алгоритмом и критерием отбора.
6.10.1 Определения свойств, характеристик и состояния текущего документа @Created Область применения: нельзя использовать в формулах навигатора. При использовании в формулах полей, возвращаемое значение определяется по часам сервера, если БД не является локальной. Функция "чувствительна" к часовому поясу. Возвращает время и дату создания документа. Пример 1. Возвращает [15.02 93 14:01:00] для документа, созданного 15 февраля 1993 г. в 14:01. @Created
Пример 2. Возвращает [04.08.93 13:10:00] для документа, созданного 4 апреля 1992 г. в 13:10. @Adjust( @Created; 1; 4; 0; 0; 0; 0)
@Modified Область применения: корректно работает только в формулах столбцов. Нельзя использовать в формулах навигатора, видимости объекта, формы, редактируемой секции, почтовых агентах и агентах, запускаемых по событию вставки документов из буфера обмена. При использовании в формулах вычисляемых и вычисляемых для показа полей, возвращает значение соответствующее предпоследнему, а не последнему времени модификации. Функция "чувствительна" к часовому поясу. Возвращает величину дата/время, показывающую, когда документ в последний раз редактировался и сохранялся.
Пример 1. Возвращает [30.9.92 11:00:00], если документ в последний раз сохранялся 30 сентября 1992 г. в 11:00. @Modified
Пример 2. Возвращает строку, составленную из содержимого поля Topic, пробела, текста "Последнее изменение: " и значения "дата-время" последнего сохранения документа, преобразованного в текст. Topic + " " + "Последнее изменение: " + @Text( @Modified )
@Accessed Область применения: нельзя использовать в формулах отбора и навигатора. Функция "чувствительна" к часовому поясу. Возвращает величину дата/время последнего доступа (для чтения или записи) к документу. Величина, возвращаемая @Accessed, указывает время последнего доступа к документу в данной реплике базы данных; каждая реплика хранит свое собственное значение для одного и того же документа. Эта величина "точна до дня" - при очередном обращении к документу в течение дня она не изменяется. @Accessed чаще всего используется в формулах полей, формулах отбора, акциях и агентах. Будьте осторожны, используя @Accessed в видах (в формулах колонок или формулах выбора), так как она форсирует обновление вида при каждом его открытии. Если БД хранится на CDROM, использование @Accessed не имеет смысла, т.к. доступ к базе для записи или чтения не контролируется Domino. Эта функция может быть полезна для определения, не "застрял" ли документ в процессе обработки. Например, Вы можете написать агент, который проверяет дату последнего доступа к документам, и напоминает о тех документах, к которым длительно не обращались. @Accessed также может использоваться в агенте для архивирования документов, к которым отсутствовал доступ на протяжении определенного периода времени. Пример. Возвращается [30.09.94 11:00:00], если документ последний раз прочитан или редактирован 30 сентября 1994 в 11:00. @Accessed
@Author Область применения: нельзя использовать в формулах навигатора. Возвращает текстовый список имен авторов текущего документа. Имена возвращаются в сокращенной, а не канонической форме. Для определения списка имен авторов используется следующий алгоритм:
• •
• • •
в документе ищется поле типа "Авторы", если оно одно возвращается его значение. Если таких полей несколько - возвращается значение первого из найденных полей этого типа; если поле типа "Авторы" не найдено, ищется поле с именем "From", и если оно найдено, то ищется поле "FromDomain". Если оба поля найдены, то возвращаемое значение есть объединение значений этих полей через символ "@". Например, Evgeny V. Polyakov/ITDept/Technics/CenterTV/RU@CenterTV . Если найдено только поле "From", то возвращается оно; если поле "From" не найдено, то ищется поле "$UpdatedBy". Если оно одно, то возвращается его значение; если поле "$UpdatedBy" не найдено, и документ является новым (еще ни разу не сохраненным), то возвращается имя текущего пользователя; если все предыдущие шаги закончились неудачей - возвращается пустая строка.
Пример. Возвращается Polyakov/ITDept/Technics/CenterTV/RU@CenterTV" отправляемых почтой автором этих строк.
"Evgeny для
V. документов,
@Author
@DocLength Область применения: нельзя использовать в формулах навигатора. Возвращает приблизительный размер "Приблизительность" определяется тем, что:
•
документа
в
байтах.
в расчет включаются только данные, введенные пользователем, не учитываются формулы и статичный текст;
размер базы данных всегда изменяется блоками по 64 байта, и документ не обязательно задействует целиком все блоки.
Так же результат работы функции может зависеть от того, открыт ли документ на чтение или редактирование (в этом случае он обычно занимает больше памяти), или закрыт (например, показывается в виде). Функция может быть использована для оценки заполнения базы данных и необходимости ее архивации.
ϑ @DocOmittedLength Область применения: нельзя использовать в формулах навигатора. Возвращает приблизительный размер “усеченной“ при репликации части документа в байтах. Все что было сказано про “приблизительность“ для @DocLength справедливо и для @DocOmittedLength. Пример. Для «усеченных» документов выводит диалоговое окно с размером «усеченных» данных. @If( @IsDocTruncated; @Prompt([Ok];"Предупреждение"; {Документ "усечен"} + @Char(13) + "Отсутствует порядка: " + @Text(@DocOmittedLength) + " байт"); "")
@Attachments Область применения: нельзя использовать в формулах навигатора. Возвращает число присоединенных файлов к документу. Часто применяется в формулах столбцов для отображения определенной пиктограммой наличие у документа присоединенных файлов. Пример. При использовании в формуле столбца, отображающего значения как пиктограммы, будет выдавать пиктограмму "скрепка" для документов имеющих присоединенные файлы. @If( @Attachments; 5; 0 )
ϑ @AttachmentModifiedTimes Область применения: нельзя использовать в формулах отбора, столбцов, секции с управляемым доступом, всплывающих окон и навигатора. Возвращает дату/время соответствующую дате/времени модификации присоединенного к документу файла. Если файлов несколько, то возвращается список значений типа дата/время. В этом случае порядок следования значений соответствует следованию имен этих файлов, возвращаемых функцией @AttachmentNames. Если у документа нет присоединенных файлов, то возвращается пустая строка. Пример. Формула примененная в акции формы вернет дату/время (или список) модификации присоединенного файла. @Prompt([Ok]; "Дата/время модификации"; @Implode(@Text(@AttachmentModifiedTimes); "~"))
@IsNewDoc Область применения: нельзя использовать в формулах навигатора. Корректно работает в формулах кнопок панели инструментов, кнопок, видимости абзацев, доступа к секции, заголовка окна, полей, формы и акций формы. При использовании в формулах столбцов, отбора документов, агентах и акциях видов всегда возвращает значение 0. Возвращает 1 (TRUE), если редактируемый документ еще не сохранялся на диске, или 0 (FALSE), если документ был сохранен.
Пример 1. Использованная в формуле заголовка окна, функция возвращает "Новый документ", если документ создается. Если документ вновь открыт после его сохранения, эта формула возвращает значение поля Subject. @If( @IsNewDoc; "Новый документ"; Subject )
Пример 2. Если создается новый документ, в заголовке окна появляется строка "Новые общие сведения". Если же открывается существующий документ, в заголовке окна появляется строка "Общие сведения о", затем содержимое поля EmpName, обратная косая черта и содержимое поля EmpNumber. @If( @IsNewDoc; "Новые общие сведения"; "Общие сведения о" + EmpName + "/" +EmpNumber )
@IsResponseDoc Область применения: нельзя использовать в формулах навигатора. Для документов, которые еще не разу не сохранялись на диске, всегда возвращает значение 0. Возвращает 1 (TRUE), если документ является документом-ответом (Response), в противном случае возвращает 0 (FALSE). Признаком документаответа является наличие в нем предопределенного поля $REF, содержащего универсальный идентификатор родительского документа. Документ-ответ может быть создан либо:
•
по форме типа
•
по форме, учитывающей отслеживания версий документов;
•
программным путем.
Response to document (Ответ на документ) to response (Ответ на ответ);
или Response
Пример. Возвращает "Ответ", если документ является документомответом; в противном случае возвращает "Тема". @If( @IsResponseDoc; "Ответ"; "Тема" )
@IsDocBeingEdited Область применения: нельзя использовать в формулах отбора, колонок, агентов, формы, акций вида и навигатора. Возвращает 1 (True), если текущий документ находится в режиме редактирования, иначе возвращает 0 (False). Пример. При использовании в формуле акции формы вернет окно со значением либо последнего редактора документа, либо текущего пользователя для документа в режиме редактирования. @Prompt( [OK]; "Информация"; "Последний редактор: " + @Name( [Abbreviate]; @If( @IsDocBeingEdited; @UserName; @Subset( $UpdatedBy; -1 ))))
@IsDocBeingRecalculated Область применения: предназначена для работы в формулах полей, может ограниченно использоваться в формулах кнопок панели инструментов, кнопок, гиперобъектов и акций формы. Возвращает 1 (TRUE), если в настоящее время текущий документ пересчитывается, в противном случае возвращает 0 (FALSE). Если Вы используете эту функцию для увеличения счетчика, учтите, что его содержимое будет увеличиваться на единицу при каждом пересчитывании пользователем полей в форме.
Пример 1. Возвращает 1 во время вычисления и пересчитывания документа. @IsDocBeingRecalculated
Пример 2. Возвращает 0 перед, и после вычисления и пересчитывания документа. @IsDocBeingRecalculated
Пример 3. Может использоваться в поле типа дата/время, чтобы при различных обстоятельствах показывать различные даты. Формула вызывает отображение текущих времени и даты во время пересчитывания документа; в противном случае отображается дата создания документа. @If( @IsDocBeingRecalculated; @Now; @Created )
@IsDocBeingLoaded Область применения: предназначена для использования только в формулах полей и формы. Возвращает 1 (TRUE), если текущий документ в настоящее время загружается в память для последующего отображения; в противном случае возвращает 0 (FALSE). Пример 1. Возвращает 1, когда документ загружается в память. @IsDocBeingLoaded
Пример 2. Возвращает 0, если документ был сохранен. @IsDocBeingLoaded
Пример 3. Формула для вычисляемого поля Editors. Вычисляемое поле Editors показывает содержимое поля $UpdatedBy, когда документ загружается.
Когда же пользователь пересчитывает поле (нажимая клавишу F9), вычисляемое поле Editors показывает имя пользователя как текущего редактора, а вслед за ним имена предыдущих редакторов. Наконец, когда документ сохраняется, значение в поле Editors остается без изменения. @If( @IsDocBeingLoaded; $UpdatedBy; @IsDocBeingRecalculated; ( "Текущий редактор -" + @UserName ) : $UpdatedBy; Editors )
@IsDocBeingSaved Область применения: предназначена для работы в формулах полей, может ограниченно использоваться в формулах кнопок панели инструментов, кнопок, гиперобъектов и акций формы. Возвращает 1 (TRUE), если в настоящее время текущий документ сохраняется, в противном случае возвращает 0 (FALSE). Если вы используете эту функцию для увеличения счетчика, учтите, что его содержимое будет увеличиваться на один при каждом сохранении документа пользователем. Пример 1. Возвращает 1 во время сохранения документа. @IsDocBeingSaved
Пример 2. Возвращает 0 перед или после сохранения документа. @IsDocBeingSaved
Пример 3. Эта формула возвращает "Администраторы" во время сохранения документа. В противном случае возвращает значение поля Readers. @If( @IsDocBeingSaved; "Администраторы"; Readers )
@IsDocBeingMailed Область применения: предназначена для работы в формулах полей, может ограниченно использоваться в формулах кнопок панели инструментов, кнопок, гиперобъектов и акций формы. В Web-приложениях не работает. Возвращает 1 (TRUE), если в настоящее время текущий документ отправляется почтой, в противном случае возвращает 0 (FALSE). Функция обычно используется для подсчета, сколько раз пользователь отправлял документ, включая пересылки. Может применяться также для изменения документа во время отправки. Например, во время отправки можно изменить форму документа. Пример 1. Возвращает 1, когда документ отправляется. @IsDocBeingMailed
Пример 2. Возвращает 0 перед и после отправления документа. @IsDocBeingMailed
Пример 3. Может использоваться как формула в поле для подсчета количества отправок документа. Если эта формула определяет вычисляемое поле TimesMailed, первоначально в поле устанавливается 0 (пока документ не отправлялся). Затем содержимое TimesMailed увеличивается при каждой отправке почтой, т.е. если документ был отправлен один раз, его содержимое становится равным 1, и далее увеличивается на 1 после каждой последующей отправки документа. @If( @IsUnavailable( @IsDocBeingMailed )
TimesMailed
);
0;
TimesMailed
+
@Responses Область применения: предназначена только для использования в формулах заголовка окна. Не работает в Web-приложениях. Возвращает количество ответных документов (response) на текущий документ в текущем виде. Пример 1. Возвращает 5, если имеется пять документов-ответов на текущий документ. @Responses
Пример 2. Возвращает строку "На этот документ нет ответных документов", если на текущий документ нет документов-ответов; в противном случае возвращает пустую строку. @If( @Responses = 0; "На этот документ нет ответных документов"; "" )
6.10.2 Операции с полями ϑ @SetField( поле; значение ) Область применения: нельзя использовать в формулах заголовка окна, отбора, колонок, видимости объекта, заголовка окна, всплывающих окон, формы, полей и навигатора. Присваивает значение полю в текущем документе. В R 6 не требуется перед использованием @SetField определить в формуле поле, если его не существует в документе. Для предыдущих версий (включая R5) это было необходимо, иначе при выполнении @SetField последует сообщение об ошибке. Поле существует, если оно определено в форме, по которой открыт документ. Если поля нет, его можно создать, используя имя поля в выражении присваивания с ключевым словом FIELD, например, указав в начале формулы: FIELD Имя_поля := Имя_поля;
Имя поля в @SetField должно задаваться как текстовая строка. Значение должно иметь тот же тип данных, что и поле. Пример. Формула проверяет значение в поле Priority. Если в нем содержится "низкий" или "средний", то в поле Status помещается "Закрыт". В противном случае в поле Status помещается "Открыт". Обратите внимание, что перед использованием поля Status в формуле @SetField это поле было определено с помощью ключевого слова FIELD. FIELD Status: = Status; @If( Priority = "низкий" | Priority = "средний"; @SetField( "Status"; "Закрыт" ); @SetField( "Status"; "Открыт" ) )
ϑ @ThisName Область применения: предназначена для применения в формулах полей. Возвращает имя текущего поля для текущего документа. В любых других контекстах, отличных от формул полей, возвращает пустую строку.
ϑ @ThisValue Область применения: предназначена для применения в формулах полей. Возвращает значение текущего поля для текущего документа. В любых других контекстах, отличных от формул полей, возвращает пустую строку. Функцию удобно использовать, например, в формулах проверки правильности введенных значений, особенно если эти поля совершенно однотипны, и копируются через буфер обмена. В этом случае не нужно даже «залезать» в редактор для этих формул.
Пример. Формула проверки правильности введенных значений поля Cost не нужно исправлять для поля Cost_1, полученного копированием из Cost через буфер обмена. @If( @IsNull(@ThisValue); @Failure("Цена не введена"); @ThisValue <= 0; @Failure("Цена не может быть отрицательной"); @Success)
ϑ @GetField( имя_поля ) Область применения: нельзя использовать в формулах заголовка окна и кнопок панели инструментов. Возвращает для текущего документа значение поля по его имени. Если указанное поле в текущем документе отсутствует, то возвращается пустая строка. Для полей, содержащих значение типа список, возвращается только первое значение из списка.
Данная функция совместно с @ThisValue и @ThisName может использоваться в рамках формул полей для создания переносимого (т.е. независимого от имени поля) кода.
Пример. Некая компания занимается продажей стульев трех типов. На форме заявки на покупку имеются редактируемые поля, отвечающие за цену (суффикс в имени поля "_Price") и количество (суффикс - "_Quantity"), а так же вычисляемые поля общей цены (суффикс - "_Total"). Тип стульев определяется префиксом в имени поля (например, FoldingChairs, StackingChairs, RecliningChairs). В этом случае поля формула поля общей цены будет одинакова для всех трех типов стульев, и имеет следующий вид: chairName := @Left(@ThisName; "_"); (@GetField(chairName + "_Quantity"))*(@GetField(chairName + "_Price"))
@DeleteField Область применения: нельзя использовать в формулах заголовка окна, отбора, колонок, формы и навигатора. Использованная в агенте, функция @DeleteField удаляет поле, которому присваивают возвращаемое функцией значение. @DeleteField наиболее часто применяется в фоновых и поисковых агентах. Работает и в кнопках формы, но только для полей, которые не были определены в форме статически. Пример. Удаляет обрабатываемого агентом.
поле
RoutingList
из
каждого
документа,
FIELD RoutingList := @DeleteField;
@Unavailable Область применения: нельзя использовать в формулах заголовка окна, отбора, колонок, формы, навигатора и видимости объекта. Аналогична по синтаксису и смыслу функции @DeleteField. Удаляет поле, которому присваивают возвращаемое функцией значение.
@DocFields Область применения: нельзя использовать в формулах отбора, колонок и навигатора. Возвращает текстовый список, содержащий имена всех полей в текущем документе. После того как документ сохранен, функция возвращает список всех полей документа, включая служебные (например, Form, $UpdatedBy и т.д.).
@IsAvailable( имя_поля ) @IsUnavailable( имя_поля ) Область применения: нельзя использовать в формулах навигатора. В формуле колонок и отбора может использоваться только с полями, имеющими флаг SUMMARY. Проверяют наличие в документе поля с указанным именем. @IsUnavailable( имя_поля ) тождественна равна отрицанию @IsAvailable( имя_поля ). Функция @IsAvailable возвращает 1 (TRUE), если поле содержится в документе, в противном случае 0 (FALSE). Обратите ВНИМАНИЕ!!!, что имя_поля не берется в кавычки, это достаточно распространенная ошибка для этих функций. Несколько слов о флаге SUMMARY. Наличие данного флага у поля сигнализирует о том, что значение этого поля может быть показано в виде или папке. При создании документа по форме без использования программного кода на LotusScript или Java, у полей типа Rich Text этот флаг не установлен, а у полей типа Text, Date/Time, Number и т.д. он установлен. Программным путем с использованием LotusScript или Java можно принудительно установить или изменить данный флаг. Посмотреть наличие или отсутствие данного флага у поля можно в окне свойств документа.
Рис. 6.3 Поле my_num имеет установленный флаг SUMMARY
Пример 1. Возвращает значение поля Dept, если оно имеется в документе. В противном случае возвращает "Консультант". @If( @IsAvailable( Dept ); Dept; "Консультант" )
Пример 2. Возвращает "Консультант", если нет поля Dept; если такое поле есть, возвращается значение, содержащееся в нем. @If( @IsUnavailable( Dept ); "Консультант"; Dept )
6.10.3 Операции с документом @UndeleteDocument Область применения: нельзя использовать в формулах отбора, колонок, видимости объекта, редактируемой секции, заголовка окна, всплывающих окон, полей, формы, навигатора и области размещения. В 5-ой версии Domino у базы данных появилось новое свойство "мягкая" отметка об удалении (soft deletion). В случае если оно установлено функция @UndeleteDocument снимает с текущего документа пометку о таком удалении.
Рис. 6.4 Окно свойств базы данных с отметкой о разрешении "мягких" отметок об удалении (Allow soft deletions) Для того чтобы «увидеть» документы со свойством «мягких» отметок об удалении, необходимо создать вид, имеющий тип «Shared, contains deleted documents» (Общий, содержащий удаленные документы).
Рис. 6.5 Вид, содержащий «мягко» удаленные документы Пример. Формула агента восстанавливает документы, у которых в поле Subject присутствует строка "Hello". @If( @Contains( Subject; "Hello" ); @UndeleteDocument; "" )
@DeleteDocument Область применения: разрешается использовать только в формулах агентов. В Web-приложениях не работает. Функция @DeleteDocument удаляет или ставит "мягкую" отметку об удалении для документа, обрабатываемого агентом. Что конкретно делает функция (удаляет или ставит "мягкую" отметку об удалении) определяется одноименным свойством текущей базы данных.
@DeleteDocument наиболее часто применяется в фоновых и поисковых агентах. Для пометки документа на удаление из формул акций и кнопок панели инструментов используйте функцию @Command( [EditClear] ). Пример. Удаляет только те документы, поле Status которых содержит "Closed". FIELD Status );
Status
:=
@If(
Status
=
"Closed";
@DeleteDocument;
@HardDeleteDocument Область применения: в DOMINO R 6.0.1 ДОКУМЕНТИРОВАНА НЕ ПОЛНОСТЬЮ. Предназначена для использования только в формулах агентов. Не работает в Web-приложениях. Немедленно удаляет документ из базы данных, в отличие от функций @DeleteDocument и @UndeleteDocument, которые имеют возможность работать с "мягкими" отметками об удалении документов.
ϑ @DocLock( флаги ) Область применения: нельзя использовать в формулах отбора, колонок, полей, формы и навигатора. Не работает в Web-приложениях. В 6-ой версии Domino появился новый механизм позволяющий осуществлять блокировку/разблокировку как документов пользователей, так и элементов дизайна. Для того чтобы БД могла поддерживать блокировку документов пользователя необходимо определить для БД основной блокирующий сервер (Master Lock Server), а также поднять флаг Allow document locking в окне свойств БД. Первое достигается в ACL БД на закладке Advanced. Обратите внимание, что Master Lock Server совпадает с административным сервером для БД (Administration server):
Рис. 6.6 Закладка Advanced ACL БД с установленным значением для Master Lock Server После установки для БД блокирующего сервера для возможности блокировки необходимо еще поднять флаг Allow document locking, который расположен на закладке Database Basics окна свойств БД.
Рис. 6.7 Закладка Database Basics окна свойств БД с поднятым флагом Allow document locking После выполнения указанных действий можно осуществлять блокировку/разблокировку документов пользователей. На уровне интерфейса клиента Lotus в виде или папке это достигается использованием меню Action -> Lock Document и Action -> Unlock Document. С точки зрения функциональности блокировка осуществляет добавление в документ двух служебных полей:
•
$Writers – кто выполнил блокировку;
•
$WritersDate – дата/время осуществления блокировки. Разблокировка соответственно удаляет эти поля из документа.
Функция @DocLock позволяет оперировать с механизмом блокировок на программном уровне в рамках языка @-формул. В качестве флагов допускает использовать следующие значения:
[STATUS] – возвращает текстовый список пользователей, заблокировавших текущий документ, или пустую строку в противном случае; [LOCKINGENABLED] – возвращает 1 (@True) если в БД включена поддержка механизма блокировки, и 0 (@False) в противном случае.
Попытка использования функции @DocLock с флагами [LOCK], [UNLOCK] и [STATUS] над БД с опущенным флагом Allow document locking приводит к предупреждающему окну с текстом «Attempted a lock operation on a DB that doesn't support locking» (попытка выполнения операции блокировки над БД, которая не поддерживает механизм блокировки). Для тех же флагов документ должен находиться в режиме чтения (но не редактирования) или быть текущим на уровне вида/папки. В противном случае выдается предупреждающее окно с текстом «@Function is not valid in this context» (@-функция недопустима в данном контексте). Кроме этого применение флага @DocLock [LOCK] над ранее уже заблокированными документами также приводит к предупреждающему окну либо с текстом «You already have the document locked» («Вы уже заблокировали данный документ» - если данный документ был ранее заблокирован Вами), либо «The document is already locked by someone else» («Документ уже заблокирован кем-то еще» - при предшествующей блокировке другим пользователем). Разблокировка ранее заблокированного документа доступна либо пользователю, выполнившею её, либо пользователю с уровнем доступа Менеджер по ACL. В противном случае получаем предупреждающее окно с текстом «The document is not locked by you» (данный документ не был заблокирован Вами). Пример. Формула, используемая в акции вида, сначала проверяет поднят ли у БД флаг Allow document locking. Далее проверяет, не заблокирован ли уже текущий документ, и если нет – то блокирует его. @If( !@DocLock([LockingEnabled]); @Prompt([Ok];"Предупреждение"; поддерживает механизм блокировок");
@AddToFolder( имя_папки_1; имя_папки_2 ) Область применения: разрешается использование в формулах кнопок панели инструментов, кнопок и гиперобъектов, акций формы и видов, а так же агентов. Не работает для еще не сохраненных на диске документов. Выполняет сразу до двух действий. Добавляет текущий документ в папку с именем, содержащимся в первом аргументе, удаляя при этом тот же документ из папки, имя которой находится во втором аргументе. Если пустая строка выступает в качестве:
•
первого аргумента, то не осуществляется добавления в папку;
•
второго аргумента - соответственно, удаления из папки;
•
двух аргументов - не выполняются ни какие действия. Пример 1. Формула добавляет текущий документ в папку с именем
"Work" @AddToFolder( "Work"; "" )
Пример 2. Формула добавляет текущий документ в папку с именем "Moscow", удаляя его при этом из папки "Washington" @AddToFolder( "Moscow"; "Washington" )
Пример 3. Формула удаляет текущий документ из папки с именем "Washington" @AddToFolder( ""; "Washington" )
ϑ @GetFocusTable( флаг ) Область применения: разрешается использовать только в формулах кнопок панели инструментов, акций формы и полей. Не работает в Web-приложениях. Документ должен находиться либо в режиме редактирования, либо чтения, в этом случае текст или входящий в таблицу объект должен быть выделен. Возвращает в зависимости от флага либо номер текущей строки, либо номер колонки, либо программное имя таблицы. Флаг может принимать одно из следующих значений:
[CellRow] – в этом случае возвращается номер текущей строки таблицы. Первая строка имеет номер "1". Если таблица не в фокусе – возвращается "0"; [CellColumn] – возвращает номер текущей колонки таблицы. Первая колонка имеет номер "1". Если таблица не в фокусе – возвращается "0". Когда фокус находится на закладке табулированной таблицы, то использование данного флага приводит к возвращаемому значению - "0"; [TableName] – возвращает имя таблицы, определенное в свойствах таблицы в поле Name/Id на последней закладке свойств. Если таблица не в фокусе или значение поля не определено – возвращается пустая строка.
Рис. 6.8 Определение имени таблицы в ее окне свойств В R 6.0.1 функция корректно работает только в обработчике события onHelp. В остальных контекстах (автор разумеется не проверял все) не зависимо от флагов функция возвращает 1, как число (а не текст).
Пример. Формула, примененная в обработчике события onHelp, вернет номера текущих позиций по строке и колонке, а также программное имя таблицы. row := @GetFocusTable([CELLROW]); @If(row = "0"; @Prompt([OK]; "*No table*"; "Not in a table"); @Do( column := @GetFocusTable([CELLCOLUMN]); name0 := @GetFocusTable([TABLENAME]); name := @If(name0 = ""; "No name"; name0); @Prompt([OK]; "*" + name + "*"; "Row " + row + ", column " + column)))
6.11 Функции для работы с паролями @Password( строка ) Область применения: без ограничений. Функция обычно используется в формулах преобразования значения полей (input translation formula) для шифрования пользовательского пароля перед показом его другим пользователям. В Lotus Notes не существует встроенных возможностей для обратного декодирования строки, полученной с помощью @Password в исходную. Пример. Возвращает (355E98E7C7B59BD810ED845AD0FD2FC4) @Password( "password" );
ϑ @HashPassword( строка ) Область применения: без ограничений. Функция осуществляет хеш кодирование строки. Данный алгоритм кодирования более стойкий, чем у функции @Password. Тем более что в R 6 некоторые документы Person содержат предопределенное поле $SecurePassword, значение которого есть хеш-пароль, полученный по алгоритму @HashPassword. Обратите внимание, что при одном и том же значении параметра возвращаемые функцией результаты могут отличаться.
Пример. Функция может вернуть «(GAEpkbr7HULl78FvDlH7)». @HashPassword( "password" );
ϑ @VerifyPassword( пароль1; пароль2 ) Область применения: В DOMINO ДОКУМЕНТИРОВАНА.
R
6.0.1
НЕ
Сравнивает два пароля, и возвращает 1 (TRUE), если пароли эквивалентны, и 0 (FALSE) в противном случае. В качестве аргументов функции могут использоваться значения, возвращаемые @Password и @HashPassword. Обратите ВНИМАНИЕ!!!, что параметры пароль1 и пароль2 не равнозначны с точки зрения смысла. В пароле1 должен присутствовать незашифрованный пароль, а в пароле2 – зашифрованный. Изменение порядка следования параметров вызывает возврат функцией значения 0 (FALSE). Данная информация отсутствует в Help. Пример 1. Вернет 1. @VerifyPassword( "password"; @Password( "password" ))
Пример 2. Вернет 1. @VerifyPassword( "password"; @HashPassword( "password" ))
Пример 3. Вернет 0. @VerifyPassword( "password"; @HashPassword( "Password" ))
Пример 4. Демонстрирует неравнозначность параметров функции, которая вернет значение 0. @VerifyPassword(@HashPassword( "password" ); "password")
@PasswordQuality( имя_поля ) Область применения: без ограничений. Функция работает в Web-приложениях. Вычисляет и возвращает в виде числа уровень сложности пароля для расшифровки. В документации достаточно бедно описана эта функция. В частности, не сказано даже как задавать имя_поля в виде литерала, или просто имени. Из опыта получается, что верен второй путь. Параметр имя_поля задает имя поля с типом данные “пароль” (Password). Более высокое возвращаемое значение указывает на большую сложность для расшифровки. Опять же из опыта, функция работает и для полей с другими типами данных, а так же и с текстовыми литералами.
Пример. Если в поле my_pass хранится значение (355E98E7C7B59BD810ED845AD0FD2FC4), то функция вернет значение 51. @PasswordQuality( my_pass );
6.12 Функции для работы с почтой @MailSend @MailSend( "кому"; "копия"; "слепая_копия"; "тема"; "заметка"; "список_имен_полей"; [список_флагов] ) Область применения: нельзя использовать в формулах отбора, колонок, видимости объекта, заголовка окна и всплывающих окон. Не работает при установке переменной окружения NoExternalApps равной 1. В Web-приложениях не работают флаги [Encrypt] и [Sign].. @MailSend в варианте без параметров отправляет текущий документ получателю, указанному в поле SendTo (кому) документа. Для этого требуется наличие в документе поля SendTo. Документ может содержать еще одно или несколько полей, имеющих отношение к почте. Если документ содержит поля СopyTo (копия) или BlindCopyTo ("слепая" копия), то он отправляется также получателям, указанным в этих полях. Если документ содержит поля DeliveryPriority, DeliveryReport или ReturnReceipt, они используются для управления приоритетом доставки, возвратом уведомления о доставке и уведомления о прочтении. Если документ не содержит этих полей, по умолчанию будет установлен нормальный приоритет и отсутствие уведомлений. @MailSend (без параметров) наиболее удобна для реализации пересылки документа из произвольной базы в другую произвольную базу. При этом база-получатель должна быть базой, способной получать почту (для нее в общей адресной книге должен быть создан документ MailIn - Database). Если указан один или более параметров, @MailSend создает новое почтовое сообщение, основываясь на информации из списка параметров, и отправляет его получателям, указанным параметрами "кому", "копия", "слепая_копия". Все параметры, кроме "кому", являются дополнительными и могут быть пропущены или заменены пустой строкой "". Параметры "кому", "копия", "слепая_копия" определяют первичных получателей, получателей копии и "слепой" копии. Эти параметры являются текстовыми списками: можно указать имена полей, содержащих адреса получателей, или явно задать списки имен получателей. Параметр "тема" дает значение для поля Subject в создаваемом почтовом сообщении. Заданное Вами значение параметра будет отображаться в
колонке Subject папки почтовой базы получателя. Этот параметр является текстовой строкой: можно указать как имя поля, содержащего краткую информацию о сообщении, так и саму эту информацию, как текстовую строку. Параметр "заметка" задает текст, вставляемый в самое начало тела сообщения (поля Body). Этот параметр является текстовой строкой. Параметр "список_имен_полей" задает список имен полей, информация из которых должна выбираться функцией и добавляться в тело создаваемого сообщения (в поле Body) вслед за "заметкой". Порядок добавления информации в тело сообщения совпадает с порядком задания имен полей в списке. Имена полей в списке, если они не находятся в переменной, должны заключаться в кавычки. Если в документе присутствуют Rich Text поля, то перед отправкой их значений по почте документ должен быть сохранен. В документации про Rich Text поля в контексте функции @MailSend еще сказано, что при использовании ее с параметрами только одно Rich Text поле может быть использовано в рамках аргумента список_имен_полей, и только в агенте. Из опыта можно сказать, что такую конструкцию можно использовать не только в агенте (например, в формуле кнопки, но предварительно сохранить документ), и Rich Text полей в список_имен_полей может быть больше одного, только в этом случае из второго и последующих в письмо передается только информация plain text. И, наконец, последним параметром можно указать список необходимых флагов, например: [Sign]: [PriorityHigh]: [ReturnReceipt] или [IncludeDocLink]. Ниже дан перечень доступных флагов:
• •
• • •
[Sign] - сообщение должно быть "подписано". Если флаг не указан, сообщение не будет подписано; [Encrypt] - тело сообщения должно быть зашифровано открытым ключом получателя (так что только получатель с соответствующим секретным ключом может прочитать тело сообщения). Если флаг не указан, тело сообщения не шифруется; [PriorityHigh] - сообщение должно иметь высокий приоритет доставки; [PriorityNormal] - сообщение приоритет доставки;
должно
иметь
нормальный
(средний)
[PriorityLow] - сообщение должно иметь низкий приоритет доставки. Вы должны выбрать один из трех возможных флагов приоритета. Если не указан ни один из флагов приоритета, сообщение будет иметь средний приоритет;
[ReturnReceipt] - в момент прочтения каждым получателем этого сообщения на адрес отправителя автоматически должно высылаться уведомление о прочтении. Если не указать этот флаг, уведомление не будут высылаться; [DeliveryReportConfirmed] - в момент доставки сообщения в почтовый ящик получателя на адрес отправителя, автоматически должно высылаться уведомление о доставке. Если флаг не указан, отправитель не получает уведомление о доставке, когда сообщение было доставлено, но будет получить уведомление о недоставке, если сообщение не было доставлено; [IncludeDocLink] - требует добавить в тело сообщения ссылку (Doclink) на документ, который был открыт или выбран во время выполнения функции @MailSend. Если флаг не указан, никаких ссылок в тело сообщения не вставляется. Перед применением этого флага следует не зыбывать сохранить документ, иначе ссылка может вести в «никуда».
Относительно применения функции @MailSend в Web-приложениях информация достаточно противоречива. В документе о самой функции @MailSend в контексте Web упоминается только про флаги [SIGN] и [ENCRYPT], которые в Web соответственно не работают, однако в документе «Domino @functions that are not supported on the Web» (@-функции не поддерживаемые в Web-приложениях) @MailSend упомянута как функция, не поддерживаемая в Web-приложениях. Из опыта можно сказать, что @MailSend в R 6 работает в Web-приложениях при условии поднятия у БД флага: Web Access: Use JavaScript when generation pages. В этом случае по умолчанию (т.е. без использования поля Principal) письмо отправляется за подписью сервера. Пример 1. В форме имеется поле SendTo и ряд других "проблемноориентированных" полей. В документе, созданном по этой форме, в поле SendTo заносится адрес базы, способной получать почту, например, "Mail Report's Database". Кнопка акции вида запускает агент, работающий по отмеченным документам. Этот агент отправляет почтой все отмеченные в виде документы в базу с адресом "Mail Report's Database". В документах, "пришедших почтой в Report's Database", будут содержаться все те поля, которые были в отправленных документах, плюс еще несколько предопределенных полей, содержащих информацию о самом процессе доставки. А вот и полный текст этого агента. @MailSend
Пример 2. Отправляет сообщение Vladimir A. Panov/InterTrustCorp/SU и "слепую копию" Nikolay N. Iontsev/InterTrustCorp/SU. Сообщение называется "Отчет" и содержит фразу "Прошу извинить за задержку", а также содержимое полей STATUS и PLANS из текущего документа. Сообщение будет отправлено со следующими опциями: подпись, уведомление о доставке и уведомление о вручении (о прочтении каждым пользователем). Параметр "копия" не используется и заменен пустой строкой, т.к. за ним следуют другие параметры. @MailSend( "Vladimir A. Panov/InterTrustCorp/SU"; ""; "Nikolay N. Iontsev/InterTrustCorp/SU"; "Отчет";
Пример 3. Отправляет сообщение двум получателям. Для параметра "тема" использован текст из поля TOPIC, а текст сообщения берется из поля COMMENTS текущего документа (открытого в рабочем пространстве отправителя или обрабатываемого агентом). Параметры "копия", "слепая копия" и "заметка" пропущены и заменены пустой строкой, т.к. за ним следуют другие параметры. Флаги пропущены, но, поскольку после них нет других параметров, не требуется заменять их пустой строкой. Подобный вариант @MailSend особенно удобно использовать в фоновых агентах как средство автоматической отправки почты с заданным интервалом, например, напоминаний о предстоящем собрании. @MailSend( "Nikolay N. Iontsev/InterTrustCorp/SU": "Vladimir A. Panov/InterTrustCorp/SU"; ""; ""; TOPIC; ""; "COMMENTS")
Пример 4. Сохраняет документ и отправляет его по почте одному получателю. Получатель обнаружит в поле темы сообщения текст "Ознакомьтесь с этим документом", а в поле тела сообщения ссылку на этот документ. Когда получатель выполнит двойной щелчок мышью "по ссылке на документ", Domino предпримет попытку открыть этот документ. Успех попытки будет зависеть от доступности со станции получателя базы, содержащей документ. @Command( [FileSave] ); @MailSend( "Andre A. Linev/InterTrustCorp/SU"; ""; ""; "Ознакомьтесь с этим документом"; ""; ""; [IncludeDocLink] )
@OptimizeMailAddress( "почтовый_адрес" ) Область применения: нельзя использовать в формулах отбора, колонок, заголовка окна и формы. Функция удаляет из "почтового_адреса" все повторяющиеся в нем домены. Удаляются все домены, находящиеся между повторяющимися доменами, включая сам повторяющийся домен. Пример. Возвращает Polyakov/ITDept/Technic/Center_TV/RU@Center_TV"
@ValidateInternetAddress( [флаг]; "почтовый_адрес" ) Область применения: В DOMINO R 6.0.1 НЕ ДОКУМЕНТИРОВАНА.. Работает в формулах проверки значения полей и в формулах вычисляемых полей. Функция проверяет "почтовый_адрес" на соответствие его стандартам RFC 822 или RFC 821. В случае если адрес соответствует стандартам, возвращается пустая строка, в противном случае генерируется сообщение об ошибке. Параметр [флаг], может принимать одно из двух значений, либо [Address822] - для стандарта RFC 822, либо [Address821] - для стандарта RFC 821.
"Invalid Input Parameter." - недопустимое значение входного параметра; "Invalid LocalPart or character found." - обнаружено недопустимое значение для локальной части [Local Part] (часть адреса до домена) адреса по формату RFC822, или недопустимый символ; "Invalid or missing Domain." - недопустимый формат для домена или он пропущен; "Invalid RFC821 syntax, no Phrase required." - недопустимый формат адреса по формату RFC821, часть [Phrase Part] (часть адреса собственно до адреса по формату RFC822) не должна присутствовать; "Invalid Phrase or character found." - недопустимое значение для [Phrase Part] части адреса или недопустимый символ; "Invalid Quoted String or mismatched quotes found." - недопустимая строка в кавычках, или смешение типов кавычек; "Invalid comment or mismatched parenthesis found." - недопустимые встроенные комментарии, или строка в скобках.
Обратите ВНИМАНИЕ!!!, что многобайтовая кодировка символов (или символы с кодами свыше 128) допускаются только в PHRASE части адреса в формате RFC 822. Так же не поддерживается синтаксис, когда несколько адресов объединены в группу (например, Customer). Пример 1. Возвращает пустую строку. @ValidateInternetAddress( [Address821]; "[email protected]" )
Пример 2. Возвращает сообщение об ошибке "Invalid or Missing Domain.", если в поле From содержится значение "Alexander M. Sizov" <[email protected]> @ValidateInternetAddress( [Address822]; From )
6.12.1 Функции, определяющие почтовые настройки Эти функции позволяют определить текущие почтовые настройки пользователя. Почтовые настройки определяются пользователем в документах Locations из личной адресной книги и выбираются при смене текущего местоположения, а также, общие для всех местоположений, выбираются в окне, получаемом из меню по File -> User Preferences -> Preferences.
@MailDbName Область применения: нельзя использовать в формулах колонок. В Web-приложениях не работает. Функция @MailDbName возвращает двухэлементный текстовый список формата "сервер": "файл_почтового_ящика", соответствующий текущему размещению почтового ящика пользователя. Первый элемент списка может быть пустой строкой, если почтовый ящик размещен локально, или функция используется в агенте по расписанию, выполняющемуся на сервере. Вообще говоря, в контексте выполнения функции @MailDbName на стороне сервера, последний (т.е. сервер) воспринимается как текущий пользователь, а так как у сервера нет своего почтового ящика, то возвращается список из двух пустых строк.
@Domain Область применения: нельзя использовать в формулах навигатора. При выполнении на сервере возвращает домен сервера. В Web-приложениях не работает. Возвращает имя домена для текущего пользователя из личной адресной книги, в соответствии с текущим местом вызова. Функцию удобно использовать в формулах, оперирующих почтовыми адресами. Пример 1. Возвращает "InterTrustCorp", если текущий пользователь принадлежит к домену "InterTrustCorp" в соответствии со своей личной адресной книгой и текущим местом вызова. @Domain
Пример 2. Если в списке CopyTo содержится почтовый адрес текущего пользователя, он будет заменяться пустой строкой, а функция @Trim будет устранять пустые строки из списка, что в итоге приведет к удалению имени текущего пользователя из поля CopyTo. FIELD CopyTo := @Trim( @Replace( CopyTo; @UserName + " @ " + @Domain ); "" ));
@MailSavePreference @MailSignPreference @MailEncryptSentPreference @MailEncryptSavedPreference Область применения: нельзя использовать в формулах отбора, колонок. В Web-приложениях не работают. Функция @MailSavePreference возвращает:
• • •
0, если в общих почтовых настройках в выпадающем списке с заголовком "Save mail that yoy send" выбрано "Don't keep a copy" (не сохранять копию); 1, если выбрано "Always keep a copy" (всегда сохранять копию); 2, если выбрано "Always prompt" (всегда выводить окно, позволяющее конкретно разрешить вопрос о сохранении).
Функция @MailSignPreference возвращает 1 (TRUE), если в общих почтовых настройках отмечена опция "Sign mail that you send" ("подписывать" отправляемую почту), и 0 (FALSE) в противном случае. Функция @MailEncryptSentPreference возвращает 1 (TRUE), если в общих почтовых настройках отмечена опция "Encrypt mail that you send" (шифровать отправляемую почту), и 0 (FALSE) в противном случае.
Функция @MailEncryptSavedPreference возвращает 1 (TRUE), если в общих почтовых настройках отмечена опция "Encrypt saved copy of mail that you send" (шифровать сохраняемую в почтовом ящике копию почтового сообщения), и 0 (FALSE) в противном случае.
ϑ @GetAddressBooks( флаги ) Область применения: нельзя использовать в формулах отбора и колонок. Возвращает список адресных книг ассоциированных с клиентом (если формула выполняется в локальной БД), или с сервером – для серверных БД. Флаги являются необязательными параметрами функции, и могут принимать следующие значения:
•
[TITLES] – возвращает вместо имени файла(ов) адресных книг их заголовки;
•
[FIRSTONLY] – возвращает только первую адресную книгу.
Если параметры не указаны, то должно возвращаться имена файлов всех адресных книг. В документации сказано, что для релиза M10 Lotus Domino Designer 6 (скорее всего, имеется ввиду пререлиз R 6) необходимо использовать хотя бы один из флагов, и для флага [TITLES] все равно возвращается имя файла, а не его заголовок. Из опыта (Designer 6.0.1, ОС – Windows 2000) формула не сохраняется без использования флагов, и как в серверном, так и в локальном варианте возвращается только имя файла первой адресной книги.
6.13 Работа с идентификаторами документов @DocumentUniqueID Область применения: нельзя использовать в формулах навигатора. В формулах полей создает ссылку (DocLink) на текущий документ. Возвращает так называемый универсальный идентификатор документа (UNID) - 32-x символьную комбинацию букв и цифр, уникально идентифицирующую текущий документ во всех репликах распределенной базы.
Рис. 6.10 Окно свойств документа Универсальный идентификатор документа можно "увидеть" в окне свойств документа в первой строке после метки "ID:", отбросив символы OF "в начале" и ON "в середине": 0DDA10781333857EC3256776006BB487. Domino генерирует универсальный идентификатор при создании документа. Первые его 16 символов (8 байт) представляют собой дату-время создания документа с точностью до тиков, а вторые 16 символов - случайное число. Domino, тем не менее, проверяет, не оказалось ли в текущей реплике базы документа (или "окурка") с таким же идентификатором, и, если так случилось, снова случайно генерирует вторые 16 символов. После сохранения документа в базе его универсальный идентификатор не меняется. Исключение составляют случаи, когда документ копируется в базу через буфер обмена или пересылается почтой - перед помещением документа в базу проверяется, не существует ли в ней уже документ с таким же универсальным идентификатором, и, если это так, для добавляемого в базу документа генерируется новый универсальный идентификатор. С помощью LotusScript разработчик имеет возможность самостоятельно изменить UNID документа. Правда, в этом случае ему необходимо самому заботиться об уникальности UNID. Вторая и третья строки после метки "ID:" содержат информацию, специфическую в каждой реплике распределенной базы. Многие понятия и алгоритмы Domino, в частности "дерево" документовответов, базируются на универсальных идентификаторах документов. Так, документ-ответ всегда содержит предопределенное поле с именем $Ref, в котором хранится универсальный идентификатор документа-родителя для данного документа-ответа. Пример 1. Формула столбца вида "выводит" в этом столбце для некоторого документа нечто похожее на FF863D8AAB6E2210852561BD005867C7. @Text( @DocumentUniqueID )
Пример 2. Формула в вычисляемом поле "создает" ссылку (DoсLink) на этот же документ. @DocumentUniqueID
@InheritedDocumentUniqueID Область применения: нельзя использовать в формулах навигатора. Предназначено для работы с документами, созданными по форме с включенной опцией наследования полей. Если опция не включена, возвращает такое же значение, что и @DocumentUniqueID. В формулах полей создает ссылку (DocLink) на указанный документ. Возвращает универсальный идентификатор документа, который был текущим в момент создания документа, в котором используется эта функция.
@NoteID Область применения: нельзя использовать в формулах формы и навигатора. Возвращает 8-и символьный идентификатор документа в базе - строку с префиксом NT, например, "NT000023DA". NoteID "уникально идентифицирует" документ только в данной базе.
@GetDocField( UNID ; имя_поля ) Область применения: нельзя использовать в формулах отбора, колонок, всплывающих окон и навигатора. Для текущей БД возвращает значение поля с именем имя_поля из документа, имеющего универсальный идентификатор UNID. Параметр имя_поля является строкой (например, имя поля в кавычках). Возвращаемое значение зависит от типа поля: строка или список строк, число или список чисел, время-дата или временной диапазон. Если задан несуществующий UNID, или поле, которого нет в наличие, то возвращается пустая строка. Из личного опыта, если при вызове функции в главном окне клиента Notes R 6.0.1 открыта страница рабочего пространства, то такая операция приводит к «падению» клиента с окном NCD. В 5-х версиях при аналогичных условиях падения клиента не было.
Пример 1. Вычисляемое поле в документе, являющемся ответом на главный документ, всегда будет содержать значение поля Subject из главного документа. Когда создается новый документ-ответ, значение в вычисляемом поле наследуется из главного документа. Впоследствии в вычисляемом поле появляется значение поля Subject из главного документа (даже если оно меняется в главном документе). Предопределенное поле $Ref содержится в каждом документе-ответе. Его значение - универсальный идентификатор главного документа. @If( @IsNewDoc; Subject; @GetDocField( $Ref; "Subject" ))
Пример 2. Формула, выполняемого по расписанию агента, меняет в документах-ответах значение поля Project на значение одноименного поля из главного документа. FIELD Project := @GetDocField( $Ref; "Project" ); @All
Пример 3. В базе People есть вид Fio со скрытой третьей колонкой с формулой @Text( @DocumentUniqueID ). Находясь в текущем документе, мы выбираем из вида Fio документ, соответствующий конкретному человеку, и заполняем аналогичные поля в текущем документе. ch := @PickList( [Custom] ; "" : "People" ; "Fio" ; "Выбор сотрудника" ; "Выберите сотрудника, отвечающего за заказ" ; 3); @SetField( "Fio" ; @GetDocField( ch ; "Fio" )); @SetField( "Phone" ; @GetDocField( ch ; "Phone" )); @SetField( "Email" ; @GetDocField( ch ; "Email" ));
ϑ @SetDocField( UNID ; имя_поля ; новое_значение ) Область применения: нельзя использовать в формулах отбора, колонок, всплывающих окон и навигатора. Для текущей БД присваивает новое значение полю с именем имя_поля в документе с универсальным идентификатором UNID. Параметр имя_поля является строкой. Параметр новое_значение должен соответствовать типу поля. В R 6 снято ограничение на возможность применения данной функции к текущему документу. Из личного опыта, если при вызове функции в главном окне клиента Notes R 6.0.1 открыта страница рабочего пространства, то такая операция приводит к «падению» клиента с окном NCD. В 5-х версиях при аналогичных условиях падения клиента не было.
Функция @SetDocField наиболее часто используется в формулах полей, кнопок и агентов. Пример 1. Формула кнопки в документе-ответе изменяет значение поля Subject в главном документе. @SetDocField( bicycle" )
$Ref; "Subject"; "More people are commuting by
Пример 2. Формула проверки ввода редактируемого поля lastAction в документе-ответе "попутно" заменяет значение поля latestStatus в главном документе. @SetDocField( $Ref; "latestStatus"; lastAction ); lastAction
6.14 Получение информации из баз данных Domino 6.14.1 @DbColumn - выбор значений из колонки ϑ @DbColumn( "класс": "тип_кеша"; "сервер": "база_данных"; "вид"; колонка ) Область применения: нельзя использовать в формулах отбора и колонок. Ограниченно применима в формулах всплывающих окон. Возвращаемое значение не должно превышать 64 Кбайта. Не работает при установке переменной окружения NoExternalApps равной 1. Находит и возвращает колонку значений из вида или папки в текущей базе или другой базе данных Domino. Если значений несколько, они возвращаются как список. Основным назначением @DbColumn являются формулы ключевых слов. @DbColumn позволяет динамически извлекать список значений из вида базы данных вместо задания фиксированного списка ключевых слов с его последующим обновлением путем редактирования формы, содержащей поле с ключевыми словами. @DbColumn может возвращать не более 64 Kб данных. Для определения количества элементов данных, которые могут быть возвращены @DbСolumn, используются следующие соотношения:
если возвращается текст: 2 + (2 * количество возвращаемых записей) + общий размер текста во всех элементах если возвращаются числа или даты: 6 + 10 * количество возвращаемых элементов
"Класс" используется для указания типа базы, из которой извлекаются данные. База данных Domino указывается как "" или "Notes". Параметр "тип_кеша" может принимать следующие значения:
•
• •
пустая строка или опущено – в этом случае результаты будут "кэшированы", т.е. сохранены в виртуальной памяти для повторного использования. Каждое последующее обращение за этой информацией в рамках одной сессии (пока БД, использующая формулу, остается открытой) будет адресовано к именно этим сохраненным данным; "NoCache" заставляет каждый раз извлекать текущую информацию непосредственно из базы; "ReCache" позволяет обновить кеш с момента последнего кеширования (добавлено в R 6).
Использование этой опции основывается на компромиссе. С одной стороны, требование, чтобы Domino каждый раз обращался к базе данных и извлекал ту же самую информацию, отнимает время и понижает общую производительность. С другой стороны, если Вы предполагаете, что данные будут периодически изменяться, стоит потратить время, но быть уверенным, что каждый раз извлекается актуальная информация. Параметр "сервер" : "база_данных" указывает имя базы данных. Существует несколько способов задать этот параметр:
• • •
для извлечения данных из текущей базы (той же базы, в которой выполняется формула) просто укажите в качестве параметра ""; для извлечения данных из локальной базы используйте "" для имени сервера и точно укажите имя файла базы данных, например "" : "БАЗА_ДАННЫХ.NSF" для извлечения данных (с рабочей станции) из базы на сервере укажите сервер, путь и имя файла как текстовый список: "СЕРВЕР" : "БАЗА_ДАННЫХ.NSF"
для извлечения данных фоновым агентом из базы на том же сервере или рабочей станции, что и БД, содержащая формулу, используйте "" для имени сервера и точно укажите имя файла базы данных, например "" : "БАЗА_ДАННЫХ.NSF" если имеются несколько реплик базы данных на станции и (или) на нескольких серверах, использование идентификатора реплики базы в качестве имени сервера и базы данных позволяет получить доступ к «ближайшей» реплике базы без указания имени сервера и самой базы. Для этого Вы задаете в качестве параметра "сервер": "база_данных" значение идентификатора реплики, например "85255CEB:0032AC04" (как одну текстовую строку, а не список из двух элементов).
Для поиска «ближайшей» реплики Domino использует следующий алгоритм:
• • •
•
сначала просматриваются базы из рабочего пространства. Если найдена одна реплика – то она и используется; если реплик несколько, и они отображаются в виде стека, то используется реплика с вершины стека; если при отображении реплик не используется стек, то Domino ищет иконку с текущего сервера, и в случае успеха использует эту БД. В противном случае используется БД, иконка которой была добавлена в рабочее пространство самой первой; если предыдущие шаги закончились неудачей, то просматриваются БД с текущего сервера, а затем все базы с Вашего локального диска. При этом используется первая найденную БД с заданным идентификатором реплики. Чтобы в последующем процесс поиска происходил быстрее, эта база добавляется в рабочее пространство.
Чтобы избежать ошибок при вводе идентификатора реплики, выберите в меню File - Database - Design Synopsis... и отметьте опцию Replicatoin. Затем скопируйте идентификатор реплики из конспекта в буфер и вставьте его в формулу. Если БД хранится в подкаталоге операционных систем DOS, Windows или OS/2, например, MAIL\MINE.NSF, между именем каталога и именем базы не забывайте вставлять две обратные косые вместо одной: "MAIL\\MINE.NSF". Параметр "вид" задает имя вида или папки, где следует искать данные. Для достижения большей универсальности рекомендуется пользоваться алиасом. Например, если вид в окне свойств вида показан как "По
авторам\Фамилия | Lname", в @DbColumn лучше использовать алиас "LName", хотя допустим и вариант "По авторам\\Фамилия". Параметр колонка используется для указания номера колонки в виде. Это числовая величина; заключать ее в кавычки не следует. Колонки вида нумеруются слева направо, и крайняя левая колонка имеет номер 1. Но, учитывая то, что вид есть представление индекса на экране, между видом и индексом имеются некоторые различия. @DbColumn выбирает информацию из индекса, при этом не каждая колонка вида учитывается в поиске. Для вычисления номера колонки используйте следующий метод:
Рассмотрите все колонки вида слева направо. Убедитесь, что не пропустили какую-то из них. Например, колонка, применяемая для сортировки или категоризации вида, может оказаться скрытой для пользователя, но используется в индексе вида. Просмотрите вид в режиме дизайна, чтобы увидеть все его колонки;
Исключите из рассмотрения все колонки вида, отображающие заведомо постоянную величину, например, 32 или "Выдано:". Такие колонки отсутствуют в индексе. Однако если колонка все же содержит формулу, которая возвращает одинаковый результат для всех документов, колонка не должна рассматривается как "константа", так что не исключайте ее из рассмотрения;
Исключите из рассмотрения все колонки вида, содержащие только одну из следующих функций: @DocChildren, @DocDescendants, @DocLevel, @DocNumber, @DocParentNumber, @DocSiblings, @IsCategory, @IsExpandable. Таких колонок нет в индексе;
Теперь пересчитайте колонки слева направо, не учитывая исключенные из рассмотрения. Полученный при этом номер колонки и будет являться величиной, которую следует указать в формуле для выбора значений.
Поскольку Domino получает информацию из индекса вида, основываясь на номерах колонок, можно извлекать только данные, представленные в индексе вида. Если указать несуществующую колонку, Domino не сообщит об ошибке, а просто возвратит пустое значение.
Когда @DbColumn используется в агенте, то последний должен иметь доступ к БД, к которой @DbColumn обращается (обратите внимание, что в R 6 агент может обращаться к БД, расположенным на другом (не текущем) сервере).
Для получения такого доступа, тот, под чьими правами агент выполняется, должен иметь доступ «Читателя» к указанной БД.
ЗАМЕЧАНИЕ: агенты, выполняющиеся на серверах версии R5 или ниже, могут иметь доступ к БД только текущего сервера. В рамках этих версии для возможности @DbColumn «читать» данные из другой (не текущей) БД так же можно было добавить автора агента под правами «Читателя» в ACL этой БД. Существует и другой способ - можно внести идентификатор реплики исходной БД (т.е. в той, где выполняется агент) в целевую (откуда считываются данные опять же под правами «Читателя». Для этого определите идентификатор реплики исходной базы, который выглядит, например, как 85255CEB:0032AC04. Затем, используя File - Database - Access Control..., в список управления доступом целевой базы добавьте нового субъекта с именем, представляющим собой идентификатор реплики (85255CEB:0032AC04), и назначьте этому субъекту права не ниже читателя. Таким образом, Вы отдельно предоставите агентам из исходной базы доступ к целевой базе, даже если в её списке управления доступом для -Default- указано No access. Данный механизм поддерживается и в версии R 6.
Если же @DbColumn выполняется на рабочей станции пользователя и выбирает данные из базы на рабочей станции, она всегда имеет к этой базе необходимый доступ (даже при уровне доступа No Access – нет доступа и поднятом флаге Enforce a consistent Access Control List across all replicas of this database - распространять список управления доступом на все реплики текущей БД). Если @DbColumn выполняется на рабочей станции пользователя, но выбирает данные из базы на сервере Domino, доступ @DbColumn к ней определяется уровнем доступа пользователя.
Если пользователь, под правами которого выполняется @DbColumn, не имеет доступа к "виду" на основании Read Access list (список управления доступом на чтение к виду) - закладку Security (безопасность) окна свойств вида, секция Who may use this view – кто может использовать данный вид), то функция выполнятся не будет. В этом случае возвращается сообщение об ошибке: «A view of that name cannot be found in the specified database» (вид с данным именем не найден в указанной БД).
Пример 1. Эта формула используется как формула ключевых слов. При создании документа по форме, содержащей это поле ключевых слов, Domino извлекает список наименований изделий из колонки 2 вида "Наличный инвентарь" локальной базы данных INVENTRY.NSF. @DbColumn( ""; "":"INVENTRY.NSF"; "Наличный инвентарь"; 2 )
Пример 2. Предположим, что коды изделий представляют собой "невразумительные" идентификаторы наподобие "ID1234-8765-23.003". Определить, какое изделие они представляют, затруднительно. Допустим, Вы желаете выводить в поле ключевых слов формы вместо кодов более лицеприятные описания изделий. Чтобы этого достичь, понадобится вид "По изделиям", содержащий в первой колонке список кодов изделий, в другой колонке, например, второй, описания изделий. Можно сделать эти описания доступными в Вашей форме, используя возможность указывать синонимы для ключевых слов: если любое ключевое слово содержит вертикальную черту "|", текст справа от нее является тем, что хранится в поле, а текст слева от черты это то, что показывается пользователю. Приведенная ниже формула "поэлементно сцепляет" содержимое второй колонки (с описаниями) с содержимым первой колонки (с кодами изделий). @DbColumn( ""; "":"PRODPLAN.NSF"; "По изделиям"; 2 ) + "|" +
@DbColumn( ""; "":"PRODPLAN.NSF";
"По изделиям"; 1 )
6.14.2 @DbLookup - выбор из колонки или поля значений по ключу ϑ @DbLookup( "класс": "тип_кеша"; "сервер": "база данных"; "вид"; ключ; "поле" или колонка [; флаги ] ) Область применения: нельзя использовать в формулах отбора, колонок и почтовых агентов. Ограниченно применима в формулах всплывающих окон. Результирующее значение может быть неточным, если первая сортировочная колонка "вида" содержит поле, которое может принимать несколько значений (multi-values field), и сортировка колонки указана без категоризации. Возвращаемое значение не должно превышать 64 Кбайта. Не работает при установке переменной окружения NoExternalApps равной 1. Получив значение ключ, функция просматривает указанный вид или папку, и находит в них все документы, содержащие значение ключ в первой отсортированной колонке. Для каждого из найденных документов возвращает либо содержимое какой-либо указанной колонки из вида, либо содержимое указанного поля. Если значений несколько, они возвращаются как список.
Например, пусть вид отсортирован по колонке Размер, а в качестве ключа указано "Средний". Функция @DbLookup находит три документа, представленных значением "Средний" в первой отсортированной колонке вида. Пусть необходимо выбирать и возвращать значения из второй колонки. Тогда будет возвращен список "Свитер" : "Брюки": "Халат".
1. Размер
2. Предмет
3. Цвет
Малый
Рубашка
Красный
Малый
Юбка
Зеленый
Средний
Свитер
Красный
Средний
Брюки
Желтый
Средний
Халат
Зеленый
@DbLookup может возвращать не более 64 Kб данных. Для определения количества элементов данных, которые могут быть возвращены @DbLookup, используются следующие соотношения:
• •
если возвращается текст: 2 + (2 * количество возвращаемых записей) + общий размер текста во всех элементах; если возвращаются числа или даты: 6 + 10 * количество возвращаемых элементов.
Параметры "класс": "тип_кеша"; "сервер": "база данных"; "вид" имеют те же синтаксис и семантику, как и у функции @DbColumn. Параметр ключ - ключ для поиска - указывает, какие документы следует найти, чтобы затем извлечь из них требуемую информацию. Ключом документа является значение в первой отсортированной колонке вида. Введя с клавиатуры это значение при открытом виде, Вы "можете перейти" к первому документу, представленному этим ключом. В качестве ключа можно задавать как:
• •
константу, того же типа данных, что и тип значение в первой колонке вида; любое допустимое выражение @-формул, значение которого на момент выполнения @DbLookup определено и имеет тип данных аналогичный типу значения в первой колонке вида.
@DbLookup проверяет значения только на совпадение с ключом. Совпадение ключа и значения в отсортированной колонке должно быть полным регистр не имеет значения, но пробелы и знаки пунктуации должны быть указаны точно (за исключением, когда задан флаг [PARTIALMATCH]). Вид
должен содержать отсортированную колонку; в противном случае @DbLookup возвращает пустое значение. В качестве параметра ключ можно задавать список. Тогда будут отобраны все документы, содержащие в первой отсортированной колонке выбранного вида значение, являющееся одним из элементов списка ключ. Формально, с точки зрения синтаксиса, приведенного в документации, параметр ключ должен иметь текстовый тип. Если следовать данному требованию – то это гарантировано поможет избежать ошибок, когда что-то не найдется. Всегда можно преобразовать значение колонки к тексту (например, с помощью @Text). Из опыта мохно применять и нетекстовые (например, дата/время) значения ключа, но в этих случаях не всегда @DBLookup работает корректно. Если первая сортировочная колонка "вида" содержит поле, которое может принимать несколько значений (multi-values field), и сортировка колонки указана без категоризации, то результирующее значение может быть неточным. Например, в первой колонке вида выводится содержимое поля FIO. У Вас в базе имеются документы, значения поля FIO которых : (1-ый документ - "Петров В.В." : "Иванов А.А.", 2-й документ - "Петров В.В.", 3-й документ -"Расторгуев Б.Б." и 4й -"Сидоров А.А." : "Петров В.В."). При поиске документов по ключу - "Петров В.В." функция @DbLookup не вернет значения из 4-го документа. Для того чтобы избежать такой ситуации, делайте сортировку первой колонки с категоризацией. Параметр "поле" указывает, из какого поля в найденных документах следует извлечь данные. Имя поля задается как текстовая строка. @DbLookup должен обратиться к каждому найденному документу и извлечь из него значение указанного поля. Учтите, что значение в поле документа может отличаться от "показанного" в виде, а некоторые из документов могут даже не содержать указанного поля (например, если они созданы с помощью других форм). Вместо того чтобы указывать имя поля, можно указать номер колонки в виде. Это числовая величина, она не должна заключаться в кавычки. @DbLookup для каждого найденного документа непосредственно из индекса вида выбирает значение в колонке с заданным номером. При этом не происходит обращения к документу, поэтому поиск, использующий номера колонок видов, более эффективен, чем поиск, использующий поля, не содержащиеся в виде. Для более эффективной работы можно включить требуемое поле в вид. Относительно определения номера колонки вида и уровня доступа, справедливо все сказанное при рассмотрении функции @DbСolumn. В R 6 помимо того, что в качестве параметра "тип_кеша" можно указывать "ReCache", но так же появился последний необязательный параметр флаги. В общем случае это может быть список из следующих допустимых значений:
[FAILSILENT] – в этом случае возвращается пустая строка, вместо ситуации ошибки при не обнаружении ключа в колонке; [PARTIALMATCH] – возвращает значения из тех документов, у которых ключ содержит начальные символы из первой колонки; [RETURNDOCUMENTUNIQUEID] – возвращает вместо значения поля или колонки, значение универсального идентификатора документа (UNID). Стоит не забывать, что в этом случае, хотя значение поля или колонки по смыслу не нужно, его все равно следует указывать.
Пример 1. Возвращает значение из поля Status документа, содержащего в первой отсортированной колонке вида "Настройки" значение "Настройки пользователя". БД PROJECTS.NSF хранится в подкаталоге BASES сервера NotesSrv. @DbLookup( "":"NoCache"; "NotesSrv" : "BASES\\PROJECTS.NSF"; "Настройки"; "Настройки пользователя"; "Status" )
Пример 2. Возвращает из вида People текущей БД UNID документов, у которых в первой сортированной колонке данного вида содержится текст, начинающийся со строки «Петро» (т.е. и Петров, и Петровский, и Петрович со всевозможными инициалами). Обратите внимание, что хотя в данном случае параметр колонка или поле по смыслу не нужны, но они все равно указаны из соображения синтаксиса. @DbLookup( "":"NoCache"; ""; "People"; "петро"; 1; [PARTIALMATCH] : [RETURNDOCUMENTUNIQUEID] )
6.15 Получение информации из баз данных, поддерживающих ODBC-драйверы В Domino с версии 4 существуют три функции - @DbColumn, @DbLookup и @DbCommand - позволяющие извлекать информацию из баз данных, поддерживающих ODBC-драйверы. Обратите внимание, что первые две функции (@DbColumn, @DbLookup) позволяют только извлекать данные, но не добавлять, удалять или изменять их. Извлекается при этом из таблицы не более чем одна колонка значений. @DbCommand - позволяет выполнять команды, поддерживаемые конкретным ODBC-драйвером (в частности и удаление, и модификацию данных), и возвращать полученный результат.
ODBC (Open DataBase Connectivity) - интерфейс, который позволяет приложениям получать данные от систем управления базами данных (DBMS). @DbColumn, @DbLookup и @DbCommand могут возвращать не более 64 Kб данных. Для определения количества данных, которые могут быть возвращены, воспользуйтесь следующими соотношениями:
•
•
если возвращается текст: 2 + (2 * количество возвращенных записей) + общий размер текста во всех записях. Каждая текстовая строка имеет максимальную длину 511 байт; если возвращается только одна текстовая строка, она может иметь длину до 64 Кб. если возвращаются числа или даты: (10 * количество возвращенных записей) + 6 .
ϑ @DbColumn( "ODBC": "тип_кеша"; "источник_данных"; "ID_1":"ID_2"; "пароль_1": "пароль_2"; "таблица"; "колонка": "нуль_поддержка"; "Distinct": "сортировка" ) Область применения: нельзя использовать в формулах отбора, колонок, видимости объекта, редактируемой секции и заголовка окна. Возвращаемое значение не должно превышать 64 Кбайта. Не работает при установке переменной окружения NoExternalApps равной 1. Использует для доступа к соответствующей таблице и колонке ODBCдрайвер, соответствующий указанному источнику данных. Извлекает значения из одной колонки в таблице. Если значений несколько, возвращает их как список. Дополнительно можно указать, должен ли возвращаемый список значений быть сортированным, следует ли удалять в нем повторяющиеся значения и как необходимо поступать с пустыми значениями. Основным использованием @DbColumn являются формулы ключевых слов. Обратите ВНИМАНИЕ!!!, что @DbColumnn может только «извлекать» данные из сторонних источников, но не изменять их (удалять, добавлять, редактировать). Параметр "ODBC" указывает, доступ к "чужой" (не Notes) базе данных должен осуществляться с помощью ODBC-драйверов. Это обязательный параметр.
Параметр тип_кеша может принимать следующие значения:
•
• •
пустая строка или опущено – в этом случае результаты будут "кэшированы", т.е. сохранены в виртуальной памяти для повторного использования. Каждое последующее обращение за этой информацией в рамках одной сессии (пока база данных, использующая формулу, остается открытой) будет адресовано к именно этим сохраненным данным; "NoCache" заставляет каждый раз извлекать текущую информацию из базы; "ReCache" позволяет обновить кеш с момента последнего кеширования (добавлено в R 6).
Параметр "источник_данных" задает имя внешнего источника данных. Источник данных содержит сведения о типе и местонахождении одной или нескольких таблиц базы данных. Имя источника данных должно задаваться, как текстовая строка и может содержать до 32 алфавитно-цифровых символов. @DbColumn обеспечивает доступ только к уже зарегистрированным источникам данных. Регистрация и модификация источников данных производится приложением настройки ODBC-драйверов, которое в MS Windows, Windows 95, Windows 98 и Windows NT имеется в контрольной панели (Control Panel), для Windows 2000 (Control Panel -> Administrative Tools).
Рис. 6.11 Пиктограмма и окно приложения настройки ODBC-драйверов Параметр "ID_1" : "ID_2" представляет собой текстовый список, содержащий идентификаторы пользователя, осуществляющего доступ к источнику данных. Параметр "пароль_1" : "пароль_2" является текстовым списком, содержащим пароли соответственно для идентификаторов "ID_1" и
"ID_2". В зависимости от того, к источнику какого типа Вы обращаетесь, может потребоваться как ни одного, так и один или два идентификатора и соответствующее количество паролей. Если идентификатор вообще не нужен, укажите в качестве значений для параметров "ID_1" : "ID_2" и "пароль_1" : "пароль_2" пустую строку (""). Если необходим только первый идентификатор, можно опустить элемент списка "ID_2". Соответственно, при этом нет необходимости задавать и второй пароль. Если какой-либо идентификатор или пароль необходим, но Вы укажете для него значение "", пользователь получит диалоговое окно для ввода недостающего идентификатора и/или пароля. Идентификаторы пользователя и пароли для доступа к источнику данных требуются только один раз на сеанс работы с базой данных Notes. Если база данных содержит несколько формул для доступа к тому же источнику данных, за все время, пока база данных Notes открыта, пользователю придется ввести свои идентификаторы и пароли только один раз. Но если пользователь откроет другую базу данных Notes и вызовет функцию, требующую доступа к тому же источнику данных, ему опять потребуется ввести идентификаторы пользователя и пароли. Однако, если Вы используете @DbColumn в фоновом агенте, Вы должны включить в формулу все необходимые идентификаторы и пароли, поскольку фоновые агенты не могут запрашивать информацию. Параметр "таблица" задает таблицу, к которой осуществляется доступ. Это текстовая строка. Для некоторых типов источников параметр "таблица" может задаваться в формате "имя_владельца.имя_таблицы". Параметр "таблица" может также ссылаться не реальную таблицу, а на представление (виртуальная таблица, строки которой в базе данных не существуют, но основаны на данных реально существующей таблицы базы данных - термин View в DBMS [DataBase Managment System]). Колонка, из которой следует извлечь данные, указывается параметром "колонка". Это тоже текстовая строка. Параметр "нуль_поддержка" определяет, как при извлечении данных должны обрабатываться пустые значения. Способ обработки пустых значений может быть одним из следующих:
• •
•
"Fail" (Ошибка) - если встретится пустое значение, будет сгенерировано сообщение об ошибке "Null values found - canceling @Db function". Работа функции на этом завершится, и никакие данные не будут ею возвращены; "Discard" (Отбросить) - если встретится пустое значение, оно должно быть отброшено. Если при работе функции @DbColumn были отброшены какиелибо пустые значения, в строке состояния Notes "промелькнет" сообщение "Warning: NULL values discarded from @Db list". Работа функции завершится нормально, и она возвратит список без отброшенных значений; "Заменяющее значение" - если встретится пустое значение, оно должно быть заменено на указанное. Заменяющее значение по смыслу должно
соответствовать типу данных колонки; например, для числовой колонки допустимо значение "311", но недопустимо "ABC". При этом заменяющее значение формально задается как текстовая строка (даже если заменяющее значение - число или дата). Если при работе функции @DbColumn происходили замены, в строке состояния Notes "промелькнет" сообщение "Warning: NULL value replaced with user-defined value in @Db list". Работа функции завершится нормально, и она возвратит список, в котором вместо пустых значений присутствуют их заменяющие. Учтите только следующий момент. Если в формуле запрошена сортировка, ODBC-драйвер сортирует список возвращаемых значений перед выполнением в нем замен. Во время сортировки все пустые значения обычно попадают в начало или конец списка. Они заменяются уже по окончании сортировки. Иногда это может привести к неправильной сортировке в возвращаемом функцией списке. Например, если было указано заменяющее значение "ххх", все "ххх" будут находиться в начале списка, если последний отсортирован в порядке возрастания. Если необходимо устранить повторяющиеся значения из списка перед его возвратом Notes, используйте параметр "Distinct". Ключевое слово "Distinct" является аналогом функции Domino @Unique, за исключением того, что повторяющиеся значения удаляются ODBCдрайвером перед возвратом данных в Domino. Использование "Distinct" вместо @Unique имеет два преимущества:
• •
формула выполняется быстрее, поскольку дополнительные операции выполняются вне Domino; поскольку повторяющиеся значения удаляются ODBC-драйвером, в Domino может быть возвращено больше уникальных значений.
Не все ODBC-драйверы поддерживают режим "Distinct". Если это так, указав "Distinct", Вы можете иногда получить одно нулевое значение. Параметр "сортировка" задает способ сортировки значений ODBCдрайвером. Однако не все ODBC-драйверы его поддерживают. Можно использовать один из следующих вариантов:
•
"" - отсутствие сортировки;
•
"Ascending" - сортировка в порядке возрастания;
•
"Descending" - сортировка в порядке убывания.
На возвращаемые значения @DbColumn в формате ODBC существует аналогичное БД Domino ограничение в 64 Кбайт. Порядок расчета числа возвращаемых записей так же аналогичен @DbColumn с БД Domino
Пример. Источник данных "DBASE Files" содержит несколько баз данных формата dBase IV. Идентификатор и пароль не требуются. Выбираются только уникальные названия фирм из колонки Company в таблице из файла Customer.dbf. Пустые значения отбрасываются. Возвращаемые значения отсортированы по возрастанию. @DbColumn( "ODBC"; "DBASE Files"; ""; ""; "Customer"; "Company" : "Discard"; "Distinct" : "Ascending" )
ϑ @DbLookup( "ODBC": "тип_кеша"; "источник_данных";"ID_1": "ID_2"; "пароль_1": "пароль_2"; "таблица"; "колонка": "нуль_поддержка"; "ключевая_колонка"; ключ; "Distinct" : "сортировка") Область применения: нельзя использовать в формулах отбора, колонок, заголовка окна видимости объекта, редактируемой секции и почтовых агентов. Возвращаемое значение не должно превышать 64 Кбайта. Не работает при установке переменной окружения NoExternalApps равной 1. Использует соответствующий указанному источнику данных ODBCдрайвер для доступа к соответствующей таблице и колонкам. Извлекает и возвращает значения из указанной колонки, принадлежащие к тем записям, у которых значение в ключевой колонке совпадает с указанным параметром ключ. Если значений несколько, возвращает их как список. Дополнительно можно указать, должен ли возвращаемый список значений быть сортированным, следует ли удалять в нем повторяющиеся значения и как необходимо поступать с пустыми значениями. @DbLookup предназначена для выбора значений из записей, содержащих указанный ключ. Параметры "ODBC": "тип_кеша"; "источник_данных"; "ID_1": "ID_2"; "пароль_1": "пароль_2"; "таблица"; "колонка": "нуль_поддержка" и параметр "Distinct": "сортировка" синтаксически и семантически эквивалентны соответствующим параметрам функции @DbColumn (ODBC). Единственное отличие - из колонки выбираются не все, а только требуемые значения. Параметр "ключевая_колонка" указывает, в какой колонке следует искать заданный ключ. Имя ключевой колонки должно задаваться как текстовая строка. Значения в ключевой колонке не обязательно должны быть сортированы. Ключ может быть величиной любого типа: текстовой строкой, числом, значением типа дата/время, любым списком. Значение даты и времени
следует задавать в формате, который поддерживает база данных-источник и конкретный ODBC-драйвер, а не Domino; например для DB2 нужно указать "1996-01-31-12.00.00", а не "1996-01-31-12:00:00". Ключевая колонка и ключ вместе составляют как бы часть WHERE ("где") в выражении на языке SQL для выбора записей:
SELECT "колонка" FROM "таблица" WHERE "ключевая_колонка" = ключ
Функция выполняет сравнение ключа и значения в ключевой колонке и возвращает данные только из тех записей, у которых значения в ключевой колонке точно соответствуют заданному ключу. В качестве значения ключа может быть задан список. Это позволяет выбрать данные только из тех записей, у которых значения в ключевой колонке точно соответствуют одному из элементов списка.
Пример. Источник данных "dBASE Files" содержит несколько баз данных формата dBase IV. Идентификатор и пароль не требуются. Данные выбираются из таблицы в файле Customer.dbf. Приведен фрагмент этой таблицы. Необходимо по названию фирмы (Company) определять сотрудника, отвечающего за контакты с этой фирмой (Contact).
Ключевой колонкой является Company, а информация выбирается из колонки Contact. Выбираются только уникальные имена сотрудников. Пустые значения отбрасываются. Возвращаемые значения отсортированы по возрастанию. Ключ берется из поля Key. Если Key = "Andre's Continental Food Market", будет возвращено "Heeneth Ghandi". Если Key = "Andre's Continental Food Market": "Family Corner Market", будет возвращено "April Cienkewicz": "Heeneth Ghandi". @DbLookup( "ODBC"; "dBASE Files"; ""; ""; "Customer"; "Contact" : "Discard"; "Company"; Key; "Distinct": "Ascending" )
ϑ @DbCommand( "ODBC" : тип_кеша; "источник_данных"; "ID_1" : "ID_2"; "пароль_1" : "пароль_2"; "командная_строка" : "нуль_поддержка" ) Область применения: нельзя использовать в формулах отбора, колонок и всплывающих окон. Возвращаемое значение не должно превышать 64 Кбайта. Не работает при установке переменной окружения NoExternalApps равной 1. Передает обслуживающему источник данных ODBC-драйверу указанную в командной строке команду. ODBC-драйвер находит соответствующую указанному источнику данных DBMS, передает ей указанную команду для обработки и возвращает (или нет) данные, извлеченные с помощью этой команды. Если в результате выполнения командной_строки возвращаемых значений больше чем одна колонка данных (например, SELECT * FROM Table), то в Notes передается только первая колонка как список. Возвращаемое значение может и отсутствовать, если командная строка отлична от оператора SELECT. Параметры "ODBC": тип_кеша; "источник_данных"; "ID_1": "ID_2"; "пароль_1": "пароль_2" и параметр "нуль_поддержка" синтаксически и семантически эквивалентны соответствующим параметрам функции @DbColumn (ODBC). "Командная_строка" может быть одним из следующих:
• •
запрос на языке SQL (при этом нужно использовать синтаксис SQL, "понятный" целевой DBMS); выражение на языке управления целевой DBMS (если целевая DBMS имеет собственный язык управления);
Параметр "командная_строка" должен быть строкой текста. Если потребуются кавычки внутри командной строки, используйте вместо внутренних кавычек апостроф. В документации приводится такое предупреждение: “Обратите ВНИМАНИЕ !!!, что если вы используете результат работы @DbCommand в качестве формулы ключевых слов для поля с интерфейсом типа CheckBox или Radio button, то документ будет обновляться только при либо при создании документа, либо при его загрузке на редактирование, в отличие от стандартного интерфейса для списков, когда осуществляется обновление поля при пересчете полей документа“. Однако из опыта можно сказать следующее, что при выборе опции "NoCache" или "ReCache" в @DbCommand, и установке свойства Refresh choices on document refresh (Обновлять пункты меню при обновлении документа) у соответствующего поля, происходит реальное обновление значений независимо от типа интерфейса поля (автор, разумеется, не проверял это утверждение на всех доступных драйверах ODBC, но для FoxPro и DBASE – это так). Пример 1. Используется база данных "pubs", которая включена в качестве примера в комплект поставки Microsoft SQL Server. Формула использует ODBC-драйвер для доступа к источнику данных PUBLISHERS, находит таблицу "authors", принадлежащую пользователю "dbo", а затем извлекает список имен из колонки "au_lname" для авторов, проживающих в Калифорнии (state='CA'), с которыми был подписан контракт (contract=1). Заметьте, что строка CA, заключенная в командной строке в апострофы, передается в DBMS ODBC-драйвером заключенной в кавычки, как того требует синтаксис SQL. @DbCommand( "ODBC"; "PUBLISHERS"; "dbo" : ""; "vanilla" : ""; "SELECT au_lname FROM dbo.authors WHERE contract=1 AND state='CA' " )
Пример 2. Источник данных "FoxPro Files" содержит базу данных ROOMS формата FoxPro 2.6. Идентификатор и пароль не требуются. Формула изменяет значения поля NAME в этой базе на '123' для тех записей, для которых значение поля CODE равно '06'. Возвращаемое значение отсутствует. @DbCommand( "ODBC": "NoCache"; "FoxPro Files"; ""; ""; "UPDATE ROOMS SET NAME='123' where CODE = '06' " );
6.16 Функции для работы с видами ϑ @SetViewInfo( [SETVIEWFILTER]; "фильтр"; "программное_имя_столбца"; флаг ) Область применения: В DOMINO R 6.0.1 ДОКУМЕНТИРОВАНА.
НЕ
Накладывает фильтр на отображаемую информацию в видах и папках. По своему действию очень похожа на результат применение Show single category (показ единственной категории) в рамках встроенных видов/папок. Функция может быть применена как к стандартным, так и к календарным видам. Результат применения и характер воздействия аргументов функции зависит от типа вида (стандартный/календарный). Рассмотрим подробнее аргументы функции согласно документации (она не всегда соответствует действительности):
•
•
•
"фильтр" – текстовая строка, определяющая какие документы будут отображаться в виде. Если такая строка присутствует в столбце с программным именем, определенным во втором параметре функции, то такие документы отображаются в виде после применения функции; "программное_имя_столбца" - текстовая строка, определяющая программное имя столбца (задается в поле Name на закладке Advanced окна свойств столбца). Указанный столбец должен содержать строку "фильтр" для отображения соответствующих документов в виде; флаг – булевское значение. Для стандартных (некалендарных) видов при значении 1 (True) указывает, что колонка с программным именем из предыдущего параметра является категорией, 0 (False) – в противном случае. Для календарных видов флаг является необязательным параметром, указывающим на точное/неточное соответствие "фильтра" значению из столбца "программное_имя_столбца". 1 (True) определяет точное соответствие, 0 (False) – в противном случае.
Из личного опыта можно сказать, что функция может использоваться в рамках формул акций видов и форм, кнопок панели инструментов и гиперобъектов. Функция не работает в Web-приложениях. Функция с параметром флаг при значении 1 оказывает воздействие на все стандартные (т.е. некалендарные) виды, а при значении 0 (или с опущенным параметром флаг) соответственно на все календарные виды. Другими словами, если в рамках некалендарного вида применить формулу типа @SetViewInfo([SetViewFilter]; "Россия"; "Country"; 1) в рамках акции определенного некалендарного вида, а затем переключиться в другой некалендарный вид/паку – то в ней тоже будет действовать этот фильтр (иногда надо обновить индекс вида – F9). Такой фильтр будет действовать либо до
нового применения функции @SetViewInfo, либо до закрытия БД. Соответственно @SetViewInfo с параметром флаг равным 1 не оказывает влияние на календарные виды, а с параметром флаг равным 0 (или опущенным) не оказывает влияние на некалендарные виды. Фильтр можно снять применением функции @SetViewInfo, у которой в качестве параметра "фильтр" указана пустая строка. При этом в качестве значения параметра "программное_имя_столбца" можно указать любое значение (даже имя несуществующего столбца) за исключением пустой строки, и последний параметр флаг должен соответствовать типу вида (календарный/некалендарный). Функция нечувствительна к регистру параметра "фильтр". Для некалендарных видов справедливы следующие правила:
•
• •
•
•
168
функция оказывает влияние только на самую первую категорию вида. Если в виде две категории (например, первая страна и далее город), то @SetViewInfo([SetViewFilter];"Москва";"Town";1) – скрывает все документы в виде. Функция работает некорректно, даже если перед первой отображаемой категорией слева присутствуют скрытые колонки; параметр флаг при значении 0 – не оказывает никакого влияния на виды (фильтр не накладывается даже для первой колонки сортированной, но не категоризованной); в случае не строгого соответствия строки-фильтра значению из первого столбца-категории, отбираются документы только из первой категории, соответствующей частичному совпадению со строкой-фильтром. Другими словами, если в первой категоризованной колонке отображаются записи со значениями «Руанда» и «Румыния», то применение формулы @SetViewInfo([SetViewFilter]; "ру"; "Coutry"; 1) отобразит только документы имеющие отношение к «Руанда»; строка-фильтр должна не присутствовать в колонке вида, а являться началом отображаемой в колонке информации. Т.е. если в первой категоризованной колонке вида с программным именем Country отображается «Россия», то @SetViewInfo([SetViewFilter]; "оссия"; "Country"; 1) не будет отображать такие документы; функция не работает, если в первом столбце-категории отображается нетекстовая информация (дата/время, числа).
Для календарных видов справедливы следующие правила:
• •
• •
параметр флаг при значении 1 – не оказывает никакого влияния на календарные виды. Для воздействия на календарные виды параметр флаг должен быть равен 0, либо опущен; функция корректно работает со значениями типа дата/время и числа. Параметр "фильтр" в этом случае задается как текстовая строка, соответствующая отображаемой информации из "программное_имя_столбца", преобразованной к тексту; для отбора документов строка-фильтр должна присутствовать (а не обязательно начинаться с нее) в столбце "программное_имя_столбца"; функция может быть применена к любому (т.е. не обязательно первому) столбцу, включая скрытые и несортированные.
Пример 1. В первой категоризованной колонке стандартного вида с программным именем Country отображается информация из одноименного поля документов. Формула, размещенная в акции вида, может использоваться для установки/снятия фильтра, накладываемого на все стандартные виды: cond := @Prompt([OkCancelCombo]; "Выбор действия"; "Выберите требуемое действие"; "Снять
Пример 2. В БД, созданной по стандартному почтовому шаблону (mail6.ntf), в виде с алиасом Calendar добавляем новую акцию формы, которая будет отбирать только те документы, у которых в заголовке присутствует строка «место встречи». Обратите внимание, как задан параметр "программное_имя_столбца". Его можно было бы изменить в поле Name на закладке Advanced окна свойств столбца. Собственно формула акции вида выглядит так: @SetViewInfo([SetViewFilter]; "место встречи"; "$147"; 0)
6.16.1 Функции, используемые в формулах отбора документов @All Область применения: без ограничений. Всегда возвращает 1 (TRUE). Используется в формулах отбора документов, видимости объектов, фоновых агентах. Пример. Отбирает все документы при использовании в формуле отбора в виде. SELECT @All
@AllChildren в SELECT формула_отбора | @AllChildren Область применения: разрешается использовать только в формулах отбора документов и селективной репликации. Не работает в версиях Domino ниже R4. Конструкция SELECT формула_отбора | @AllChildren позволяет отобрать все документы, удовлетворяющие формуле отбора, плюс документы, которые являются документами-ответами только на документы, удовлетворяющие формуле отбора. Обратите внимание, что конструкция SELECT формула_отбора | @IsResponseDoc возвращает все документы, удовлетворяющие формуле отбора, плюс все документы из базы, которые являются документами-ответами (не важно, на какие документы).
@AllDescendants в SELECT формула_отбора | @AllDescendants Область применения: разрешается использовать только в формулах отбора документов и селективной репликации. Не работает в версиях Lotus Notes/Domino ниже R4. Конструкция SELECT формула_отбора | @AllDescendants позволяет отобрать все документы, удовлетворяющие формуле отбора, плюс документы, которые являются документами-ответами и документами - ответами на ответ на всех уровнях дерева, "начинающегося" только от документов, удовлетворяющих формуле отбора. Пример. Пусть "дерево" документов-ответов таково. 1.0 Какой твой любимый цвет? (Esteban Garcia) 1.1 Голубой (Mary Lu) 1.2 "Цвет морской волны" (Jim Thompson) 1.2.1 Почему тебе нравится "цвет морской волны"? (Mary Lu) 1.2.2 Он навевает мне мысли об океане (Jim Thompson) 1.3 А мне нравится оранжевый (Bill Jones)
Пусть приведенный здесь текст берется из поля Subject, а заключенные в скобки имена являются именами авторов документов. Тогда первый оператор SELECT отбирает документы 1.2, 1.2.1 и 1.2.2; второй - 1.0, 1.1, 1.2 и 1.3; третий - 1.0, 1.1, 1.2, 1.2.1, 1.2.2 и 1.3; а четвертый - 1.2.1 и 1.3. SELECT @Author = "Jim Thompson"
6.16.2 Функции, используемые в формулах колонок @DocChildren @DocChildren( строка ) @DocChildren( строка_1; строка_2 ) @DocChildren( строка_1; строка_2; строка_3 ) Область применения: разрешается использовать только в формулах колонок и заголовка окна. В Web-приложениях работает только в формулах колонок. Функция используется для определения числа ответных документов у текущего документа или категории (считаются только документы-ответы на текущий документ, но не ответы на ответы). Возвращаемое значение, содержащее число ответов, представляет строку специального формата, который предназначен только для вывода в колонке или заголовке окна, и не может быть преобразован в число. При вызове без параметров возвращает число ответных документов. При вызове с одним параметром строка, эта же строка и возвращается. Если в ней присутствует символ "%", он заменяется на число документов ответов. При вызове с двумя аргументами возвращает строку_2, в случае, если число ответов больше нуля, или строку_1 при отсутствии ответных документов или категорий. При вызове с тремя аргументами возвращает строку_3, в случае если число ответов больше одного, строку_1 при отсутствии ответных документов или категорий, и строку_2, если ответов один. Символ "%" заменяется на число документов ответов (при вызове с двумя аргументами в строке_2, или в строке_3 при вызове с тремя аргументами). При использовании в формуле столбца, если Вы хотите получить информацию о числе ответных документов у категории, столбец с функцией @DocChildren должен находиться левее категоризирующей колонки. При использовании в формуле полей, для получения информации о числе документов-ответов, исходный документ должен быть открыт. Поэтому при печати документа из представления, результат у функции @DocChildren будет не определен. Пример. При использовании в формуле колонки будет возвращать одно из трех значений "Ответов нет", "Ответ есть" или "Число ответов: N". @DocChildren( "Ответов нет" ; "Ответ есть" ; "Число ответов: %" )
@DocDescendants @DocDescendants( строка ) @DocDescendants( строка_1; строка_2 ) @DocDescendants( строка_1; строка_2; строка_3 ) Область применения: разрешается использовать только в формулах колонок и заголовка окна. В Web-приложениях работает только в формулах колонок. Функция используется для определения числа ответных документов у текущего документа или категории (считаются документы-ответы и ответ-наответ у текущего документа). Возвращаемое значение, содержащее число ответов, представляет строку специального формата, который предназначен только для вывода в колонке или заголовке окна, и не может быть преобразован в число. Параметры строка, строка_1, строка_2 и строка_3 синтаксически и семантически эквивалентны соответствующим параметрам функции @DocChildren. Пример. При использовании в формуле колонки будет возвращать одно из двух значений "Ответов нет" или "Число ответов: N". @DocDescendants( "Ответов нет" ; "Число ответов: %" )
@DocLevel Область применения: разрешается использовать только в формулах колонок и заголовка окна. Ограниченно применима в формулах полей. В Web-приложениях работает только в формулах колонок. Возвращает значение представляющее текущий уровень документа или категории в дереве ответов. Возвращаемое значение представляет строку специального формата, который предназначен только для вывода в колонке или заголовке окна, и не может быть преобразован в число, за исключением использования функции в формулах полей. При использовании в формулах заголовка окна и полей всегда возвращает значение "1" до тех пор, пока документ не будет сохранен. В формулах полей, после сохранения, значение функции @DocLevel может быть преобразовано к числу. Пример. При использовании в формуле колонки возвращает "Уровень иерархии: N". "Уровень иерархии: " + @DocLevel
@DocNumber @DocNumber( строка ) @DocNumber( "" ) @DocParentNumber @DocParentNumber( "" ) @DocParentNumber( строка ) Область применения: разрешается использовать только в формулах колонок и заголовка окна. Ограниченно применима в формулах полей. В Web-приложениях работает только в формулах колонок. Возвращают значения, представляющие иерархический уровень, соответственно текущего документа или категории в дереве ответов для @DocNumber, или родительского документа или категории для @DocParentNumber. Для функции @DocParentNumber текущий и родительский уровень должны быть оба одного типа, или документами, или категориями, в противном случае результат функции не определен. Возвращаемое значение представляет строку специального формата, который предназначен только для вывода в колонке или заголовке окна, и не может быть преобразован в число, за исключением использования функций в формулах полей. Возвращаемое значение имеет вид, например, "2.3" - это значит (для @DocNumber), что документ находится на втором уровне иерархии, и в рамках одного уровня находится на третьем месте. При использовании @DocNumber в формулах заголовка окна и полей всегда возвращает значение "0" до тех пор, пока документ не будет сохранен. Возвращаемое значение @DocParentNumber в этом же случае вообще не определено. В формулах полей, после сохранения, значение функций @DocNumber и @DocParentNumber может быть преобразовано к числу. При вызове функции с параметром строка, в возвращаемом значении разделитель "." между уровнями иерархии заменяется на первый символ строки. Обратите внимание, что по синтаксису строка должна состоять из одного символа. Если в качестве параметра используется пустая строка "", то это заставляет функции в возвращаемом значении выводить только уровень иерархии внутри текущего уровня, т.е. выводится правая составляющая иерархии. Пример. При использовании в формуле колонки возвращает "Уровень иерархии: N.M". "Уровень иерархии: " + @DocNumber
@DocSublings Область применения: разрешается использовать только в формулах колонок и заголовка окна. Ограниченно применима в формулах полей. В Web-приложениях работает только в формулах колонок. Возвращает значение представляющее количество документов или категорий на текущем уровне иерархии в дереве ответов. Возвращаемое значение представляет строку специального формата, который предназначен только для вывода в колонке или заголовке окна, и не может быть преобразован в число, за исключением использования функции в формулах полей. При использовании в формулах заголовка окна и полей всегда возвращает значение "0" до тех пор, пока документ не будет сохранен. В формулах полей, после сохранения, значение функции @DocSublings может быть преобразовано к числу. При использовании в формуле полей, для получения информации о числе документов-ответов, исходный документ должен быть открыт. Поэтому при печати документа из представления результат у функции @DocSublings будет не определен. Пример. При использовании в формуле колонки возвращает "Число документов на уровне иерархии: N". "Число документов на уровне иерархии: " + @DocSiblings
@IsExpandable @IsExpandable( строка ) @IsExpandable( строка_1; строка_2 ) Область применения: разрешается использовать только в формулах колонок. В Web-приложениях не работает. Функция используется для определения, является ли данный уровень документов в виде "разворачиваемым". Если не указаны параметры, @IsExpandable возвращает односимвольную строку "+", если запись разворачиваемая, и "-" , если нет. С одним параметром возвращает строку вместо "+", если запись разворачиваемая, и ничего не возвращает в противном случае. С двумя параметрами возвращает строку_1 вместо "+" и строку_2 вместо "-". Если Вы хотите получить информацию о "разворачиваемости" категории, то столбец с функцией @IsExpandable должен находиться левее категоризирующей колонки.
Пример 1. Возвращает разворачиваемые, и "-", если нет.
"+",
если
документ
или
категория
"&",
если
документ
или
категория
Пример 3. Возвращает "Да", если разворачиваемые, и "Нет" в противном случае.
документ
или
категория
@IsExpandable
Пример 2. разворачиваемые.
Возвращает
@IsExpandable( "&" )
@IsExpandable( "Да"; "Нет" )
6.17 Функции, работающие с именами пользователей @V3UserName Область применения: без ограничений. Эта функция эквивалентна функции @UserName из версии 3.х. Более того, когда БД версии 3.х автоматически конвертируется в формат версии 4, все вызовы @UserName заменяются на вызовы @V3UserName. Функция возвращает имя текущего пользователя или имя сервера в сокращенном формате ([Abbreviate]). При использовании @V3UserName в локальной базе данных, в частном виде базы данных на сервере или когда формула, содержащая @V3UserName, выполняется на станции, возвращается имя пользователя. Имя сервера возвращается только тогда, когда формула, содержащая @V3UserName, выполняется на сервере. Одним из применений @V3UserName является отображение в виде только документов, имеющих отношение к текущему пользователю. Например, в базе данных заявок на обслуживание можно использовать @V3UserName в частном виде "Наряды", чтобы показывать только наряды на выполнение работ конкретного сотрудника, скрывая от него наряды остальных: SELECT @V3UserName = AssignedTo
Однако, может быть создан другой частный вид, извлекающий все документы, поэтому нельзя полагаться на @V3UserName как на механизм соблюдения секретности. Учтите, что не рекомендуется использовать @V3UserName в общем виде - это может привести к непредсказуемым результатам.
Пример. Формула поля формы возвращает имя текущего пользователя (под ID которого работает станция), например "Evgeny V Polyakov/ITDep/Technic/Center_TV/RU". @V3UserName
@UserName @UserName( порядковый_номер_имени ) Область применения: без ограничений. При вызове без параметров функция во всем аналогична функции @ V3UserName, но возвращает имя в каноническом формате ([Canonicalize]). При вызове с параметром, если порядковый_номер_имени равен нулю, возвращается основное имя, если параметр равен единице возвращается альтернативное имя. Пример 1. Формула поля формы возвращает имя текущего пользователя (под ID которого работает станция), например "CN=Evgeny V Polyakov/OU=ITDep/OU=Technic/O=Center_TV/C=RU". @UserName
Пример 2. Формула поля формы возвращает альтернативное имя текущего пользователя (под ID которого работает станция), например "CN=Евгений В Поляков/OU=ОтделИТ/OU=ТехДирекция/O=ТВЦентр/C=RU". @UserName( 1 )
ϑ @Name( [формат]; имя ) @Name( [формат]; список_имен ) Область применения: без ограничений. При использовании с именами, полученными из адресных книг Lotus Notes/Domino, не работают форматы [A], [G], [I], [P], [Q] и [S]. Они предназначены для работы с именами адресов, пришедших из внешней (не Lotus Notes/Domino) почты. Функция позволяет оперировать с иерархическими именами. Иерархические имена доступны в версиях Notes/Domino, начиная с 3.0. С помощью @Name можно преобразовывать иерархическое имя в различные форматы или возвращать конкретные составляющие имени. Иерархическое имя состоит из ряда составляющих, включающих полное имя, подразделение, организацию и страну. Использование иерархических имен гарантирует, что каждый пользователь или сервер имеет свое неповторимое имя.
Разработчик базы данных отвечает за управление вводом и отображение имен пользователей в приложениях Notes/Domino. Он может предложить пользователям вводить имена в сокращенном формате, а затем с помощью @Name развернуть имена до канонического формата. И наоборот, можно отображать имена в сокращенном формате, используя @Name для преобразования хранимых в каноническом формате имен в сокращенный формат. Если используются поля типа Names, Authors или Readers, Domino автоматически преобразует введенные в них иерархические имена в соответствующий формат для отображения и хранения. Если пользователь вводит имя в сокращенном формате, при сохранении имени Domino преобразует его в канонический формат. Имя всегда отображается в поле типа Names, Authors или Readers в сокращенном формате. Если в виде отображается информация из поля, содержащего иерархическое имя, автоматическое преобразование отсутствует - имя выводится в каноническом формате. При желании можно преобразовать это имя в сокращенный формат с помощью @Name. Параметр имя используется для указания имени пользователя или сервера, над которым следует выполнить нужное преобразование. Можно задать и список имен - преобразование выполняется поэлементно и возвращается список. Параметр [формат] задает формат возвращаемого функцией имени. Он может быть одним из следующих:
• •
[Abbreviate] - при этом параметре функция выделяет из "имени" и возвращает сокращенное иерархическое имя без указателей компонентов; [Canonicalize] - возвращается имя в каноническом формате, добавляя, если необходимо, недостающие составляющие имени вместе с их метками;
•
[CN] - возвращается собственно имя без иерархических составляющих;
•
[HierarchyOnly] - возвращается иерархическое имя без компоненты [CN];
•
• 178
[ToKeyword] – аналогична [HierarchyOnly], но в возвращаемом значении заменяет символы слеш на обратный слеш и меняет порядок вывода компонент слева направо (т.е. сначала выводится компонента страны, затем организации и т. д.). Удобно использовать для категоризации в формулах колонок; [S] - возвращается компонент фамилии (last name);
[Q] - возвращается компонент префикса имени (например, Jr);
•
[C] - возвращается компонент принадлежности к стране;
•
[O] - возвращается компонент организации;
•
[OUn] - возвращается указанная составляющая подразделения из иерархического имени; n может находиться в пределах от 1 до 4, например, OU1. В канонической записи имени составляющие OU не нумеруются; однако, они пересчитываются справа налево, так что первая встреченная метка OU воспринимается как OU1, вторая - как OU2, и т.д. Domino не воспринимает [OU] (без номера) как [формат];
•
[A] - возвращается имя домена административного управления (ADMD);
•
[P] - возвращается имя домена личного управления (PRMD);
•
• •
[Address821] - возвращает, если это возможно, интернет составляющую имени в формате RFC821 в не зависимости от того в каком формате был исходный адрес, в RFC821 или RFC822. Другими словами собственно интернет адрес; [LP] - возвращается локальная часть (LocalPart) стандартного интернет адреса по формату RFC822. Другими словами часть адреса до домена; [PHRASE] - возвращается описательная часть (Phrase Part) стандартного интернет адреса по формату RFC822. Другими словами часть адреса до собственно адреса.
В R 6 появился целый ряд флагов для нахождения соответствия между информацией в Domino и LDAP:
• • •
[ToAT] – возвращается имя LDAP AttributeType при передаче функции в качестве параметра имени Domino поля; [ToField] – возвращается имя Domino поля при передаче функции в качестве параметра имени LDAP AttributeType; [ToDatatype] – возвращается имя типа данных Domino при передаче функции в качестве параметра имени LDAP Syntax;
[ToSyntax] – возвращается имя LDAP Syntax при передаче функции в качестве параметра имени типа данных Domino; [ToForm] – возвращается имя Domino формы при передаче функции в качестве параметра имени LDAP ObjectClass; [ToOC] – возвращается имя LDAP ObjectClass при передаче функции в качестве параметра имени Domino формы или подформы.
Пример 1. Возвращает Polyakov/ITDep/Technic/Center_TV/RU".
"Evgeny
V
@Name( [Abbreviate]; "CN=Evgeny V Polyakov/OU=ITDep/OU=Technic/O=Center_TV/C=RU" )
Пример 2. Возвращает "Evgeny V Polyakov". Поскольку после имени отсутствует косая черта, это не иерархическое имя, оно и в каноническом формате остается таким же. @Name( [Canonicalize]; "Evgeny V Polyakov" )
Пример 3. Возвращает Polyakov/OU=ITDep/OU=Technic/O=Center_TV/C=RU ".
@Name( [O]; "Evgeny V Polyakov/ITDep/Technic/Center_TV/RU" )
Пример 10. Возвращает "ITDep". @Name( [OU2]; "Evgeny V Polyakov/ITDep/Technic/Center_TV/RU" )
Пример 11. Возвращает "[email protected]", если в поле From находится " "Eugene" " @Name( [Address821]; From )
Пример 12. Возвращает "tveugen", если в поле From находится ""Eugene" " @Name( [LP]; From )
Пример 13. Возвращает ""Alexander M. Sizov"", если в поле From находится ""Alexander M. Sizov" " @Name( [PHRASE]; From )
Пример 14. Возвращает "givenName”. @Name([ToAT]; "FirstName")
Пример 15. Возвращает "PhoneNumber". @Name([ToField]; "homePhone")
Пример 16. Возвращает "Directory String". @Name([ToSyntax]; "Text")
Пример 17. Возвращает "Number". @Name([ToDatatype]; "Integer")
Пример 18. Возвращает "dominoServer". @Name([ToOC]; "Server")
Пример 19. Возвращает "Database". @Name([ToForm]; "dominoServerMailInDatabase")
@UserNameLanguage( порядковый_номер_языка ) Область применения: В DOMINO R 6.0.1 ДОКУМЕНТИРОВАНА.
НЕ
При параметре порядковый_номер_языка равном 1 возвращает тег альтернативного языка, ассоциированного с ID-файлом текущего пользователя. Если порядковый_номер_языка равен 0, возвращается пустая строка. Пустая строка также возвращается, если пользователь не имеет альтернативного имени.
Пример. Функция может вернуть значение "ru". @UserNameLanguage( 1 )
6.18 Функции, работающие с правами доступа @DbManager Область применения: нельзя использовать в формулах отбора и колонок. Возвращает список групп, пользователей и серверов, имеющих к текущей базе доступ менеджера. Пример. Могло быть возвращено "OtherDomainServers" : "CN=Evgeny V Polyakov/OU=ITDep/OU=Technic/O=Center_TV/C=RU" : "LocalDomainServers" @DbManager
ϑ @UserAccess( сервер : файл_базы; флаги ) Область применения: нельзя использовать в формулах отбора, колонок, фоновых агентов и всплывающих окон. В Domino R 4.х автоматически заменяется на функцию @V4UserAccess. Для локальных баз в варианте синтаксиса без второго параметра и с опущенным в ACL флагом "Enforce a consistent Access Control List across all replicas of this database." (использовать единый список управления доступом для всех реплик) всегда возвращает значение 6:1:1:1:1:1:1:1:1. Если пользователь не имеет доступа к базе, он получит сообщение: "You are not authorized to perform that operation." (Вы неавторизованы для выполнения данной операции). Не работает с оператором Evaluate LotusScript. Возвращает числовой список, элементы которого позволяют определить уровень доступа текущего пользователя к указанной БД. Пустая строка в качестве сервер означает, что база расположена локально. Необязательный параметр флаги позволяет определить уровень доступа для конкретного элемента, а не получать весь список доступа, и затем выделять из него требуемое значение. Параметр флаги может представлять собой список, состоящий из следующих значений:
[ACCESSLEVEL] – возвращает число от 1 до 6, определяющее уровень доступа пользователя к БД. При этом 1 соответствует уровню доступа Депозитора, 2 - Читателя, 3 - Автора, 4 - Редактора, 5 – Дизайнера и 6 – Менеджера; [CREATEDOCUMENTS] – возвращает 1 (True), если пользователь может создавать документы, или 0 (False) в противном случае; [DELETEDOCUMENTS] – возвращает 1 (True), если пользователь может удалять документы, или 0 (False) в противном случае; [CREATEPERSONALAGENTS] – возвращает 1 (True), если пользователь может создавать личные агенты, или 0 (False) в противном случае; [CREATEPERSONALFOLDERSANDVIEWS] – возвращает 1 (True), если пользователь может создавать личные виды/папки, или 0 (False) в противном случае; [CREATESHAREDFOLDERSANDVIEWS] – возвращает 1 (True), если пользователь может создавать общие виды/папки, или 0 (False) в противном случае; [CREATELOTUSSCRIPTJAVAAGENTS] – возвращает 1 (True), если пользователь может создавать агентов на языках LotusScript/Java, или 0 (False) в противном случае; [READPUBLICDOCUMENTS] – возвращает 1 (True), если пользователь может читать общие документы, или 0 (False) в противном случае; [WRITEPUBLICDOCUMENTS] – возвращает 1 (True), если пользователь может создавать общие документы, или 0 (False) в противном случае; [REPLICATEORCOPYDOCUMENTS] – возвращает 1 (True), если пользователь может реплицировать или копировать документы, или 0 (False) в противном случае.
Если несколько флагов задано в виде списка, то возвращается список значений, соответствующих указанным флагам. Если не выбран ни один флаг, то возвращаемый список имеет формат: [AccessLevel] : [CreateDocuments] : [DeleteDocuments] [CreatePersonalAgents] : [CreatePersonalFoldersAndViews] [CreateSharedFoldersAndViews] : [CreateLotusScriptJavaAgents] [ReadPublicDocuments] : [WritePublicDocuments]
Обратите внимание, [REPLICATEORCOPYDOCUMENTS] в параметра отсутствует.
что варианте
значение синтаксиса без
для второго
При использовании функции @UserAccess в Lotus Notes/Domino R 4 система автоматически конвертирует функцию к @V4UserAccess. Для использования функции @UserAccess в Domino R 5 или выше необходимо привести формат базы к версии R 5. В БД формата R 5 или выше, использующихся в R 4 необходимо использовать @V4UserAccess. Пример 1. Может возвратить 2:0:0:0:0:0:0:1:1, если текущий пользователь имеет доступ к общей адресной книге, как читатель, и не может не создавать новых и удалять существующие документы, а также не может создавать личных и общих агентов, личных и общих папок/видов, но может создавать и читать общие документы . @UserAccess( @Subset( @MailDbName; 1 ) : "Names.nsf" )
Пример 2. В локальной БД для текущего пользователя в ACL установлены следующие опции Editor (редактор), флаг «Replicate or copy documents» (реплицировать или копировать документы) опущен, а «Enforce a consistent Access Control List across all replicas of this database.» (распространить содержимое ACL на все реплики текущей БД) – поднят. Тогда формула поля, приведенная ниже, вернет следующее значение «0 : 4». @UserAccess(@DbName; [ReplicateOrCopyDocuments]: [AccessLevel] )
@UserRoles Область применения: нельзя использовать в формулах отбора, колонок и фоновых агентов. Предназначена для использования в БД, расположенных на сервере, или для локальных баз данных с установленным свойством "Enforce a consistent Access Control List across all replicas" (использовать единый список управления доступом для всех реплик). Для локальных баз данных без этого свойства всегда возвращает пустую строку. Возвращает текстовый список имен управления доступом текущей базы назначен ролей заключаются в квадратные скобки. пользователем, то в возвращаемом значении $$WebClient.
ролей, на которые в списке текущий пользователь. Имена Когда БД открывается Webфункции добавляется элемент
Пример. При использовании в формуле видимости объекта, скрывает его для пользователей неназначенных на роль Supervisor. @IsNotMember( "[Supervisor]"; @UserRoles )
@UserNamesList Область применения: нельзя использовать в формулах отбора, колонок, фоновых агентов, заголовка окна, навигатора и области размещения. Предназначена для использования в БД, расположенных на сервере, или для локальных БД с установленным свойством "Enforce a consistent Access Control List across all replicas" (Использовать единый список управления доступом для всех реплик). Для локальных БД без этого свойства всегда возвращает пустую строку. Функция возвращает текстовый список, содержащий уровни доступа текущего пользователя к текущей базе данных. Возвращаемый список полностью соответствует таблице, появляющейся в окне при нажатии на сектор уровней доступа строки состояния главного окна Lotus Notes.
Рис. 6.12 Сектор уровней доступа к текущей базе и окно, появляющееся при нажатии на сектор Пример. Функция может возвратить список "CN=Evgeny V Polyakov/OU=ITDep/OU=Technic/O=Center_TV/C=RU" : "Evgeny V Polyakov" : "*" : "*/OU=ITDep/OU=Technic/O=Center_TV/C=RU" : "*/OU=Technic/O=Center_TV/C=RU" : "*/O=Center_TV/C=RU" : "*/C=RU" : "[Supervisor]" : "[User]". @UserNamesList
ϑ @ServerAccess( [флаг]; имя_пользователя; имя_сервера) Область применения: нельзя использовать в формулах области размещения. Функция используется для определения уровня администраторского доступа указанного пользователя к указанному серверу. Возвращаемое значение 1 (True) – если режим доступа соответствующий флагу поддерживается, и 0 (False) – в противном случае. Под уровнями административного доступа в контексте функции @ServerAccess подразумевается параметры сервера, которые определяются в БД Domino Directory в документе Server на закладке Security в секциях Administrators и Server Access, а также в документе Configuration Settings на закладке Router/SMTP -> Message Tracking в секции Access Settings.
Рис. 6.13 Секция Administrators закладки Security документа Server
Функция @ServerAccess позволяет работать со следующими флагами:
• • • • • • • •
•
188
[ACCESS] – проверяет, имеет ли пользователь права администратора для данного сервера;
[CREATEDATABASE] – проверяет, может ли пользователь создавать БД на указанном сервере;
[CREATEREPLICA] - проверяет может ли пользователь создавать реплики БД на указанном сервере;
[CREATETEMPLATE] – проверяет, может ли пользователь создавать БДшаблоны на указанном сервере;
[DATABASEACCESS] – проверяет, имеет ли администратора на уровне БД для данного сервера;
пользователь
права
[FULLACCESS] – проверяет, имеет ли пользователь права неограниченного администратора для данного сервера;
[REMOTEACCESS] – проверяет, может ли пользователь работать с удаленной консолью сервера;
[RESTRICTEDSYSTEMACCESS] – проверяет, имеет ли пользователь права администратора для данного сервера, соответствующие возможностям запуска ограниченного набора системных команд;
[SYSTEMACCESS] – проверяет, имеет ли пользователь права администратора для данного сервера, соответствующие возможностям запуска команд операционной системы;
[TRACKMESSAGE] – проверяет, имеет ли пользователь права отслеживания почтовых сообщений без просмотра содержимого поля Subject;
[TRACKMESSAGESUBJECT] – проверяет, имеет ли пользователь права отслеживания почтовых сообщений с возможностью просмотра содержимого поля Subject;
[VIEWONLYACCESS] – проверяет, имеет ли пользователь права администратора для данного сервера, соответствующие возможностям запуска очень ограниченного набора команд консоли сервера, которые не могут повлиять на работу сервера (например, SHOW SERVER, SHOW TASKS и т.д.).
Рассмотрим остальные два параметра функции:
•
•
имя_пользователя – задает иерархическое имя пользователя (при использовании Short Name функция всегда возвращает значение 0 (False)). По синтаксису – текстовое значение нечувствительное к регистру;
имя_сервера – необязательный (за исключением использования функции в кнопках панели инструментов) параметр, задающий сервер, на котором проверяются права пользователя. Когда этот параметр опущен, то если БД, в которой выполняется функция, расположена:
• • •
на сервере, то он выступает в роли параметра имя_сервера; на локальной станции, и в ACL БД указан административный сервер, то он выступает в роли параметра имя_сервера; на локальной станции, и в ACL БД не указан административный сервер, то функция возвращает значение 0 (False).
Пример 1. Формула, используемая в кнопке панели инструментов, сначала запрашивает пользователя имя сервера, затем проверяет наличие прав на возможность создания на выбранном сервере новых БД, и при наличии прав – вызывает диалог создания новой БД. REM {Формируем список доступных серверов}; list_server := @DbColumn( "" : "NoCache"; @Subset(@MailDbName; 1) : "names.nsf"; "($Servers)"; 1); REM {Запрашиваем у пользователя имя требуемого сервера}; server := @Prompt( [OkCancelCombo]; "Выбрать сервер"; "Выберите сервер, на котором будет создаваться БД."; @Subset(@MailDbName; 1); list_server); REM {Проверяем возможность создания на выбранном сервере БД}; REM {Формула приведена исключительно ради примера}; REM сервер};
{т.к.
в
диалоге
создания
БД
требуется
повторно
выбирать
@If( @ServerAccess( [CreateDatabase]; @UserName; server )=1; @Command( [FileNewDatabase] ); @Prompt( [Ok]; "Предупреждение"; "Вы не имеете прав на создание БД"+ @Char(13) + "на сервере " + server))
6.19 Функции, работающие с профильными документами Профильные документы являются мощным средством для обмена данными между различными приложениями внутри одной или нескольких баз данных. По сути своей это скрытые документы, создаваемые по определенной форме, и которые могут хранить любые типы данных, допустимые в Domino. Доступ к профильным документам можно получить с помощью языка формул, LotusScript или Java.
Имя профильного документа совпадает с именем формы, по которой этот документ был создан. Кроме этого можно такие документы связать еще с дополнительным уникальным ключом. В версиях Domino/Notes до R 5 включительно говорилось, что профильные документы могут ассоциироваться с конкретным пользователем, т.е. для разных пользователей может существовать разные профильные документы с одним и тем же именем. Таким образом, разрешаются конфликты при одновременной работе нескольких пользователей. В одной базе данных для одного уникального ключа может существовать только один профильный документ с заданным именем. Если при создании профильного документа не был указан ключ, с которым необходимо ассоциировать конкретный профиль, то такой документ может быть только один на всю БД. При этом может существовать профили с тем же именем, но ассоциированные с разными ключами.
"Скрытость" профильных документов не только делает их невидимыми в видах и папках, но и не отображает их число в общем числе документов в окне свойств базы данных.
Создать профильный документ можно по @-команде @Command( [EditProfile]; ...), более подробно данная команда рассматривается в пункте "7.3".
У профильных документов есть важная особенность – они кешируются при работе с БД. В некоторых случаях данная возможность служит во благо, иногда нет.
@GetProfileField( "имя_профильного_документа"; "имя_поля"; "уникальный_ключ" ) Область применения: нельзя использовать в формулах отбора, колонок, видимости объекта, редактируемой секции, заголовка окна, полей, формы, акций формы и вида, и области размещения. Функция возвращает значение поля по имени "имя_поля" из профильного документа с именем "имя_профильного_документа". Третий параметр не обязателен, если он не опущен, то ищется профильный документ, связанный с указанным ключом. Возвращаемое значение имеет тот же тип, что и значение в поле профильного документа, т.е. если в поле лежит число или список дат, то возвращается соответственно число или список дат.
@SetProfileField( "имя_профильного_документа"; "имя_поля"; "значение"; "уникальный_ключ" ) Область применения: нельзя использовать в формулах отбора, колонок, видимости объекта, редактируемой секции, заголовка окна, всплывающих окон, полей, формы, и навигатора. Функция присваивает значение "значение" полю по имени "имя_поля" из профильного документа с именем "имя_профильного_документа". Четвертый параметр не обязателен, если он опущен, то ищется профильный документ общий для данной БД, иначе ищется профильный документ, связанный с указанным ключом. Если на момент вызова функции указанный профильный документ в БД отсутствует, то корректный вызов @SetProfileField принудительно создает такой документ. В таком контексте можно использовать функцию в Web-приложении для создания профильного документа (т.к. команда @Command([EditProfile]; … в Web не поддерживается), и присвоении полю этого документа указанного значения. Функция возвращает значение, соответствующее третьему аргументу функции, т.е. "значение". Хотя в документации сказано, что тип параметра "значение" должен быть текстовый, из опыта известно, что функция корректно работает, и если в качестве третьего параметра выступают числа, "дата-время" или списки, составленные из этих типов. Соответственно при этом возвращаемое значение имеет тот же тип, что и у третьего аргумента.
Пример. Предположим у нас есть два агента Agent1 и Agent2. Agent1 производит некоторые вычисления, и затем значение, хранящееся во временной переменной Ch, записывает в поле Result профильного документа Work (таким образом, он передает параметры Agent2). После этого он вызывает Agent2: @SetProfileField( "Work"; "Result"; Ch; @UserName ); @Command( [ToolsRunMacro]; "Agent1" );
Agent2 считывает вычисленное Agent1 значение в свою временную переменную Ch1 и продолжает вычисления. Ch1 := @GetProfileField( "Work"; "Result"; @UserName );
6.20 Функция выбора требуемого фрейма @SetTargetFrame( "имя_фрейма" ) Область применения: предназначена для работы в формулах акций, гиперобъектов, кнопок панели инструментов и агентов, запускаемых вручную. За функцией должна следовать одна из команд: @Command( [OpenFrameset] ), @Command( [OpenPage] ), @Command( [OpenView] ), @Command( [Compose] ), @Command( [EditDocument] ), @Command([RefreshFrame]). Функция не выполняется, если за ней следует команда @Command( [OpenView] ), у которой не опущен параметр "окно". В случае если за функцией следует команда @Command( [OpenView] ), у которой опущен параметр "вид", то открывается вид, который перед вызовом функции последний раз открывался во фрейме с именем "имя_фрейма". Функция не выполняется, если за ней следует команда @Command([RefreshFrame]) , у которой не опущен параметр "целевой_фрейм". Функция определяет фрейм, в пределах которого должен быть открыт объект, указанный в следующей за функцией команде. Может быть использована для открытия в рамках фрейма видов, страниц, набора фреймов, или документов в режиме создания или редактирования. Параметр "имя_фрейма" определяет требуемый фрейм. Из личного опыта функция также работает совместно с @URLOpen, как в браузере, так и в клиенте Notes. Пример 1. Открывает во фрейме с именем "Second" вид с именем "View1".
Пример 2. Открывает в новом окне главную страницу сайта lotus.com. @SetTargetFrame( "_blank" ); @URLOpen( "http://www.lotus.com" )
6.21 Диалог с пользователем ϑ @Prompt( [стиль]: [NoSort]; "заголовок"; "текст"; "по_умолчанию"; "выбор"; "тип_файла") Область применения: нельзя использовать в формулах отбора, колонок, почтовых агентов и агентов, выполняющихся по расписанию, видимости объекта и всплывающих окон. Ограниченно применима в формулах заголовка окна и формы. Не работает при установке переменной окружения NoExternalApps равной 1. В Web-приложениях не работает. @Prompt используется для запроса информации у пользователя. Функция показывает диалоговое окно заданного стиля, с заданным заголовком и текстом, и содержащее информацию из остальных параметров. Большинство стилей предполагают однозначный ответ и возвращают его как текстовую строку. Другие стили позволяют пользователю ввести или выбрать более одного значения.
Параметр [стиль] определяет внешний вид диалогового окна. Он задается одним из приведенных в таблице ключевых слов. Ключевые слова вводятся в квадратных скобках. Параметр [стиль] является обязательным.
Сообщение и кнопку OK. Используется для информационных сообщений. Использует только параметры [стиль], "заголовок" и "текст".
1 (TRUE).
[YesNo]
Сообщение и кнопки Yes и No. Позволяет принимать решение Да/Нет. Использует только параметры [стиль], "заголовок" и "текст".
1 (TRUE), если нажата кнопка Yes, или 0 (FALSE), если нажата кнопка No.
[YesNoCancel]
Сообщение и кнопки Yes, No и Cancel. Позволяет принимать решение Да/Нет или отказаться от принятия решения. Использует только параметры [стиль], "заголовок" и "текст".
1 (TRUE), если нажата кнопка Yes; 0 (FALSE), если нажата кнопка No; -1, если нажата кнопка Cancel.
[OkCancelEdit]
Сообщение, подокно для ввода текста (с содержимым по умолчанию) и кнопки OK и Cancel. Использует только параметры [стиль], "заголовок" и "текст" и "по умолчанию".
Если нажата кнопка Ok, возвращается первые 254 байта введенного пользователем текста. Если нажата кнопка Cancel, ничего не возвращается, поскольку выполнение всей формулы завершается.
[OkCancelList]
Сообщение, список значений для выбора (с отмеченным значением по умолчанию) и кнопки OK и Cancel. Пользователь выбирает только одно значение из списка. Использует пять первых параметров.
Eсли нажата кнопка Ok, возвращается выбранное пользователем значение. Eсли нажата кнопка Cancel, ничего не возвращается, поскольку выполнение всей формулы завершается. Если выбор по умолчанию в функции не был сделан, а пользователь нажал кнопку OK , не выбрав никакого элемента, возвращается число 1.
[OkCancelCombo]
Сообщение, выпадающий список значений для выбора (с показанным в
Eсли нажата кнопка Ok, возвращается выбранное пользователем значение.
верхнем текстовом подокне значением по умолчанию) и кнопки OK и Cancel. Пользователь выбирает только одно значение из списка. Заметьте, что значение по умолчанию показывается только, если оно содержится в списке возможных выборов; в противном случае текстовое подокно остается пустым. Использует пять первых параметров.
Eсли нажата кнопка Cancel, ничего не возвращается, поскольку выполнение всей формулы завершается. Если выбор по умолчанию в функции не был сделан, а пользователь нажал кнопку OK , не выбрав никакого элемента, возвращается пустая строка.
[OkCancelEditCombo]
Сообщение, выпадающий список значений для выбора (с показанным в верхнем текстовом окне значением по умолчанию) и кнопки OK и Cancel. Пользователь вводит значение или выбирает его из списка. Подобно [OkCancelEdit], но позволяет пользователю вводить значения, не указанные в списке. Использует пять первых параметров.
Eсли нажата кнопка Ok, возвращается выбранное, введенное или измененное пользователем значение. Eсли нажата кнопка Cancel, ничего не возвращается, поскольку выполнение всей формулы завершается.
[OkCancelListMult]
Сообщение, список значений для выбора и кнопки OK и Cancel; пользователь выбирает одно или несколько значений из списка. Подобно [OkCancelList]. Этот стиль использует все пять параметров.
Eсли нажата кнопка Ok, возвращается список выбранных пользователем значений. Eсли нажата кнопка Cancel, ничего не возвращается, поскольку выполнение всей формулы завершается. Если выбор по умолчанию в функции не был сделан, а пользователь нажал кнопку OK , не выбрав никакого элемента, возвращается число 1.
файлов для выбора относительно директории \NOTES\DATA и кнопки Select, Cancel и Help; пользователь выбирает одно значение из списка. Использует только параметры [стиль], "заголовок" и "тип_файла".
возвращается выбранное пользователем имя файла с полным путем и расширением. Eсли нажата кнопка Cancel, ничего не возвращается, поскольку выполнение всей формулы завершается. Если пользователь нажал кнопку Select , не выбрав никакого элемента, окно остается модальным. При нажатии Help выдается соответствующий раздел из базы справки по клиентской программе.
[Password]
Сообщение, подокно для ввода пароля (введенная информация в нем не отображается) и кнопки OK и Cancel. Использует только параметры [стиль], "заголовок" и "текст".
Eсли нажата кнопка Ok, возвращается введенный пользователем пароль. Eсли нажата кнопка Cancel, ничего не возвращается, поскольку выполнение всей формулы завершается.
[ChooseDatabase]
Окно со списком файлов баз данных для выбора и открытия, и кнопки Open, Cancel, Select, About и Browse. Согласно документации функция с данным ключевым словом должна использовать только параметры [стиль], "заголовок" и "выбор". Из личного опыта (подтвержденного bug report) в версии R 6.0.1 параметры "заголовок" и "выбор" работают некорректно.
Возвращает трехэлементный список (имя сервера, имя файла и заголовок базы данных. Для локальных БД в качестве имя сервера возвращается пустая строка.
Ключевое слово [NoSort] необязательно. Если оно присутствует, то это предотвращает сортировку в алфавитном порядке значений из списка
"по_умолчанию" при выводе в подокно списка или выпадающего списка диалогового окна. Для параметра "заголовок" задается текст, который должен быть показан в заголовке диалогового окна. Заголовок окна должен быть указан всегда, если его нет - задается пустая строку "". Максимальное число символов в строке "заголовока" 65. Для параметра "текст" задается текст сообщения, который должен быть показан внутри окна. Параметр должен быть указан всегда, за исключением [LocalBrowse] (и скорее всего [ChooseDatabase]). Если в качестве "текста" используется формула, возвращающая текстовый список, в окне будет показан только первый элемент этого списка. Чтобы показать весь список, используйте @Implode. @NewLine нельзя использовать в параметре "текст", вместо нее рекомендуется использовать @Char(13) для перевода текста на новую строку. Максимальное число символов в строке "текст" 255. В параметре "по_умолчанию" определяется для вводимой пользователем строки значение по умолчанию. Это значение будет появляться в строке ввода при открытии окна; пользователь может принять его, выбирая OK, или заменить его другим значением. Значение "по_умолчанию" предназначено для использования со всеми стилями за исключением: [Ok], [YesNo], [YesNoCancel], [LocalBrowse], [Password] (и скорее всего [ChooseDatabase]). В качестве параметра "выбор" задается список значений, которые нужно поместить в подокне списка диалогового окна. Список "выбор" должен указываться в следующих стилях: [OkCancelList], [OkCancelCombo], [OkCancelEditCombo] и [OkCancelListMult] (и скорее всего [ChooseDatabase]). Параметр "тип_файла" применим только к стилю [LocalBrowse]. В этом контексте определяет текст файла для показа:
Пример 1. Стиль [Ok]. @Prompt( [Ok]; "Напоминание"; "Не
забудьте
сегодня
вечером
выполнить
резервное
копирование." )
Рис. 6.16 @Prompt([Ok];…)
Пример 2. Стиль [YesNo]. @Prompt( [YesNo]; "Отправить сообщение?"; "Это сообщение будет отправлено указанным в поле " + @Char( 13 ) + @Char( 10 ) + "Кому, Копия и Секретная копия лицам." )
Пример 7. Стиль [OkCancelEditCombo]. @Prompt( [OkCancelEditCombo]; "Выбрать базу данных"; "Выберите базу данных для открытия или введите ее название."; "Расписание"; "Расписание" : "Телефонная книга" : @Subset ( @MailDbName; -1 ))
Рис. 6.22 @Prompt([OkCancelEditCombo];…)
Пример 8. Стиль[OkCancelListMult]. @Prompt( [OkCancelListMult]; "Выбрать имя"; "Выберите одно или более имен получателей этого запроса."; "Елена Наумова"; "Елена Наумова" : "Андрей Ефремов" : "Борис Иванов" : "Леонид Решко" )
@PickList( [Custom] : [Single]; "сервер": "база_данных"; "вид"; "заголовок"; "текст"; номер_столбца; "ключ" ) @PickList( [Name] : [Single] ) @PickList( [Room] ) @PickList( [Resource] ) @PickList( [Folders] : [тип_папки] : [Single]; "сервер" : "база_данных" ) Область применения: нельзя использовать в формулах отбора, колонок, почтовых агентов и агентов, выполняющихся по расписанию, видимости объекта, заголовка окна, всплывающих окон и формы. Не работает при установке переменной окружения NoExternalApps равной 1. В Webприложениях не работает. Вариант @PickList( [Custom];…) выдает модальное диалоговое окно, в котором выводится содержимое базы данных "сервер" : "база_данных" по указанному "виду". В этом модальном окне пользователь может выбрать (отметить) один или более документов при первом параметре - [Custom], или только один документ при первом параметре - [Custom] : [Single]. Функция @PickList возвратит значение из указанного столбца "номер_столбца" этого "вида" для выбранных документов. Двухэлементный текстовый список "сервер" : "база_данных" определяет сервер и файл базы, из которой выбирается вид. Если задать элемент "сервер" равным "", будет предполагаться, что база расположена локально. Если вместо двухэлементного списка задать "", вид будет выбран из текущей базы. В случае если первый параметр [Custom] можно в качестве аргумента "сервер" : "база_данных" задавать значение идентификатора реплики, например "85255CEB:0032AC04" (как одну текстовую строку, а не список из двух элементов), подобно тому, как это допускается в функциях @DbColumn и @DbLookup. Параметр "вид" - текстовая строка, содержащая имя открываемого в диалоговом окне вида. Параметр "заголовок" задает текст, выводимый в заголовок диалогового окна, а "текст" - текст, выводимый в само диалоговое окно. Числовой параметр номер_столбца задает номер столбца в виде, из которого функция будет выбирать значения. Обратите внимание, что в отличие от функций @DbColumn и @DbLookup номер столбца для @PickList не зависит от формулы для этого столбца, все столбцы пронумерованы слева направо начиная с единицы.
только
Параметр "ключ" необязателен, при его задании в виде показываются те документы, которые содержат значение ключ в первой
отсортированной и обязательно категоризованной колонке данного вида. По поводу данного параметра следует сделать замечание. По синтаксису данный параметр должен иметь текстовой тип (синтаксический анализатор не дает сохранить формулу с другим типом данных). Однако если значение в колонке имеет другой тип данных (например, числовой или дата-время), а параметр имеет аналогичное значение преобразованное к тексту, то функция работает некорректно. При использовании параметра "ключ" функция @PickList не кеширует информацию в отличие от @DbColumn и @DbLookup, поиск осуществляется каждый раз при новом вызове функции. Размер возвращаемых функцией данных имеет точно такие же ограничения что и у функций @DbColumn и @DbLookup. Обратите внимание, что это ограничения только на размер возвращаемых значений по кнопке Ok (обычно актуально при множественном выборе), сама же функция @PickList имеет доступ ко всем данным вида. При отображении календарного вида в рамках @PickList, последний выводится без слота времени и в формате отображающем два дня календаря, включая текущий. Пользователь в дальнейшем может изменить формат отображения, а также осуществлять навигацию по календарю. Вариант @PickList( [Name] : [Single] ) выводит диалоговое окно, содержащее информацию из доступных адресных книг. Пользователь может выбрать одно или более лиц, групп или серверов, а функция @PickList вернет выбранные им имена. Ключевое слово [Single] не обязательно. Оно указывает, что разрешен выбор только одного имени. Варианты @PickList( [Room] ) и @PickList( [Resource] ) выдают диалоговые окна с информацией о ресурсах и комнатах из доступных адресных книг. Вариант @PickList( [Folders] : [тип_папки] : [Single]; "сервер" : "база_данных" ) выводит диалоговое окно, содержащее информацию об имеющихся папках в "базе_данных". Пользователь может выбрать одну или более папок, а функция @PickList вернет выбранные им имена. Ключевое слово [Single] не обязательно. Параметр [тип_папки] следующих значений:
• •
206
необязателен,
и
может
принимать
одно
[Shared] для отбора только общих папок; [Private] для отбора только личных папок, как сохраняемых в базе данных, так и в файле desktop;
[Shared]:[Private] для отбора только общих до первого использования папок; [NoDesktop] для отбора всех папок, за исключением сохраняемых в файле desktop. Если параметр [тип_папки] опущен, выводятся все папки.
Пример 1. Формула кнопки позволяет пользователю выбрать папку, в которую надо поместить текущий документ. choice := @PickList( [Folders]; "" ); @AddToFolder( choice; "" )
Рис. 6.27 Пример окна @PickList([Folder]) Пример 2. Формула кнопки позволяет пользователю выбрать список пользователей, групп и серверов в качестве значения поля person. FIELD person := person; @SetField( "person"; @PickList( [Name] ) )
Рис. 6.28 Пример окна @PickList([Name]) Пример 3. Формула открывает вид Otdel из базы с идентификатором реплики "C32566DC:00520B5F" в диалоговом окне. Предположим, пользователь отметил в окне документ, для которого во второй колонке вида отображается "Тома Р.О.". Временная переменная choice получит значение: "Тома Р.О.". сhoice :=@PickList( [Custom] : [Single]; "C32566DC:00520B5F"; "Otdel"; "Выбор сотрудника"; "Выберите сотрудника"; 2 );
Рис. 6.29 Пример окна @PickList([Custom]:[Single];...) Пример 4. Выводит диалоговое окно с информацией о имеющихся комнатах из адресных книг. @PickList( [Room] );
Рис. 6.30 Пример окна @PickList( [Room] ) Пример 5. Выводит диалоговое окно с информацией об имеющихся ресурсах из адресных книг. @PickList( [Resource] );
ϑ @DialogBox( "форма"; [AutoHorzFit] : [AutoVertFit] : [NoCancel] : [NoNewFields] : [NoFieldUpdate] : [ReadOnly] : [SizeToTable] : [NoOkCancel] : [OkCancelAtBottom]; "заголовок" ) Область применения: нельзя использовать в формулах отбора, колонок, агентов выполняющихся на сервере (почтовые и по расписанию), заголовка окна и формы. Не возвращает данные из RTF-полей. Не работает при установке переменной окружения NoExternalApps равной 1. В Webприложениях не работает. Открывает в модальном диалоговом окне текущий документ по указанной форме "форма". Пользователь получает возможность работы с документом в диалоговом окне, причем он не может переключиться в другое окно Notes, пока не закроет этот диалог кнопкой OK или Cancel. Ключевые слова [AutoHorzFit] и [AutoVertFit] не обязательны, указываются в случае, если форма представляет собой область размещения (layout region), и диалоговое окно следует "подгонять" под размеры области размещения по горизонтали и (или) по вертикали. Такая возможность может использоваться с любой формой, но она особенно полезна с формами, которые содержат одну область размещения, потому что пользователь может работать с этой областью, как с диалоговым окном. Однако если в форме присутствует более одной области размещения, в диалоговом окне будет выведена только первая область.
Рис. 6.32 Пример формы c областью размещения в диалоговом окне Параметр [NoCancel] не обязателен, указывается необходимости, подавления в диалоговом окне кнопки Cancel.
в
случае
Параметр [NoNewFields] не обязателен, указывается, когда нужно не добавлять в текущий документ поля, которые есть в "форме", но нет в исходной форме. Параметр [NoFieldUpdate] не обязателен, указывается, когда нужно не переносить изменения из полей "формы" в текущий документ. Используется обычно в случае, если значения из этих полей переносятся в другое место (например, по событию QueryClose "формы") Параметр [ReadOnly] не обязателен, указывается в случае необходимости запрета ввода информации в поля диалогового окна (например, при выводе справки). Используется вместе с ключевым словом [NoCancel].
Параметр [SizeToTable] не обязателен, указывается в случае необходимости “подгонки“ диалогового окна под размеры первой таблицы в "форме". Используется только совместно с флагами [AutoHorzFit] и [AutoVertFit]. Из опыта следует заметить, что правильно подгоняются только таблицы в стандартном интерфейсе (т.е. не таблицы с закладками и т.д.).
Параметр [NoOkCancel] не обязателен, указывается в случае необходимости подавления вывода кнопки Ok. Рекомендуется использовать совместно с флагом [NoCancel]. В этом случае для передачи данных из модальной формы в основную можно использовать гиперобъект (например, кнопка) модальной формы с @-командой [RefreshParentNote].
В R 6 появился еще один необязательный параметр [OkCancelAtBottom], позволяющий осуществить вывод кнопок Ok и Cancel (если они присутствуют) в строчку в правом нижнем углу диалогового окна.
Параметр "заголовок" не обязателен, указывается для изменения заголовка окна со стандартного "Lotus Notes" на "заголовок".
Явное возвращаемое значение у функции отсутствует.
При работе с одним и тем же документом по разным формам действуют следующие соглашения:
•
•
•
если "форма" имеет общие (одноименные) поля с текущим документом, значения полей из текущего документа выводятся в диалоговом окне. Rich Text поля (несмотря на указание противного в документации) также отображаются в диалоговом окне; при изменении значение какого-то поля в диалоговом окне и нажатии на кнопку Ok, эти изменения будут отражены в соответствующих полях текущего документа (если, разумеется, не указан флаг [NoFieldUpdate]). Так же не передаются изменения из Rich Text полей; если пользователь вводит значение для поля в диалоговом окне, но текущий документ не содержит поля с таким именем, поле и значение добавляются в документ, даже если в основной форме для показа этого документа такого поля нет (если, разумеется, не указаны флаги [NoNewFields] и/или [NoFieldUpdate]). Пример 1. Форма с именем Profile содержит кнопку с формулой
Предположим, что в обеих формах Profile и Profile Options присутствует поле Comments, но вторая форма представляет собой область размещения и специально создана для удобства редактирования поля Comments. Пользователь, находясь в режиме редактирования документа (по форме Profile), нажимает рассматриваемую кнопку. Документ открывается в диалоговом окне по
форме Profile Options. После редактирования новое значение поля Comments "поступает" в документ. Пример 2. Формула, демонстрирует “подгонку“ диалогового окна под первую таблицу в форме “Form1“, а также действие флага [OkCancelAtBottom]. @DialogBox("Form1";[AutoHorzFit] : [AutoVertFit] : [SizeToTable] : [OkCancelAtBottom]
;"Пример
\"подгонки\" @DialogBox под таблицу" )
Рис. 6.33 «Подгонка» диалогового окна под размеры таблицы
ϑ @StatusBar( строка ) @StatusBar( список_строк ) Область применения: предназначена для использования только в формулах кнопок панели инструментов, заголовка окна, гиперобъектов, полей, акций видов и формы, а также навигатора. В Web-приложениях не работает. Выводит в строку состояния клиента Notes сообщение, состоящее из строки, или если параметр представляет собой список строк, то выводится несколько сообщений, каждое из которых состоит из одного элемента списка_строк. Пример. Выводит сообщение в строку состояния. @StatusBar("Обрати внимание – на мои страдания");
@DbCommand( "Domino"; "ViewPreviousPage") @DbCommand( "Domino"; "ViewNextPage") ϑ @DbCommand( "Domino"; "FolderList" [;"заголовок"[;"список_исключений" ]] ) Область применения: в DOMINO R 6.0.1 ДОКУМЕНТИРОВАНА НЕ ПОЛНОСТЬЮ. Разрешается использовать только в Web-приложениях. В первом варианте синтаксиса организует ссылку на предыдущий документ в виде, во втором на последующий. Третий вариант новый в R 6, при использовании в формулах полей типа список выводит имена доступных из-под Web-папок. Необязательный параметр заголовок определяет первый элемент получаемого списка. Если список доступных папок пуст, то заголовок не выводится. Список_исключений может задавать имена папок (то же в виде списка), которые не будут отображаться в результирующем списке. Данная команда может использоваться совместно с функцией @AddToFolder для помещения текущего документа в выбранную папку. Пример. Под Web доступны папки с именами Folder1, Folder2 и Folder3. Нижеприведенная формула, используемая в формуле поля, выдаст список доступных папок за исключением Folder2 (см. Рис. 6.35). @DbCommand("Domino" ; "FolderList" ; "Выберите папку";"Folder2")
Рис. 6.35 Вариант выбора папок через @DbCommand("Domino" ; "FolderList") В вышеприведенном примере можно было добавить на форму акцию (либо кнопку), которая помещает текущий документ в выбранные в поле My_folders папки. Формула этой кнопки может быть следующая: @If(
Существует еще один способ помещения документов в папку с использованием @DbCommand("Domino" ; "FolderList"; …). Это достигается следующим образом:
• • • •
присвоим полю с формулой @DbCommand("Domino" ; "FolderList"; …) зарезервированное имя $$SelectDestFolder; разместим на этой же форме встроенный вид, у которого поднят флаг Allow selection of documents в его окне свойств на закладке Advanced; в окне свойств встроенного вида как элемента дизайна установить значение Using HTML для поля Display с закладки Info, и поднять флаг Show selection margin с закладки Display; создать акцию формы с формулой @Command([FolderDocuments]; ""; "0"). Клик по кнопке акции будет вызывать помещение выделенного во встроенном виде документа в папку, выбранную в поле $$SelectDestFolder. Если на форму встроена папка (а не вид), то для акции формы можно использовать команду @Command([FolderDocuments]; ""; "1") для перемещения, а не копирования выделенного документа.
Про описанный выше метод следует уточнить, что работает он только для первого выбранного во встроенном виде документа, а также только для первой выбранной папки в поле $$SelectDestFolder (при поднятом флаге Allow multiple values).
6.22 Функции, определяющие тип и характеристики используемого программного обеспечения @ClientType Область применения: нельзя использовать в формулах отбора, колонок, редактируемых, секциях заголовка окна. При использовании в формулах фоновых агентов всегда возвращает значение "None". Возвращает текстовую строку "Notes", если для доступа к базе данных используется клиентская программа LN, "Web" - в случае использования браузера. Очень часто применяется в формулах видимости объектов, для скрытия не работающих в браузерах компонент. Пример. При использовании в формуле видимости объекта, скрывает его при работе в браузере. @If( @ClientType = "Web"; 1; 0 )
@Platform @Platform( [SPECIFIC] ) Область применения: без ограничений. При использовании в формулах отбора, колонок и фоновых агентов возвращает платформу, согласно местонахождению базы данных. Для серверных баз данных - платформу сервера, для локальных баз данных соответственно платформу клиента LN. В остальных формулах возвращает серверную платформу. В Web-приложениях возвращает только серверную платформу. Возвращает текстовый список или строку, определяющую платформу сервера. При вызове с параметром выдает более полную информацию. Так как не все элементы приложений Domino могут работать на разных платформах, то функция может быть использована в целях обеспечения переносимости программного обеспечения. При использовании флага представляет собой текстовый операционной системы, версии вторичной операционной системы
216
[SPECIFIC] возвращаемое значение обычно список, состоящий из имени первичной первичной операционной системы, имени и версии вторичной операционной системы.
Так, например, для Windows 3.11, которая запускается из-под MS-DOS 6.22, функция вернет список: "Windows/16":"3.11":"MS-DOS":"6.22". Для UNIX-платформ возвращается только имя операционной системы без ее версии. При вызове без параметра возвращаемое значение может быть одним из следующих: Windows/16, Windows/32, MS-DOS, OS/2v1, OS/2v2, OS/400, Macintosh, UNIX, NetWare. При использовании флага [SPECIFIC] имя имени первичной операционной системы может быть одним из следующих: Windows/16, Windows/95, Windows/NT, MS-DOS, NetWare, Macintosh/68K, Macintosh/PowerPC, OS/2v1, OS/2v2, IBM OS/400, IBM OS/390, AIX, UNIXWARE, HP UNIX, SUN Sparc, SOLARIS x86, SOLARIS Sparc, SCO OpenDeskTop, Linux. Пример. Может вернуть значение "Windows/NT" : "5.0". @Platform( [SPECIFIC] )
@Version Область применения: без ограничений. При использовании в формулах отбора, колонок и фоновых агентов возвращает версию Lotus Notes/Domino, согласно местонахождению базы данных. Если она находится на сервере, то для сервера, и для локальной базы данных соответственно версию клиента LN. В остальных формулах возвращает версию рабочей станции. Возвращает текстовую строку соответствующую релизу версии Lotus Notes/Domino согласно следующей таблице:
Возвращаемое значение 114
Соответствует версии Lotus Notes/Domino Lotus Notes 3.x
Функция может использоваться в целях обеспечения переносимости программного обеспечения.
Пример. В формуле поля, выполяняющейся на станции с установленной версией Notes/Domino R 6.0.1 вернет "190". @Version
@RegQueryValue( "имя_ключа"; "имя_подключа"; "имя_значения" ) Область применения: В DOMINO R 6.0.1 НЕ ДОКУМЕНТИРОВАНА. Для не Windows-платформ возвращает пустую строку. Возвращает значение ключей из Windows-реестра.
@IsAppInstalled( "имя_клиентского_ПО" ) Область применения: нельзя использовать в формулах отбора и редактируемой секции. Функция, в зависимости от параметра "имя_клиентского_ПО", возвращает 1 (TRUE), если данное программное обеспечение установлено на рабочей станции, и 0 (FALSE) в противном случае.
Параметр "имя_клиентского_ПО" может принимать значение "Designer" соответствует дизайнерскому ПО, и "Admin" - администраторскому ПО.
Пример. Возвращает дизайнерское ПО.
1,
если
на
рабочей
станции
установлено
@IsAppInstalled( "Designer" )
@BrowserInfo( "имя_свойства") Область применения: нельзя использовать в формулах отбора, колонок и агентов. Не работает в клиенте Notes ниже 5-й версии. Определяет и возвращает параметры используемого Возвращаемое значение определяется согласно таблице:
Имя свойства
BrowseType
браузера.
Тип возвращаемого значения
Возвращаемое значение для браузера
Возвращаемое значение клиента LN
Текстовое
"Microsoft",
"Notes"
для
"Netscape", "Compatible" (для браузеров совместимых с Netscape, включая
6.23 Функции, используемые в Webприложениях @URLOpen @URLOpen( "URL"; флаги; "MIME_набор_символов"; "имя_web_пользователя"; "web_пароль"; "имя_пользователя_для_прокси_сервера"; "пароль_для_прокси_сервера") Область применения: нельзя использовать в формулах отбора, колонок, видимости объекта, редактируемой секции, заголовка окна, полей и формы. В первом варианте синтаксиса (т.е. без параметров) функция в интерфейсе клиента Notes открывает (если не было открыто ранее) в панели инструментов поле задания URL, и устанавливает на него фокус. Данный синтаксис в Web-приложениях не поддерживается. Во втором варианте синтаксиса функция может быть использована как в клиенте Notes, так и в браузере. Первый параметр "URL" обязателен, и задает адрес Web-ресурса, который требуется открыть. Остальные параметры необязательные, и предназначены для использования в Notes браузере в контексте баз данных "Server Web Navigator" и "Personal Web Navigator". Рассмотрим эти параметры подробнее:
•
флаги – определяют параметры перезагрузки запрашиваемой страницы, а также принудительного сохранения всех ссылок с запрашиваемой страницы. Данные операции имеют смысл только в рамках баз данных "Server Web Navigator" и "Personal Web Navigator". Если необходимо опустить параметр флаги, но определить следующие за ним параметры, то для флаги нужно указать значение 0 (например, @URLOpen( "http://www.ibm.com"; 0; "myusername"; "mypassword" ) ). С точки зрения синтаксиса, параметр флаги может быть списком из следующих значений:
• • •
222
[RELOAD] – перегружает страницу с интернет сервера; [RELOADIFMODIFIED] – перегружает страницу, только если она была изменена на интернет сервере; [URLLIST] – сохраняет все гиперссылки с запрашиваемой страницы в полях URLLinksN. Первое поле будет называться URLLinks1, далее, когда содержимое этого поля превысит размер в 64К, то будет создано новое поле под ссылки с именем URLLinks2 и т.д. Впоследствии можно использовать эти поля
(например, в агенте) для актуализации данных ссылок. Включение данного флага может серьезно сказаться на производительности приложения.
•
•
•
"MIME_набор_символов" – принудительно устанавливает указанный символьный набор MIME для указанной страницы. Предназначен для использования в случае, когда Web Navigator определяет символьный набор MIME некорректно; "имя_web_пользователя" и "web_пароль" – предназначены для задания имени/пароля при обращении к ресурсу, требующему аутентификации. Данные параметры применимы только в контексте Notes Web Navigator, в других браузерах для аутентификации используются свои средства; "имя_пользователя_для_прокси_сервера" и "пароль_для_прокси_сервера" – предназначена для аутентификации в рамках прокси сервера. Наиболее часто функция применяется с одним параметром "URL".
Если требуется открывать указанную страницу в другом фрейме, то в документации приводится решение с добавлением в параметр "URL" атрибута target, заключенного в кавычки. Данная конструкция (учитывая, что в документации пример приведен с синтаксической ошибкой) у автора к нужным результатам не привела. Однако, применение перед @URLOpen функции @SetTargetFrame решает поставленную задачу. Пример. Формула, примененная в кнопке формы, открывает в новом окне сайт lotus.com. @SetTargetFrame( "_blank" ); @URLOpen( "http://www.lotus.com" )
ϑ @URLEncode( "формат"; значение ) Область применения: без ограничений. Преобразует значение, представленное в виде строки или списка строк, к формату пригодному для использования в URL. Параметр "формат" может задаваться в виде имени символьного набора MIME (например, "KOI8-R" или "ISO-8859-1") или в виде одной из двух предопределенных строк:
"Domino" – соответствует символьному набору MIME "UTF-8"; "Platform" – преобразует параметр значение в соответствии с базовым символьным набором операционной системы.
Функция преобразует не-ASCII символы второго параметра в указанный символьный набор, а затем кодирует их в формат %XX, где XX есть шестнадцатеричное представление символа.
В Domino 5-й версии разработчики достаточно часто использовали эту функцию в Web-приложениях, однако на тот момент она была недокументированна. Кроме этого при переходе к 6-й версии Domino изменился набор допустимых значений параметра "формат".
Функция бывает очень полезна при передаче через URL параметров, значения которых не укладывается в ASCII набор символов.
Пример. Формула, примененная в кнопке формы, открывает Webстраницу, получаемую в результате поиска фразы "перезагрузка сервера" на форуме компании «Интертраст».
ϑ @URLDecode( "формат"; значение ) Область применения: без ограничений. Выполняет обратное преобразование по отношению к функции @URLDecode. Синтаксис и смысловое значение параметров "формат" и значение соответствует функции @URLEncode.
Пример. Если форма открывается в Web-приложении по URL вида «… имя_БД/имя_формы?OpenForm&FIO=%CF%EE%EB%FF%EA%EE%E2%20%C5. %C2.», то для того, чтобы присвоить некоторому полю значение из параметра FIO из URL, достаточно определить для него следующую Defaut Value формулу:
@URLDecode( "Platform"; @UrlQueryString( "FIO" ))
Следует заметить, что значение параметра FIO из URL было предварительно получено с использованием функции @URLEncode, так же с первым параметром "Platform".
ϑ @GetHTTPheader( "имя_header_поля" ) Область применения: разрешается использовать только в Web-приложениях и в контексте видимости объекта, редактируемой секции, заголовка окна, гиперобъекта, полей, формы, акций вида и формы, а также навигатора. В интерфейсе клиента Notes всегда возвращает пустую строку. В Web-приложениях возвращает значение полей типа header fields (более подробно о них можно посмотреть в документе http://www.w3.org/Protocols/rfc1945/rfc1945 раздел 10 «Header Field Definitions»). Значения имя_header_поля могут принимать допустимые значения для полей типа header fields (например, User-Agent, Last-Modified, Content-Type и т.д.).
Пример. Следующая формула в Web-приложении без использования в форме CGI-поля "HTTP_User_Agent", возвращает значение, например, «Mozilla/4.0 (compatible; MSIE 5.01; Windows NT 5.0)» @GetHTTPHeader( "User-Agent" )
ϑ @SetHTTPHeader( "имя_response_header_поля"; значение ) Область применения: нельзя использовать в формулах кнопок панели инструментов, колонок, любых типов агентов, видимости объекта, редактируемой секции, всплывающих окон и области размещения.
В Web-приложениях устанавливает значение для полей заголовка HTTP-отклика (response header field). Подробнее о данном типе полей можно посмотреть в документе RFC 2616 (http://www.w3.org/Protocols/rfc2616/rfc2616.html, http://book.itep.ru/4/45/http4561.htm).
Возвращает значение 1 (TRUE) – при успешной установке значения полю, и 0 (FALSE) в противном случае. В интерфейсе клиента Notes функция всегда возвращает 0 (FALSE).
Параметр имя_response_header_поля задается текстовой строкой, и определяет имя поля, которому требуется установить значение. Некоторые поля заголовка HTTP-отклика доступны только для чтения (например, Connection, Content-Type, Date и Server), и поэтому не могут быть изменены функцией @SetHTTPHeader. Следует еще помнить, что помимо строго полей заголовка HTTP-отклика, в качестве параметра имя_response_header_поля могут использоваться общие поля заголовка (general header field).
Параметр значение представляет собой значение для поля заголовка HTTP-отклика. Формат параметра соответствует ожидаемому значению, и может быть текстовой строкой, числом или датой. В последнем случае параметр должен быть в формате RFC 1123 (например, «Sun, 09 Nov 2003 08:49:37 GMT»). Пустая строка в качестве значения удаляет соответствующее поле вместе со значением (данное утверждение автор не смог проверить на практике).
Пример 1. На форме разместим две кнопки. Для первой определим заголовок (Label) «Установить Cookie», затем в программной панели для поля Run выберем значения «Client» и «Formula», а в качестве формулы введем: @SetHTTPHeader("Set-Cookie"; "My_Proba=777")
Для второй кнопки определим: Label – «Прочитать Cookie», Run – «Web» и «JavaScript», код: alert(getCookie('My_Proba'));
В объект JS Header формы внесем следующий код: function getCookie(name) { var prefix = name + "=" var cookieStartIndex = document.cookie.indexOf(prefix) if (cookieStartIndex == -1) return null var cookieEndIndex cookieStartIndex + prefix.length)
=
document.cookie.indexOf(";",
if (cookieEndIndex == -1) cookieEndIndex = document.cookie.length unescape(document.cookie.substring(cookieStartIndex cookieEndIndex))
+
return prefix.length,
}
После последовательного клика сначала по «Установить Cookie», а затем по «Прочитать Cookie», - получаем окно со значением 777.
ϑ @URLQueryString( [параметр] ) Область применения: нельзя использовать в формулах кнопок панели инструментов, отбора, колонок, агентов, всплывающих окон и области размещения. В интерфейсе клиента Notes всегда возвращает пустую строку. В Web-приложениях возвращает параметры из текущего URL. При отсутствии аргумента возвращает все параметры URL в виде списка. При передаче допустимого параметра, возвращает его значение, или пустую строку, если такого параметра нет в URL. Пустое значение так же возвращается, если параметр передается в виде ключевого слова (например, http://www.inttrust.ru/test/test.nsf/Form?OpenForm&Par1=100&Par2&Par3=No). Пример 1. Если URL текущего документа есть "http://dominornext.inttrust.ru/test/test.nsf/Form?OpenForm&Seq=7" функция вернет список "OpenForm" : " Seq=7" @URLQueryString;
Пример 2. Если URL текущего документа есть "http://dominornext.inttrust.ru/test/test.nsf/Form?OpenForm&Seq=7" функция вернет строку "7". @URLQueryString( "Seq" );
ϑ @WebDBName Область применения: без ограничений. Возвращает имя текущей базы данных в формате, пригодном для использования в URL. При этом символ обратного слеша («\») заменяется на обычный слеш («/»), двойной обратный слеш («\\») из имени удаляется, символ тире («-») остается без изменений, так же не изменяется расширение файла, начинающееся с символа точки. Остальные специальные символы заменяются на %xx, где xx – шестнадцатеричное представление символа. Так например, пробел заменяется на символ %20. Функция главным образом использования в URL командах.
предназначена
для
дальнейшего
Пример. Формула, используемая в кнопке формы, формирует URL открытия текущей БД. @URLOpen( "http://" + @WebDbName + "?OpenDatabase")
@GetHTTPHeader(
"Host"
)
+
"/"
+
6.24 Информационные функции ϑ @ConfigFile Область применения: нельзя использовать в формулах отбора и колонок. Возвращает путь к файлу NOTES.INI. При выполнении функции на сервере или в Web-приложениях возвращает путь к NOTES.INI сервера. На клиенте – соответственно путь к клиентскому NOTES.INI. Функция корректно работает, даже если путь к NOTES.INI файлу был указан в командной строке при запуске клиента.
Пример. На рабочей станции автора функция возвращает следующее значение: «C:\lotus\Notes6\notes.ini». @ConfigFile
@DbExists( сервер : файл_базы ) @DbExists( сервер ; идентификатор_реплики ) Область применения: нельзя использовать в формулах отбора, колонок, всплывающих окон и фоновых агентов. Возвращает 1(True), если база существует, или 0(False) в противном случае. Все параметры являются текстовыми строками. Параметр сервер указывает имя сервера, на котором выполняется проверка наличия базы. Если база "ищется" на локальной станции, то параметр сервер задают пустой строкой. Параметр файл_базы задает путь и имя файла базы. Параметр идентификатор_реплики - идентификатор реплики базы. Пример 1. Проверка наличия базы на сервере. @DbExists( "Belgium" : "mail\\frites.nsf" )
Пример 2. Проверка наличия базы с указанным идентификатором реплики на сервере Exists := @DbExists( "Cheshire"; "852556DO:00576146" );
@DbName Область применения: без ограничений. Возвращает для текущей БД имя сервера и собственно базы данных Notes. Возвращаемая величина является двухэлементным текстовым списком "сервер": "каталог\база_данных.nsf". Возвращаемое значение "сервер" может быть пустой строкой, если:
• • •
текущая БД хранится не на сервере, а на компьютере пользователя; формула с @DbName отрабатывает выполняющемуся на сервере;
в
агенте
по
расписанию,
формула с @DbName размещена в колонке вида.
Пример 1. Возвращает "": "NotesEx.nsf", если текущий документ находится в базе данных NotesEx.nsf, хранящейся в каталоге данных Notes на компьютере пользователя. @DbName
Пример 2. Возвращает "CN=NotesSrv400/O=InterTrustCorp/C=SU": "STUD\NotesEx.nsf", если текущий документ находится в базе данных NotesEx.nsf в подкаталоге STUD каталога данных Notes сервера CN=NotesSrv400/O=InterTrustCorp/C=SU. Если база данных хранится в каталоге
данных Notes 'этого же сервера, "CN=NotesSrv400/O=InterTrustCorp/C=SU": "NotesEx.nsf".
результат
будет
@DbName
Пример 3. Возвращает "STUD\NotesEx.nsf" - имя файла, поскольку оно является последним элементом возвращаемого списка. @Subset( @DbName; -1 )
ϑ @ReplicaID Область применения: нельзя использовать в формулах отбора. Возвращает идентификатор реплики текущей базы данных. Так же идентификатор реплики можно посмотреть через меню File - Database - Design Synopsis.... Данной функцией можно достаточно удобно пользоваться в Webприложениях для формирования URL. Пример. Формула при использовании в кнопке для Web-приложения формирует URL открытия документа «О базе данных». @URLOpen("/__" + ".nsf/$about?OpenAbout");
@ReplaceSubstring(@ReplicaID;
":";
"")
+
@DbTitle Область применения: без ограничений. Возвращает название текущей базы данных. Пример. Возвращает "Краткое путешествие по Lotus Notes", если эта учебная БД, поставляемая с русской версией Notes, является текущей. @DbTitle
ϑ @ServerName Область применения: нельзя использовать в формулах области размещения. Возвращает имя сервера текущей БД. Для локальной БД возвращает имя текущего пользователя. Пример. Может "CN=LAEC/OU=LAEC/O=InterTrustCorp/C=SU".
@ViewTitle Область применения: нельзя использовать в формулах отбора, колонок, фоновых агентов, заголовка окна, редактируемой секции, видимости объектов (за исключением акций видов). Возвращает название текущего вида или папки. Если у вида имеются синонимы, они возвращаются элементами текстового списка. В формулах полей (да и в заголовка окна, и акции форм) функция возвращает имя вида, который был текущим перед открытием документа. Пример 1. Возвращает "Главный", если таково название текущего вида. @ViewTitle
Пример 2. Возвращает "Главный\По дате" : "Date", если название текущего вида "Главный\По дате" и его alias Date. @ViewTitle
ϑ @GetViewInfo( флаг ; номер_столбца ) Область применения: нельзя использовать в формулах отбора, колонок, агентов по расписанию, видимости объекта, редактируемой секции, заголовка окна, гиперобъектов, всплывающих окон, формы, акции формы, навигатора и области размещения. Не работает в Web-приложениях. Возвращает значения атрибутов текущего вида. Флаг может принимать одно из следующих значений:
• •
•
[CalendarViewFormat] – применяется только для «календарных» видов, и возвращает значение одновременно отображаемых дней в виде (например, 1, 2, 5, 7 и т.д.); [ColumnValue] – возвращает значение в текущей строке столбца, определяемое номером_столбца. Нумерации столбцов начинается с 0, в нумерации используются и скрытые столбцы. При использовании данного флага требуется второй параметр; [IsCalViewTimeSlotOn] – для «календарных» видов возвращает значение 1 (TRUE), если сегмент времени в виде отображается, и 0 (FALSE) в противном случае. Про данный флаг (согласно информации, любезно предоставленной г-жой Gloria Flaherty из ИБМ) можно сказать следующее, что он предназначен для определения включен или нет сегмент времени в
календарном виде с отображением только на один или два дня. В остальных видах функция всегда возвращает 0 (FALSE).
Из анализа календарного вида стандартной почтовой версии R 6.0.1 можно обнаружить еще два недокументированных флага функции @GetViewInfo: [IsCalendarPrintingCal] и [IsCalendarSummarized].
Пример. В акции вида возвращает значение из третьей колонки текущей строки вида.
a := @GetViewInfo([ColumnValue]; 2); @Prompt([Ok];"ColumnValue";a);
ϑ @LDAPServer Область применения: ДОКУМЕНТИРОВАНА.
В
DOMINO
R
6.0.1
НЕ
Возвращает URL и номер порта LDAP сервера текущего домена. Для поиска LDAP сервера используется следующий алгоритм:
•
опрашивается текущий сервер;
•
на нем в файле Notes.ini ищется переменная LDAPSERVER;
•
опрашивается административный сервер, на котором LDAP выполняется по умолчанию.
Пример. Функция, используемая в формуле поля по умолчанию, в Webприложении может вернуть следующее значение: «ldap://linux.inttrust.ru:389». @LDAPServer
@FontList Область применения: нельзя использовать в формулах отбора, колонок, агентов, запускаемых вручную и фоновых. Не работает в Web-приложениях. Возвращает список доступных для клиента Notes шрифтов в виде текстового списка. При использовании в формуле ключевого поля можно определить необходимый шрифт. Для трех шрифтов вместо имен возвращаются их алиасы. Соответственно: для "Default Serif" - "0", для "Default San Serif" - "1" и для "Default Momospace" - "4". Пример. Формула возвращает либо "Arial Cyr", если такой шрифт установлен, или "Helv" в противном случае. @If( @IsMember( "Arial Cyr"; @FontList ); "Arial Cyr"; "Helv" )
6.25 Функции для обработки ошибок @Failure( строка ) Область применения: предназначена для использования в формулах проверки вводимых данных редактируемых полей, но может быть также использована в формулах формы и агентов. В последнем случае, только возвращает значение, но не выводит предупреждающих сообщений. При использовании в формуле проверки вводимых данных редактируемых полей, @Failure создает диалоговое окно с текстом строки сообщения, и, после нажатия кнопки OK, устанавливает курсор на редактируемое поле со значением, не соответствующим критерию проверки. Наиболее распространенная ошибка в формулах проверки вводимых данных возникает из-за того, что значение поля любого типа до того как в него введены какие-либо значения, есть пустая строка. Соответственно, его тип в этот момент строковый. Поэтому если тип данных проверяемого поля не текстовый (числовой или дата/время), то сначала надо проверить значение поля на не пустоту. В противном случае появится предупреждающее сообщение “Comparison operators must be supplied two values of the same data type” («Операторы сравнение должны получать значения одного и того же типа данных”).
Пример 1. Использованная в формуле проверки вводимых данных, @Failure выводит приведенное на Рис. 6.36 диалоговое окно, если пользователь введет в поле Value значение больше 100. @If( @IsNull(Value); @Failure( "Значение не введено" ); Value <= 100; @Success; @Failure( "Значение > 100 !" ))
Пример 2. Использованная в формуле проверки вводимых данных, @Failure выводит окно с сообщением "Код местности состоит только из 3 цифр", если пользователь введет в поле AreaCode число, большее или равное 999. @If( @IsNull(AreaCode); @Failure( "Значение не введено" );AreaCode < 999; @Success; @Failure( "Код местности состоит только из 3 цифр" ));
@Success Область применения: предназначена для использования в формулах проверки вводимых данных редактируемых полей. Возвращает 1 (TRUE). Используется совместно с @If в формулах проверки полей (в основном, в формулах проверки ввода для редактируемых полей), чтобы показать, что введенное значение соответствует критериям проверки. Пример. При использовании в формуле проверки вводимых данных редактируемых полей, возвращает 1 и позволяет сохранить документ, только если значение в поле Price меньше 100. @If( Price < 100; @Success; @Failure( "Цена слишком высока" ))
@Error Область применения: без ограничений. Генерирует ситуацию ошибки. Возвращаемое значение @Error. Проверить значение выражения на наличие ошибки можно только функцией @IsError.
@IsError( значение ) Область применения: нельзя использовать в формулах навигатора. Возвращает 1 (TRUE) если значение есть @ERROR (т.е. содержит ошибку), и 0 (FALSE) в противном случае. Аргумент значение должен либо содержать значение численного типа, либо имя поля или временной переменной, в которых хранятся значения численного типа.
Пример. Генерируется сообщение об ошибке, если временной переменной Choice будет присваиваться значение натурального логарифма от отрицательного числа. Choice := @Ln(Proba); @SetField( "Work"; @If( @IsError( Choice ); @Error; Choice ))
ϑ @IfError( выражение1 [; выражение2 ] ) Область применения: без ограничений. Функция вычисляет значение выражения1 и возвращает его значение если при вычислении не возникла ситуация ошибки. Если в выражении1 произошла ошибка, то если присутствует выражение2, то оно вычисляется и возвращается его значение. Если при ошибке в первом выражении, второй параметр опущен, то возвращается пустая строка. Так же можно использовать конструкцию $Error в качестве второго аргумента, в этом случае возвращается реальное сообщения об произошедшей ошибке. К сожалению, документация на эту функцию так же достаточно бедна. Например, отсутствует информация о том, какие ошибки распознает функция. Из личного опыта известно, что @IfError не распознает математические ошибки, ошибки функций: @TextToNumber и @TextToTime, и команды [TextSetFontSize]. Но в тоже время @IfError «отлавливает» ошибки функций: @DBLookup, @ToNumber, @ToTime и команды [TextSetFontFace]. Но это, разумеется, не весь контекст функции. Так же не совсем понятно как использовать «конструкцию $Error в качестве второго аргумента».
Пример 1. Формула задает значение поля Cost на основании функции @DbLookup, или предопределенной константы, если @DbLookup выполнился с ошибкой. @SetField("Cost"; @IfError(@DbLookup("":"NoCache"; "Петров В.В."; 2); "Значение не определено"))
"";
"ddd";
Пример 2. Функция, примененная в качестве значения числового поля по умолчанию, возвращает состояние ошибки, хотя должна бы была возвратить значение числа -5. @IfError( @Ln( -5 ); 5 )
Пример 3. Функция, примененная в акции формы, выводит окно с сообщение об ошибке. @Command([EditGoToField]; "Body"); @Command([EditSelectAll]); @IfError( @Command([TextSetFontFace]; fonts); @Prompt([Ok]; "Сообщение об ошибке"; "Вы должны предварительно определить имя шрифта"))
Пример 4. Модифицированный пример 3 с попыткой использовать «конструкцию $Error в качестве второго аргумента функции». Результат – системное сообщение об ошибке: «Specified font is not configured in system.» (указанный шрифт не установлен в системе). @Command([EditGoToField]; "Body"); @Command([EditSelectAll]); a := @IfError( @Command([TextSetFontFace]; fonts); $Error); @Prompt([Ok]; "Сообщение об ошибке"; a)
ϑ @CheckFormulaSyntax( текстовая_строка ) Область применения: нельзя использовать в формулах отбора и столбцов вида. Проверяет свой аргумент на соответствие правилам языка @-формул. Текстовая_строка представляет собой фрагмент кода. Функция обнаруживает ошибки только синтаксические ошибки, но не ошибки периода выполнения. Ищется только первая ошибка. Функция возвращает либо "1" – если ошибок не найдено, либо текстовый список типа: сообщение_об_ошибке : номер_строки : номер_столбца : смещение : длина : текст_вызвавщий_ошибку
где:
• •
• • • •
сообщение_об_ошибке – сообщение, возвращаемое компилятором; номер_строки – номер строки, в которой произошла ошибка. Нумерация начинается с единицы. Строками считаются фрагменты текста, разделенные жестким переводом строки, т.е. строки, автоматически перенесенные в рамках программной панели, учитываться не будут; номер_столбца – позиция первого символа, с которого начинается ошибка, в некорректной строке. Нумерация начинается с единицы от первого символа в рамках строки с номером номер_строки; смещение – аналогична предыдущему параметру, но нумерация идет в рамках всего фрагмента кода, считая от его первого символа; длина – длина текста, вызвавшего ошибку; текст_вызвавший_ошибку – текст или сообщение компилятора о причинах ошибки.
Пример 1. Следующая формула @Function":"3":"6":"23":"9":"@Exponent".
formula := {x := 10; y := 2; z := @Exponent(x; y); }; @CheckFormulaSyntax(formula);
Пример 2. Формула вернет значение: "An operator or semicolon was expected but none was encountered" : "3" : "1" : "17" : "1" : "z". Обратите внимание, что вторая ошибка, связанная с функцией @Exponent, не обнаружена:
formula := {x := 10; y := 2 z := @Exponent(x; y); }; @CheckFormulaSyntax(formula);
Пример 3. Формула вернет значение: "1".
formula := {x := 10; y := 2; z := @Power(x; y); }; @CheckFormulaSyntax(formula);
7 Описание @-команд Domino Мы подробно рассмотрим около 70 наиболее часто используемых при разработке приложений @-команд Domino. Всего же @-команд в Domino более 380 . Полный список всех @-команд с кратким их описанием дан в разделе "9". При описании синтаксиса в этом разделе мы всегда будем указывать @функцию @Command, хотя данный синтаксис справедлив и для @PostedCommand.
7.1 Команды для работы с текущим и выделенными документами @Command( [Compose]; "сервер" : "база_данных"; "форма"; "ширина_окна" : "высота_окна" ) Область применения: нельзя применять в формулах диалогового окна. В указанной параметрами "сервер" : "база_данных" базе данных создает новый документ по форме "форма" и переключает фокус Domino на него. Если в качестве параметра "сервер" выступает пустая строка, считается что база является локальной. Если необходимо создать документ в текущей базе данных, то второй параметр тоже должен быть пустой строкой. Параметр "форма" задает форму своим именем или синонимом. В случае если этот параметр опущен, и БД текущая, будет выведено диалоговое окно для определения формы, по которой должен быть создан документ. Если команда используется в акции вида, у которого определена формула формы, или в формуле кнопки панели инструментов, и на экране открыт вид с непустой формулой формы, то новый документ будет открыт по форме из формулы формы данного вида. Для решения этой проблемы рекомендуется модифицировать формулу формы вида следующим образом: . . . REM {выше код определения имени формы, пусть она присваивается временной переменной form_new} @If(@IsNewDoc; @Return(Form); @Return(form_new));
При создании документов типа "ответ" или "ответ на ответ", БД, в которой планируется создать такой документ, должна быть открыта и на документе, на который создается ответ, должен стоять световой маркер. Так же
для создания ответных документов можно воспользоваться новой в R 6 командой [ComposeWithReference]. Команда может быть использована в Web-приложениях только в формате @Command( [Compose]; "имя_формы" ). Параметр "ширина_окна" : "высота_окна" задает соответственно высоту и ширину в дюймах окна, в котором будет создаваться документ. Параметр не имеет смысла, когда выбран MDI (Multiple Document Interface многооконный интерфейс в рамках главного окна) интерфейс, и окно имеет установленной свойство - максимальный размер. В случае если этот параметр опущен или равен нулю, то окно имеет размеры, сохраненные последним пользователем. Пример 1. Создает в текущей базе данных документ по форме "First". @Command( [Compose]; ""; "First" )
Пример 2. Создается документ по форме "People" в базе данных "News\People.nsf", лежащей на сервере "Leda/Center_TV/RU". @Command( [Compose]; "Leda/Center_TV/RU" : "News\\People.nsf"; "People" )
ϑ @Command( [ComposeWithReference]; "сервер" : "база_данных"; "форма"; флаги ) Область применения: БД должна быть открыта, на документе, на которой создается ответ, должен стоять световой маркер или документ должен быть открыт в режиме чтения/редактирования. Создает ответный документ для документа, на котором стоит световой маркер, и переключает фокус на него. Под ответным здесь понимается не обязательно документ, содержащий ссылку на родителя в поле $Ref, просто создаваемый документ может содержать информацию из документа родителя (более напоминает наследование). Параметры "сервер" : "база_данных" и "форма" имеют тот же смысл, что и для команды [Compose]. Единственное отличие состоит в том, что если в новый документ требуется передать какие-либо данные из родительского документа, то в "форме" обязательно должно присутствовать RTF-поле с именем Body (данная информация отсутствует в Help). В противном случае (т.е. указан параметр флаги, и у формы отсутствует RTF-поле с именем Body) выдается сообщение об ошибке «Inherit rich text field does not exist» (RTF-поля для наследования не существует).
По аналогии с командой [Compose], если [ComposeWithReference] используется в акции формы или кнопки панели инструментов при открытом виде с определенной формулой формы, то следует изменить формулы формы как в описание к [Compose]. Параметр флаги не обязателен, он определяет параметры ссылки на родительский документ. Если параметр опущен, то новый документ будет создан без ссылки на родительский документ. Тип значения флаги число, поэтому если необходимо задать несколько флагов, то в качестве параметра флаги следует задавать сумму их значений. Допустимыми для флага являются следующие значения:
• •
• •
•
•
1 – включает в поле Body ссылку (Doclink) на родительский документ. В Web-приложениях не поддерживается; 2 - включает в поле Body содержимое родительского документа. Требует наличие флага 1. В Web-приложениях в акции формы (но не вида) корректно передается только текстовая информация из родительского документа. Даже если поле Body отображается в Web с помощью апплета, графические изображения из родительского документа передаются некорректно; 4 - включает в поле Body содержимое родительского документа в виде свертываемой секции. Требует наличие флага 1 и 2. В Web-приложениях не поддерживается; 8 - включает в поле Body содержимое родительского документа в виде интернет копии (т.е. «такой-то и тогда-то написал» в заголовке, а далее текст из родительского документа, предваряемый символами больше «>». Все остальные объекты удаляются с соответствующим сообщением). В Web-приложениях не поддерживается. Требует наличие флага 1 и 2. Неявно применяет флаг 16; 16 - включает в поле Body содержимое родительского документа, удаляя из последнего присоединенные файлы, графические изображения и другие большие объекты, заменяя их на текст об удалении, заключенный в квадратные скобки. В Web-приложениях не поддерживается. Требует наличие флага 1 и 2; 32 – включает перед наследуемым текстом подформу с именем $ForwardSep, если таковая в БД имеется (в стандартном почтовом шаблоне mail6.ntf такая форма присутствует). В Web-приложениях не поддерживается. Требует наличие флага 1 и 2.
Пример 1. Открывает в текущей БД форму с именем Resp, которая имеет RTF-поле с именем Body. В поле Body копируется информация в виде свертываемой секции из документа, который был текущим на момент выполнения формулы,. Данная функциональность достигается использованием в акции вида следующей формулы: @Command([ComposeWithReference]; "" : ""; "Resp"; 1 + 2 + 4)
Пример 2. Открывает в почтовой БД текущего пользователя форму Reply, в поле Body которой копируется информация из документа, который был текущим на момент выполнения формулы. Информация копируется в виде свертываемой секции с интернет стилем. Данная функциональность достигается использованием в акции формы следующей формулы: @Command([ComposeWithReference]; @MailDbName; "Reply"; 1 + 2 + 4 + 8)
@Command( [EditDocument] ) @Command( [EditDocument]; "режим_документа"; "режим_отображения" ) Область применения: в виде/папке на документе должен стоять световой маркер, или документ открыт в режиме чтения/редактирования. Можно использовать в Webприложениях в акциях формы (но не в акциях видов) без параметров. При использовании данной команды могут не работать формулы видимости объектов в форматируемых полях. Используйте команду @Command( [OpenDocument] ), которая поддерживает работу всех формул видимости объектов. При использовании команды, когда на документе стоит световой указатель в виде/папке, происходит открытие документа в указанном режиме. Если параметр "режим_документа" опущен, то вызывается режим редактирования. При задании параметра "режим_документа" равным "1" переводит текущий документ в режим редактирования, соответственно "0" - чтения. При задании параметра "режим_отображения" равным "1", текущий документ переходит в режим редактирования в панели предварительного просмотра. Может использоваться для редактирования текущего документа. Однако в случае использования в формулах акций формы и видов предпочтительней пользоваться предопределенными акциями "Edit Document".
Пример. При использовании в формуле акции вида/папки или формы переводит текущий документ в режим редактирования. @Command( [EditDocument]; "1" )
ϑ @Command( [EditRestoreDocument] ) Область применения: на документе стоит световой маркер или документы выд 叿 䉍 /243243243243243243243 졁 .� À ÿ243Ā243 䀀 243243Āго «мягко» удаленные документы, или документ находится в режиме чтения. Выполняет команду меню Edit -> Restore. Другими словами восстанавливает «мягко» удаленные документы. Команда по своему действию похожа на функцию @UndeleteDocument (см. Стр. 128). Из отличий можно назвать, что @Command( [EditRestoreDocument] ) на уровне вида с «мягко» удаленными документами может восстанавливать не только выбранный, но и выделенные документы, в то время как @UndeleteDocument восстанавливает только выбранный документ. На уровне формы @UndeleteDocument корректно работает с документами как в режиме чтения, так и редактирования, а @Command( [EditRestoreDocument] ) – только в режиме чтения. Пример. Формула, примененная в акции вида, содержащего «мягко» удаленные документы, восстанавливает все присутствующие в этом виде документы. @Command( [EditSelectAll] ); @Command( [EditRestoreDocument] )
@Command( [ViewSwitchForm] ; "имя_формы" ) Область применения: документ должен находиться в режиме чтения или редактирования, или он должен находиться в панели предварительного просмотра, и фокус должен находиться в этой панели. Всегда выполняется последней в формуле. Команда не работает, если в виде/папке, из которого был открыт документ, определена формула формы. Изменяет форму, по которой отображается текущий документ, на форму с именем или алиасом "имя_формы". В случае если параметр "имя_формы" опущен, то выдается диалоговое окно со списком всех доступных для текущей базы данных формы.
ϑ @Command( [SwitchForm] ; "имя_формы" ) Область применения: документ должен находиться в режиме чтения или редактирования, или он должен находиться в панели предварительного просмотра, и фокус должен находиться в этой панели. Команда не работает если в виде/папке, из которого был открыт документ, определена формула формы. Изменяет форму, по которой отображается текущий документ, на форму с именем или алиасом "имя_формы". В случае если параметр "имя_формы" опущен, то выдается диалоговое окно со списком всех доступных для текущей базы данных формы. Аналогична @Command( [ViewSwitchForm] ) за тем лишь исключением, что выполняется немедленно в формуле, а не после всех остальных команд.
@Command( [FileSave] ) Область применения: документ или элементы дизайна (форма/подформа, вид/папка, навигатор и т.д.) должны находиться в режиме редактирования. Можно использовать в Web-приложениях при условии, что у базы установлено свойство "Web access: Use JavaScript when generating pages" (использовать Javascript при создании Web-страниц). Выполняет команду File -> Save (Файл - Сохранить). В Web-приложениях, если в свойствах БД поднят флаг "Web access: Use JavaScript when generating pages" (использовать Javascript при создании Webстраниц) и за командой [FileSave] следует команда [FileCloseWindow] или [CloseWindow], то такая связка транслируется как Submit формы. Команда часто применяется редактируемого документа.
в
акциях
формы
для
сохранения
Пример 1. При использовании в акции формы сохраняет текущий редактируемый документ. @Command( [FileSave] )
Пример 2. При использовании в кнопке формы в Web-приложении организует действие типа Submit формы. У БД должен быть поднят флаг поднят флаг "Web access: Use JavaScript when generating pages". @Command([FileSave]); @Command([CloseWindow])
@Command( [FileCloseWindow] ) Область применения: можно использовать в Webприложениях при условии, что у базы установлено свойство "Allow Javascript on the Web" (использовать Javascript при создании Web-страниц). Не закрывает окно с рабочим пространством. Всегда выполняется последней в формуле. Закрывает текущее окно LN, за исключением главного окна.
В случае если в окне присутствует не сохраненный отредактированный документ или элемент дизайна выдает диалоговое окно с вопросом о сохранении изменений.
Команда достаточно часто применяется в приложениях в акциях форм, как самостоятельно, так и в паре с командой [FileSave]. В Web-приложениях, если команда предваряется командой [FileSave], то такая конструкция транслируется как Submit формы.
ϑ @Command( [CloseWindow] ) Область применения: можно использовать в Webприложениях при условии, что у базы установлено свойство "Allow Javascript on the Web" (использовать Javascript при создании Web-страниц). Не закрывает окно с рабочим пространством. Закрывает текущее окно LN, за исключением главного окна. Аналогична @Command( [FileCloseWindow] ) за тем лишь исключением, что выполняется немедленно в формуле, а не после всех остальных команд.
ϑ @Command( [EditClear] ) Область применения: в R 6 всегда выполняется последней в формуле. Для корректной работы необходимо выполнения одного из условий: • в виде/папке документ(ы) должны быть выделены (помечены или на документе стоит световой маркер) или документ должен находиться в режиме редактирования; • документ должен находиться в режиме редактирования, и данные для удаления (текст, присоединенные файлы, объекты и т.д.) должны быть выделены. В этом контексте нельзя использовать команду следом за командой [EditGotoField]; • элементы дизайна (форма, подформа, вид, папка и т.д.) должны находиться в режиме редактирования и данные для удаления (поля, столбцы и т.д.) должны быть выделены; • в рабочем пространстве иконки баз данных должны быть выделены. Выполняет команду меню Edit - Clear (Правка - Очистить). Соответственно для пунктов области применения удаляет (устанавливает/снимает пометку об удалении для документов) выбранные документы, выделенный фрагмент в документе или элементе дизайна, находящихся в режиме редактирования, или иконку баз данных (без удаления самой базы данных). Применять команду в Web-приложениях можно только в контексте удаления текущего (а не помеченных) документа. Нельзя использовать в Webприложениях в акциях видов/папок, только в акциях формы. Часто применяется для удаление) текущих документов.
удаления
(установки/снятия
пометки
на
Обратите ВНИМАНИЕ!!!, что в R 6 (в отличие от предыдущих версий, включая R 5) всегда выполняется последней в формуле. Пример. При использовании в формуле акции вида/папки устанавливает/снимает пометку на удаление для выбранных документов. @Command( [EditClear] )
ϑ @Command( [Clear] ) Область применения: необходимо выполнения одного из условий: • в виде/папке документ(ы) должны быть выделены (помечены или на документе стоит световой маркер) или документ должен находиться в режиме редактирования; • документ должен находиться в режиме редактирования, и данные для удаления (текст, присоединенные файлы, объекты и т.д.) должны быть выделены. В этом контексте нельзя использовать команду следом за командой [EditGotoField]; • элементы дизайна (форма, подформа, вид, папка и т.д.) должны находиться в режиме редактирования и данные для удаления (поля, столбцы и т.д.) должны быть выделены; • в рабочем пространстве иконки баз данных должны быть выделены. Выполняет команду меню Edit - Clear (Правка - Очистить). Аналогична @Command( [EditClear] ) за тем лишь исключением, что выполняется немедленно в формуле, а не после всех остальных команд.
@Command( [MoveToTrash] ) Область применения: работает в акциях видов и формы В Web-приложениях работает только в акциях видов, у которых установлено либо свойство Use applet in the browser (использовать апплет при отображении вида в Web), либо Allow selection of documents (разрешить выделение документов) в этом контексте помечает документ к удалению, но не удаляет его. По действию аналогична команде [EditClear]. Помечает к удалению текущий (выделенные) документы. В клиенте Notes может применяться как в акциях видов/папок, так и акциях форм. Основное предназначение команды для использования в Webприложениях. К сожалению, документация на команду оставляет желать лучшего. Далее идет информация, полученная из личного опыта.
В Web-приложениях команда корректно работает только в акциях видов (но не формы), и только для видов, у которых на закладке Advanced установлено либо свойство Use applet in the browser (использовать апплет при отображении вида в Web), либо Allow selection of documents (разрешить выделение документов).
В первом случае (вид отображается апплетом) помечаются к удалению текущий либо выбранные документы. Во втором случае (вид отображается с возможностью выбора документов) - только выбранные документы. Повторное применение команды в обеих случаях к документам с отметкой на удаление снимает эту отметку. Для реального удаления документов, помеченных к удалению, можно в другой акции применить команду [EmptyTrash]. Совместное применение в одной формуле [MoveToTrash] и [EmptyTrash] работает в R 6.0.1 для видов с установленным свойством Allow selection of documents, но не работает для апплетов вида. В последнем случае никаких действий не выполняется. Пример. Вид имеет свойство Allow selection of documents, для пометки на удаление используется акция вида с формулой: @Command( [MoveToTrash] )
@Command( [EmptyTrash] ) Область применения: без ограничений. Удаляет документы из предопределенной папки ($Trash) и обновляет индекс вида. С версии 5 с помощью этой команды можно также программно воздействовать на апплеты видов. Данную команду удобно использовать совместно с [EditClear] для немедленного удаления документов из базы. Также можно использовать ее в акции папки ($Trash) для очистки корзины. Пример. Данная формула при использовании ее в акции вида и в случае наличия в базе данных предопределенной папки ($Trash) помечает выделенные документы к удалению, и сразу их удаляет из базы данных. @Command( [EditClear] ); @Command( [EmptyTrash] )
@Command( [FilePrint]; "число_копий"; "начальная_страница"; "конечная_страница"; "черновик"; "печать_вида"; "форма"; "разделитель_страниц"; "нумерация"; "дата_начала"; "дата_окончания" ) Область применения: вид/папка должны быть открыты, или документ должен находиться в режиме чтения/редактирования. Печатает текущий/выбранные документы или содержимое вида/папки целиком. Все параметры, за исключением ключевого слова, являются необязательными, однако если необходимо задать шестой параметр, а с третьего по пятый опустить, то необходимо все равно задать их как пустые строки. При использовании команды без параметров выдает диалоговое окно File Print (для Macintosh диалоговое окно выбора принтера). Параметр "число_копий" может принимать значения "" или "N". Соответствует числу выводимых на печать копий. Параметры "начальная_страница" и "конечная_страница" могут принимать значения "" или "N". Позволяют осуществить вывод на печать только определенных листов результирующего документа. "Черновик" может принимать значения "draft" (соответствует черновой печати) или "". Определяет качество печати. Аргумент "печать_вида" при значении "printview" осуществляет печать содержимого вида/папки, при значении "" в виде печатаются выбранные документы. При печати открытого документа данный аргумент игнорируется. "Форма" определяет имя формы, по которой будут печататься документы из вида/папки. При печати открытого документа данный аргумент игнорируется. "Разделитель_страниц" определяет при печати нескольких документов, как они будут отделены друг от друга. При значении "pagebreak" указывает, что каждый документ будет начинаться с новой страницы, при "line" разделителем документов будет пустая строка. При печати открытого документа данный аргумент игнорируется. "Нумерация" определяет нумерацию страниц в результирующем документе. При значении "resetpages" для каждого документа будет своя нумерация страниц, при пустой строке будет сквозная нумерация. При печати открытого документа данный аргумент игнорируется.
Параметры "дата_начала" и "дата_окончания" применяются только при печати содержимого вида, который имеет календарный стиль. Они определяют с какой и по какую дату печатать содержимое представления. При задании им значений пустой строки даты определяются из первого и последнего документа вида. Пример 1. При использовании в акции формы печатает текущий документ. @Command( [FilePrint]; "" );
Пример 2. При использовании соответственно содержимое вида/папки.
ϑ @Command( [Folder]; "папка"; "флаг") Область применения: документ должен быть открыт, либо документы выделены в виде. Документ(ы) должен быть уже сохранен на диске (не новый документ). В R 6 всегда выполняется последней в формуле. Копирует или копирует с удаление документ(ы) в папку. Все параметры, за исключением ключевого слова, необязательны. При их отсутствии выдается диалоговое окно для их определения. В случае, когда команда используется без параметров, предпочтительней пользоваться предопределенными акциями формы или вида/папки. Параметр "папка" задает имя или алиас папки, в которую необходимо скопировать или переместить документы. "Флаг" определяет режим копирование/перемещение, выполняется соответственно перемещение, при "0" - копирование.
при
"1"
Начиная с пятой версии Domino, в дополнении к команде [Folder] можно пользоваться функцией @AddToFolder. Учтите только, что она работает только с текущим, но не выделенными документами. В версии 5 и выше с помощью команды [Folder] можно также программно воздействовать на апплеты видов. Пример 1. При использовании в акции папки перемещает выбранные документы из текущей папки в папку "Moscow". @Command( [Folder]; "Moscow"; "1" )
Пример 2. При отборе документов с использованием полнотекстового индекса, при отображении в виде/папке пропадают категории. Для отображения отобранных документов с категориями можно воспользоваться нижеследующей формулой, применив ее, например, в кнопке панели инструментов. Формула сначала выделяет все отобранные документы, а затем копирует их в папку "Moscow", имеющую тот же дизайн, что и у текущего вида/папки и переходит в нее. @Command( [EditSelectAll] ); @Command( [Folder]; "Moscow"; "0" ); @Command( [OpenView]; "Moscow" )
ϑ @Command( [FolderDocuments]; "папка"; "флаг") Область применения: документ должен быть открыт, либо документы выделены в виде. Документ(ы) должен быть уже сохранен на диске (не новый документ). Копирует, или копирует с удаление документ(ы) в папку. Аналогична @Command( [Folder] ) за тем лишь исключением, что выполняется немедленно в формуле, а не после всех остальных команд.
@Command( [RemoveFromFolder] ) Область применения: в папке документ(ы) должны быть выделены (помечены или на документе стоит световой маркер) или документ должен находиться в режиме чтения/редактирования. Удаляет текущий документ(ы) из текущей папки.
В случае, когда формула состоит из одной команды [RemoveFromFolder], предпочтительней пользоваться предопределенными акциями формы или папки.
С версии 5 эта команды можно использоваться для программного воздействия на апплеты видов.
@Command( [EditCopy] ) @Command( [EditCut] ) Область применения: необходимо выполнения одного из условий: • в виде/папке документ(ы) должны быть выделены (помечены или на документе стоит световой маркер); • документ должен находиться в режиме редактирования или чтения, и данные для копирования (текст, присоединенные файлы, объекты и т.д.) должны быть выделены; • элементы дизайна (форма, подформа, вид, папка и т.д.) должны находиться в режиме редактирования, и данные для копирования (поля, столбцы и т.д.) должны быть выделены. Выполняют команды меню для [EditCopy] - Edit - Copy (Правка Копировать), и для [EditCut] - Edit - Cut (Правка - Вырезать). Соответственно для пунктов области применения копируют в буфер обмена ([EditCut] копирует с удалением) выбранные документы, или выделенный фрагмент в документе или элементы дизайна, находящихся в режиме редактирования. Пример. При использовании в формуле акции вида/папки копирует в буфер обмена выбранные в текущей базе данных документы, и затем вставляет их в новую локальную базу "My_sec.nsf", открывая ее при этом по виду "View1". @Command( [EditCopy] ); @Command( [FileOpenDatabase]; "" : "My_sec.nsf"; "View1" ); @Command( [EditPaste] )
@Command( [EditPaste] ) Область применения: вид/папка должны быть открыты, или документ должен находиться в режиме редактирования, или элементы дизайна (форма, подформа, вид и т.д.) должны находиться в режиме редактирования. Информация в буфере обмена должна соответствовать типу приемника. В случае если в буфере обмена находится информация из форматируемого поля, а вставка осуществляется в текстовое поле, часть информации может быть утеряна. Выполняет команду Edit - Paste (Правка - Вставить). Соответственно либо вставляет в вид/папку скопированные ранее документы, либо вставляет информацию в поля, либо вставляет элементы дизайна.
@Command( [EditSelectAll] ) Область применения: документ должен находиться в режиме чтения/редактирования, или вид/папка должны быть открыты, или в текущем окне отображается лист рабочего пространства, или форма/подформа находятся в режиме редактирования. Выполняет команду Edit - Select All (Правка - Выделить все). Для документа находящегося в режиме чтения, команда выделяет все содержимое формы, включая поля, статичный текст, графику и т.д. Для документа находящегося в режиме редактирования, команда выделяет все содержимое текущего поля. Для вида/папки выделяются все входящие в них документы. Для формы/подформы, находящихся в режиме редактирования, выделяются все элементы дизайна, включая области размещения (в документации сказано, что области размещения не выделяются). Для листа рабочего пространства выделяются все находящиеся на нем иконки баз данных. Пример 1. Формула, при использовании ее в акции вида/папки, помечает к удалению все находящиеся соответственно в виде/папке документы. @Command( [EditSelectAll] ); @Command( [EditClear] );
Пример 2. При отборе документов с использованием полнотекстового индекса, при отображении в виде/папке пропадают категории. Для отображения отобранных документов с категориями можно воспользоваться нижеследующей формулой, применив ее, например, в кнопке панели инструментов.
Формула сначала помечает все отобранные документы, затем устанавливает переключатель для отображения только выбранных документов, выключая при этом переключатель для отображения только отобранных с помощью полнотекстового поиска документов.
@Command( [EditSelectByDate] ) Область применения: вид/папка должны быть открыты в текущем окне. Выдает диалоговое окно отбора документов по дате (Select by Date).
В диалоговом окне можно определить интервал дат и тип даты или создания, или последнего изменения документов. После нажатия клавиши Ok помечаются документы, удовлетворяющие введенным условиям.
Пример. После определения условий отбора по дате, помеченные документы копируются с удалением в буфер обмена, а затем вставляются в архивную базу. @Command( [EditSelectByDate] ); @Command( [EditCut] ); @Command( [FileOpenDatabase]; "" : "Archive.nsf"; "View1" ); @Command( [EditPaste] )
@Command( [EditDeselectAll] ) Область применения: необходимо выполнения одного из условий: • в виде/папке документы должны быть выделены; • документ должен находиться в режиме редактирования или чтения, и данные для снятия с них отметки выделения (текст, присоединенные файлы, объекты и т.д.) должны быть выделены; • элементы дизайна (форма, подформа, вид, папка и т.д.) должны находиться в режиме редактирования, и данные для копирования (поля, столбцы и т.д.) должны быть выделены; • в рабочем пространстве иконки баз данных должны быть выделены. Выполняет команду меню Edit - Deslect All (Правка - Снять все выделение). Снимает все выделения в перечисленных в области применения объектах.
@Command( [ToolsMarkAllRead] ) @Command( [ToolsMarkAllUnread] ) Область применения: документ должен быть открыт в режиме чтение/редактирование, или в текущем окне должен быть открыт вид/папка. Помечает все документы в базе данных для команды [ToolsMarkAllRead] соответственно как прочтенные, а [ToolsMarkAllUnread] - как непрочтенные. Результат работы команд “виден” только в случае, если разработчики предусмотрели возможность отображения непрочтенных документов.
@Command( [ToolsMarkSelectedRead] ) Область применения: в текущем окне должен быть открыт вид/папка, и документы должны быть помечены, или на документе стоит световой маркер. Помечает текущий или выбранные документы в базе данных как прочтенные. Результат работы команд “виден” только в случае, если разработчики предусмотрели возможность отображения непрочтенных документов.
@Command( [ToolsMarkSelectedUnread] ) Область применения: в текущем окне должен быть открыт вид/папка, и документы должны быть помечены, или на документе стоит световой маркер, или документ должен быть открыт в режиме чтения/редактирование. Помечает текущий или выбранные документы в базе данных как непрочтенные.
7.2 Команды открытия объектов @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] (см. стр. 256) применим только вариант синтаксиса с параметром "вид", но не "навигатор", причем должен быть еще задан параметр "ключ", и "сервер" в виде пустой строки. Остальные параметры должны быть опущены; для [OpenView] (см. стр. 260) должны быть заданы параметры "вид" и "ключ". Остальные параметры должны быть опущены.
В обоих случаях параметр "вид" должен быть задан явно (т.е. не в виде пустой строки), а в качестве "ключа" может быть использован псевдоидентификатор $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]; "$first");
Пример 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-приложениях в формулах кнопок. Открывает определенный вид, указанной справочной базы данных, и становится на нужный документ. Все параметра за исключением ключевого слова необязательны. В первом варианте явно задается местоположение справочной базы данных. Параметр "сервер" задает имя сервера, если это пустая строка, то считается, что справочная БД расположена локально. "База_данных" задает имя файла справочной базы данных. Если этот параметр опущен, то ищется справочная база по клиентской части. Второй вариант определяет справочную базу данных из установленных, с помощью ключевого слова [тип_справочника]. Данный флаг может принимать следующие значения:
• • •
262
[ClientHelp] - для справочной базы о программном обеспечении рабочей станции; [DesignerHelp] - для справочной базы о программном обеспечении разработчика приложений; [AdminHelp] - для справочной администратора системы.
Аргумент "вид" задает имя или алиас вида/папки, которые должны открыться первыми при открытии базы данных. "Ключ" задает значение, которое должно соответствовать значению в первой отсортированной колонке вида. В случае такого соответствия на первый такой документ устанавливается световой маркер вида. Пример. Формула запрашивает у пользователя тип справочной базы, затем интересующий его термин, и после этого выдает справочную информацию по нему из соответствующей базы по индексу "Index". Ch := @Prompt( [OkCancelCombo]; "Выбор базы"; "Выберите справочную базу данных."; "Справка по клиенту"; "Справка по клиенту" : "Справка по дизайнеру": "Справка по администрированию" ); ch1 := @Prompt( [OkCancelEdit]; "Введите искомое значение"; "Введите значение для поиска
@Command( [FileExit] ) Область применения: нельзя применять в формулах диалогового окна. Всегда выполняется последней в формуле. Выполняет команду File - Exit (Файл - Выход из Notes). В случае если в каком-либо окне присутствует не сохраненный отредактированный документ или элемент дизайна выдает диалоговое окно с вопросом о сохранении изменений. В приложениях данная команда иногда применяется в главном полноэкранном навигаторе для выхода в операционную систему.
ϑ @Command( [ExitNotes] ) Область применения: нельзя диалогового окна.
применять
в
формулах
Выполняет команду File - Exit (Файл - Выход из Notes). Аналогична @Command( [FileExit] ) за тем лишь исключением, что выполняется немедленно в формуле, а не после всех остальных команд.
7.3 Команды для работы с профильными документами ϑ @Command( [EditProfile]; "имя_профильного_документа"; "уникальный_ключ" ) Область применения: в R 6 всегда выполняется последней в формуле. Нельзя применять в формулах диалогового окна. Для создания профильного документа нужен доступ к базе данных не ниже автора. Создает новый или открывает существующий профильный документ на редактирование. Параметр "имя_профильного_документа" задает имя профильного документа. Третий параметр не обязателен, если он опущен, то ищется или создается профильный документ общий для данной базы данных, иначе ищется профильный документ, связанный с указанным ключом. Пример. Предположим, что для обмена информацией между приложениями внутри определенной базы данных необходимо для каждого пользователя иметь профильный документ, ассоциированный с именем пользователя. Для автоматизации процедуры создания профильных документов для каждого пользователя можно использовать приведенную ниже формулу, которую можно использовать, например, в кнопке навигатора. В формуле сначала выбирается имя пользователя из адресной книги, затем создается для него профильный документ с именем "User". Затем документ сохраняется и закрывается. Ch := @PickList( [Name]:[Single] ); @Command( [EditProfile]; "User"; Ch ); @Command( [FileSave] ); @Command( [FileCloseWindow] );
ϑ @Command( [EditProfileDocument]; "имя_профильного_документа"; "уникальный_ключ" ) Область применения: нельзя применять в формулах диалогового окна. Для создания профильного документа нужен доступ к базе данных не ниже автора. Создает новый или открывает существующий профильный документ на редактирование. Аналогична @Command( [EditProfile] ) за тем лишь исключением, что выполняется немедленно в формуле, а не после всех остальных команд.
7.4 Команды обновления отображаемой информации ϑ @Command( [ReloadWindow] ) Область применения: в R 6 всегда выполняется последней в формуле. Работает в формулах акций форм и кнопок. В акциях видов для клиента Notes команда работает только в случае, если вид входит в набор фреймов. Может использоваться в Web-приложениях. "Перезагружает" или обновляет содержимое текущего окна LN. Для набора фреймов обновляет содержимое всех входящих в него фреймов.
ϑ @Command( [RefreshWindow] ) Область применения: работает в формулах акций форм и кнопок. В акциях видов для клиента Notes команда работает только в случае, если вид входит в набор фреймов. Может использоваться в Web-приложениях. "Перезагружает" или обновляет содержимое текущего окна LN. Для набора фреймов обновляет содержимое всех входящих в него фреймов. Аналогична @Command( [ReloadWindow] ) за тем лишь исключением, что выполняется немедленно в формуле, а не после всех остальных команд.
ϑ @Command( [RefreshFrame]; "фрейм" ) Область применения: работает в формулах акций форм и видов и гиперобъектах. Может использоваться в Webприложениях. "Перезагружает" или обновляет содержимое указанного "фрейма". Если перед командой [RefreshFrame] следует функция @SetTargetFrame, то значение параметра "фрейм" игнорируется, и осуществляется обновление фрейма, заданного функцией @SetTargetFrame. В рамках клиента Notes, если параметр "фрейм" опущен и функция @SetTargetFrame в формуле отсутствует, то [RefreshFrame] не выполняет никаких действий. Если команда выполняется во вложенном наборе фреймов с одноименными фреймами, на один из которых указывает параметр "фрейм", то обновление осуществляется только для одноименного фрейма самого верхнего уровня. В Web-приложениях команда обновляет только текущий фрейм, при этом игнорируется параметр "фрейм". Функция @SetTargetFrame не оказывает влияния на команду [RefreshFrame] в Web-приложениях. Пример. Команда, примененная в кнопке страницы, обновляет фрейм с именем «Right» для набора фреймов, отображаемых в клиенте Notes. @Command([RefreshFrame]; "Right")
@Command( [ViewRefreshFields] ) Область применения: документ должен быть открыт в режиме редактирования, или вид/папка должны быть открыты в текущем окне. Можно использовать в Web-приложениях. Осуществляет пересчет всех формул полей для текущего документа, или обновляет содержимое вида/папки. С версии 5 с помощью этой команды можно также программно воздействовать на апплеты видов. Пример. Команда при использовании в акции вида/папки обновляет содержимое экрана. @Command( [ViewRefreshFields] )
@Command( [RefreshHideFormulas] ) Область применения: вид/папка должны быть открыты, или документ должен находиться в режиме чтения/редактирования. Пересчитывает только формулы видимости объектов в документе или виде. Формулы вычисляемых полей, проверки введенных данных и т.д. при этом не пересчитываются. На уровне вида команда не оказывает влияние на формулы скрытия столбцов, только на формулы скрытия акций вида. Пример. Предположим у нас есть форма, в которой формулы вычисляемых полей должны выполняться только по выходу из документа (например, из-за громоздкости расчетов). Но в зависимости от содержимого поля "Type" должны скрываться/отображаться определенные объекты формы. Для того чтобы не заставлять пересчитываться все формулы, а выполнить только формулы видимости объектов, применим следующую конструкцию в формуле кнопки для определения значения поля "Type" (поле вычисляемое). ch := @Prompt( [OkCancelCombo]; "Выбор типа статьи"; "Выберите тип статьи."; "Текст"; "Текст" : "Видео" : "Графика" : "Подводка"); @SetField( "Type"; ch ); @Command( [RefreshHideFormulas] )
@Command( [RefreshParentNote] ) Область применения: работает диалогового окна.
только
в
формулах
Передает изменения из одноименных полей диалогового окна (имеется ввиду @DialogBox или его аналог на LotusScript) в основной документ. Пример. Формула, отрабатывающая по событию QueryClose диалогового окна, всегда передает изменения в одноименных полях в основной документ в независимости от того, какую кнопку нажал пользователь Ok или Cancel. @Command( [RefreshParentNote] )
@Command( [ToolsRefreshAllDocs] ) Область применения: в текущем окне должен быть открыт вид/папка. Перевычисляет все формулы во всех документах текущего вида/папки и сохраняет изменения. Следует обратить внимание на область применения команды, исходя из определения, она напрямую не работает в формулах, входящих в форму (в частности, в акциях формы). Пример. Формула, используемая в акции формы, сначала сохраняет текущий документ. Затем открывает вид "View1" и обновляет все документы в нем. @Command( [FileSave] ); @Command( [OpenView]; "View1" ); @Command( [ToolsRefreshAllDocs] );
@Command( [ToolsRefreshSelectedDocs] ) Область применения: в текущем окне должен быть открыт вид/папка, хотя бы один документ должен быть выделен или на документе должен стоять световой маркер. Перевычисляет все формулы в текущем или выделенных документах текущего вида/папки и сохраняет изменения.
7.5 Команды для работы с видами и папками @Command( [ViewChange]; "вид" ) Область применения: в R 6 всегда выполняется последней в формуле. Вид/папка должны быть открыты в текущем окне. Может использоваться в Web-приложениях с обязательным указанием второго параметра. Осуществляет переход в указанный вид/папку текущей базы данных. Аргумент "вид" задает имя или алиас вида/папки, если он опущен, то выдается диалоговое окно для определения требуемого вида/папки. В отличие от [OpenView], команда [ViewChange] всегда переключается в вид/папку только в текущем окне.
Пример. Команда переходит в вид "View1" текущей базы данных. @Command( [ViewChange]; "View1" )
ϑ @Command( [SwitchView]; "вид" ) Область применения: вид/папка должны быть открыты в текущем окне. Может использоваться в Web-приложениях с обязательным указанием второго параметра. Осуществляет переход в указанный вид/папку текущей базы данных. Аналогична @Command( [ViewChange] ) за тем лишь исключением, что выполняется немедленно в формуле, а не после всех остальных команд. Аргумент "вид" задает имя или алиас вида/папки, если он опущен, то выдается диалоговое окно для определения требуемого вида/папки.
@Command( [ViewCollapse] ) @Command( [ViewExpand] ) @Command( [ViewExpandWithChildren] ) Область применения: вид/папка должны быть открыты в текущем окне. Можно использовать в Web-приложениях. Для текущей строки-категории команда [ViewCollapse] соответственно свертывает все категории и документы ниже ее, [ViewExpand] раскрывает один уровень категории или документов ниже ее, а [ViewExpand] раскрывает все уровни категории или документов ниже ее. С версии 5 с помощью этих команд можно также программно воздействовать на апплеты видов.
@Command( [ViewCollapseAll] ) @Command( [ViewExpandAll] ) Область применения: вид/папка должны быть открыты в текущем окне. Можно использовать в Web-приложениях. Команда [ViewCollapseAll] соответственно свертывает, а [ViewExpandAll] раскрывает все категории и документы в текущем виде/папке.
С версии 5 с помощью этих команд можно также программно воздействовать на апплеты видов.
@Command( [ViewShowOnlyCategories] ) Область применения: вид/папка должны быть открыты в текущем окне. Отображает в виде только категории без документов. Работает как переключатель.
@Command( [ViewShowOnlySearchResults] ) Область применения: вид/папка должны быть открыты в текущем окне. Поиск с использованием полнотекстового индекса должен быть произведен. Отображает в виде только документы, удовлетворяющие условиям запроса полнотекстового поиска. Работает как переключатель.
@Command( [ViewShowOnlySelected] ) Область применения: вид/папка должны быть открыты в текущем окне. Отображает в виде только выбранные документы. Работает как переключатель.
@Command( [ViewShowOnlyUnread] ) Область применения: вид/папка должны быть открыты в текущем окне. Отображает в виде только непрочтенные документы. Работает как переключатель. Пример. Формула, примененная в акции вида, после выполнения запроса полнотекстового поиска отмечает все отобранные документы. Затем помечает их как непрочтенные, и наконец, отображает только непрочтенные документы. @Command( [EditSelectAll] ); @Command( [ToolsMarkSelectedUnread] ); @Command( [ViewShowOnlySearchResults] ); @Command( [ViewShowOnlyUnread] );
7.6 Команды запуска приложений @Command( [ToolsRunMacro]; "имя_агента" ) Область применения: БД должна быть открыта или ее иконка должна быть выделена в рабочем пространстве. Всегда выполняется последней в формуле, за исключением Webприложений, где все @-команды выполняются последовательно. Выполняет в текущей базе указанного агента. Если параметр "имя_агента" не указано, то выдается диалоговое окно для выбора имени запускаемого агента. Для скрытых агентов его имя надо указывать в скобках. Пример 1. Формула запускает в текущей базе агента по имени "Proba". @Command( [ToolsRunMacro]; "Proba" )
Пример 2. Формула запускает в текущей базе данных скрытого агента "MyHidden". @Command( [ToolsRunMacro]; "(MyHidden)" )
ϑ @Command( [RunAgent]; "имя_агента" ) Область применения: БД должна быть открыта или ее иконка должна быть выделена в рабочем пространстве. Выполняет в текущей базе указанного агента. Аналогична @Command( [ToolsRunMacro] ) за тем лишь исключением, что выполняется немедленно в формуле, а не после всех остальных команд.
@Command( [Execute]; "имя_файла_приложения"; "аргументы_командной_строки" ) Область применения: нельзя применять в формулах диалогового окна. Параметры должны соответствовать формату операционной системы. Запускает внешнее приложение операционной системы. Параметр "аргументы_командной_строки" может быть как строкой, так и текстовым списком.
Пример 1. Команда, используемая в формуле акции формы, загружает стандартную программу калькулятора операционной системы Windows 95. @Command( [Execute]; "C:\\Windows\\Calc.exe" )
Пример 2. Команда загружает текстовый процессор MS Word и подгружает в него два файла документов. Следует заметить, что когда третий аргумент в данной команде был текстовым списком, то загружался только первый файл. @Command( [Execute]; "C:\\MSOffice\\Winword\\Winword.exe"; "D:\\Book\\Glava_06.doc D:\\Book\\Glava_07.doc" )
7.7 Команды для работы с почтой @Command( [MailAddress] ) Область применения: документ должен находиться в режиме редактирования. Указатель курсора должен находиться в пределах редактируемого поля. В документе должно быть хотя бы одно поле, используемое для адресации (SendTo, CopyTo, BlindCopyTo). Выдает диалоговое окно определения почтового адреса (Mail Address). Пользователь может выбрать в окне адресата и при нажатии Ok выбранная информация занесется в соответствующие адресные поля документа. Пример. Документ находится в режиме редактирования и у него имеется поле SendTo. Команда, используемая в формуле акции формы, выдает диалоговое окно определения адреса. Выбрав адресата, нажатием Ok заносим информацию в поле SendTo. @Command( [MailAddress] )
@Command( [MailComposeMemo] ) Область применения: нельзя применять диалогового окна.
в
формулах
Создает в почтовом ящике пользователя пустое почтовое сообщение по форме, используемой по умолчанию для почтовой базы (обычно Memo), и устанавливает фокус на него. После отправки почтового сообщения фокус возвращается в базу, из которой выполнялась команда.
ϑ @Command( [EditQuoteSelection] ) Область применения: документ должен быть открыт в режиме редактирования, и текст должен быть выделен. Преобразует выделенный текст к формату, принятому в письмахответах с использованием цитирования. Другими словами, вставляет в начало каждой строки символ больше (“>”), форматирует текст в строках по 70 символов, и удаляет из текста присоединенные файлы и другие объекты. Следует обратить внимание, что перенос осуществляется только по словам, т.е. если слово состоит более чем из 70 символов, то оно переноситься не будет.
С помощью переменных из Notes.ini можно изменить как символ, вставляемый в начало строки, (переменная QuotePrefix), так и длину строки цитирования (переменная QuoteLineLength). Обратите внимание, что во-первых, данные переменные задаются в Notes.ini без префикса «$» (например, QuoteLineLength=60), а во-вторых, значение этих переменных влияет на результат применения команды [ComposeWithReference] с ключом 8 (см. Стр. 240).
Пример. Формула, примененная в акции вида почтового ящика, позволяет создать ответ на письмо с цитирование в интернет стиле. Данный пример приведен исключительно для демонстрации команды [EditQuoteSelection]. В почтовом ящике, созданном по почтовому шаблону R 6, присутствует встроенные возможности для создания таких писем (например, кнопка Reply -> Reply with Internet-Style History).
@Command([EditDocument]; "1"); REM {открываем текущий документ на редактирование}; @Command([EditGotoField]; "Body"); REM {переключаем фокус на поле Body}; @Command([EditSelectAll]); REM {выделяем все содержимое поля Body}; @Command([EditCopy]); REM {копируем выделенное содержимое поля Body в буфер обмена}; @Command([CloseWindow]);
REM {закрываем письмо с цитатами}; @Command([Compose]; ""; "Memo"); REM {создаем новое письмо}; @UpdateFormulaContext; REM {переключаем контекст на новый документ}; @Command([EditGotoField]; "Body"); REM {переключаем фокус на поле Body}; @Command([EditPaste]); REM {вставляем в поле Body содержимое буфера обмена}; @Command([EditSelectAll]); REM {выделяем все содержимое поля Body}; @Command( [EditQuoteSelection] ); REM {применяем к выделенному фрагменту функцию цитирования};
Нельзя использовать в формулах отбора, колонок, видимости объекта, редактируемой секции, формы и навигатора. Работает только с текстом, представленным в однобайтовой кодировке. При использовании с RTF-полями документ должен перед применением функции быть сохранен.
Осуществляет выделение и замену в тексте определенных его частей.
@Accessed
Нельзя использовать в формулах отбора и навигатора. Функция "чувствительна" к часовому поясу.
Возвращает величину "дата-время" последнего доступа (для чтения или записи) к документу.
@Acos
Без ограничений. Аргумент должен лежать в пределах [-1,1].
Возвращает значение арккосинуса числа или числового списка.
@AddToFolder
Разрешается использование в формулах кнопок панели инструментов, кнопок и гиперобъектов, агентов, а так же в акциях видов и форм.
Добавляет текущий документ в папку с именем, содержащимся в первом аргументе, удаляя при этом тот же документ из папки, имя которой находится во втором аргументе.
Стр. 98
Без ограничений. "чувствительна" к поясу.
Изменяет величину "датавремя" на заданный интервал времени.
Разрешается использовать только в формулах отбора документов и селективной репликации. Не работает в версиях Lotus Notes/Domino ниже R4.
Конструкция SELECT формула_отбора | @AllChildren отбирает все документы, удовлетворяющие формуле отбора, плюс документы, которые являются документами-ответами только на документы, удовлетворяющие формуле отбора.
Разрешается использовать только в формулах отбора документов и селективной репликации. Не работает в версиях Lotus Notes/Domino ниже R4.
Конструкция SELECT формула_отбора | @AllDescendants отбирает все документы, удовлетворяющие формуле отбора, плюс документы, которые являются документами-ответами и документами-ответами на ответ на всех уровнях дерева, "начинающегося" только от документов, удовлетворяющих формуле отбора.
Без ограничений.
Преобразует строку или список строк, представленных в кодировке LMBCS (Lotus Multi-Byte Character Set) соответственно в строку или список строк в кодировке ASCII.
@Asin
Без ограничений. Аргумент должен лежать в пределах [-1,1].
Возвращает значение арксинуса числа или числового списка.
@Atan
Без ограничений.
Возвращает значение арктангенса числа или числового списка.
@Atan2
Без ограничений. Аргументы должны быть числа или числовые списки.
Возвращает значение арктангенса от дроби второго аргумента на первый.
Нельзя использовать в формулах отбора, колонок, редактируемой секции, заголовка окна, полей, формы и области размещения.
Применяется для изменения параметров оповещения в личном почтовом ящике.
@CheckFormulaSyn tax
Нельзя использовать в формулах отбора и столбцов вида.
Проверяет свой аргумент на соответствие правилам языка @-формул.
Нельзя использовать в формулах отбора, колонок, редактируемых секциях и заголовка окна. При использовании в формулах фоновых агентов всегда возвращает значение "None".
Возвращает текстовую строку "Notes", если для доступа к базе данных используется клиентская программа LN, "Web" - в случае использования браузера.
@Command
Нельзя использовать в формулах отбора, колонок, видимости объектов, редактируемой секции, формы, полей, заголовка окна и фоновых агентов.
Выполняет команды LN. Большинство стандартных команд из системного меню LN можно выполнить с помощью этой функции.
@Compare
Нельзя использовать в формулах навигатора.
Осуществляет попарное сравнение двух текстовых списков.
Нельзя использовать в формулах отбора и колонок.
Возвращает путь к файлу NOTES.INI.
Без ограничений.
Определяет, является ли подстрока (или хотя бы один из элементов списка подстрок) частью строки.
@Cos
Без ограничений.
Возвращает значение косинуса числа или числового списка.
@Count
Без ограничений.
Возвращает число элементов в списке, в отличие от @Elements, возвращает для пустой строки и значений не являющихся списком – значение 1.
Нельзя использовать в формулах навигатора. При использовании в формулах полей возвращаемое значение определяется по часам сервера, если БД не является локальной. Функция "чувствительна" к часовому поясу.
Возвращает время и дату создания документа.
Без ограничений. "чувствительна" к поясу.
Функция часовому
Возвращает заданную параметрами дату как величину типа "датавремя", но содержащую только компоненту даты.
Без ограничений. "чувствительна" к поясу.
Функция часовому
Извлекает день месяца из указанной даты.
Нельзя использовать в формулах отбора и колонок. Ограниченно применима в формулах всплывающих окон. Возвращаемое значение не должно превышать 64 Кбайта. Не работает при установке переменной окружения NoExternalApps равной 1.
Находит и возвращает колонку значений из вида или папки в базе данных Notes/Domino.
Нельзя использовать в формулах отбора, колонок, видимости объекта, редактируемой секции и заголовка окна. Возвращаемое значение не должно превышать 64 Кбайта. Не работает при установке переменной окружения NoExternalApps равной 1.
Использует для доступа к соответствующей таблице и колонке ODBC-драйвер, соответствующий указанному источнику данных. Извлекает значения из одной колонки в таблице.
В DOMINO R 6.0.1 ДОКУМЕНТИРОВАНА НЕ ПОЛНОСТЬЮ. Разрешается использовать только в Webприложениях.
Организует ссылки на предыдущий или последующий документ в виде, или на список доступных папок.
Нельзя использовать в формулах отбора, колонок, всплывающих окон. Возвращаемое значение не должно превышать 64 Кбайта. Не работает при установке переменной окружения NoExternalApps равной 1.
Выполняет указанную команду ODBC-драйвера.
Нельзя использовать в формулах отбора, колонок, всплывающих окон и фоновых агентов.
Возвращает 1(True), если база существует, или 0(False) в противном случае.
Нельзя использовать в формулах отбора, колонок и почтовых агентов. Ограниченно применима в формулах всплывающих окон. Результирующее значение может быть неточным, если первая сортировочная колонка "вида" содержит поле, которое может принимать несколько значений (multi-values field), и сортировка колонки указана без категоризации. Возвращаемое значение не должно превышать 64 Кбайта. Не работает при установке переменной окружения NoExternalApps равной 1.
Получив значение ключа, функция просматривает указанный вид или папку, и находит в них все документы, содержащие значение "ключ" в первой отсортированной колонке.
Нельзя использовать в формулах отбора, колонок, заголовка окна, видимости объекта, редактируемой секции и почтовых агентов. Возвращаемое значение не должно превышать 64 Кбайта. Не работает при установке переменной окружения NoExternalApps равной 1.
Использует соответствующий указанному источнику данных ODBC-драйвер для доступа к соответствующей таблице и колонкам. Извлекает и возвращает значения из указанной колонки, принадлежащие к тем записям, у которых значение в ключевой колонке совпадает с указанным параметром ключ.
Возвращает список групп, пользователей и серверов, имеющих доступ менеджера к текущей базе.
Без ограничений.
Возвращает для текущей базы данных имя сервера и собственно БД.
Без ограничений.
Возвращает текущей БД.
@DDEExecute
Нельзя использовать в формулах отбора, колонок, заголовка окна, формы и навигатора. Не работает под управлением операционной среды MacOS и UNIX. Не работает при установке переменной окружения NoExternalApps равной 1. Не работает в Web-приложениях.
Передает указанному DDEприложению команду и выполняет ее. Возвращаемое значение @True(1) в случае удачного выполнения команды, @False(0) в противном случае. В случае передачи некорректного ID связи с DDE-сервером возвращается состояние ошибки.
@DDEInitiate
Нельзя использовать в формулах отбора, колонок, видимости объекта, редактируемой секции, формы, навигатора и области размещения. Не работает под управлением операционной среды MacOS и UNIX. Не работает при установке переменной окружения NoExternalApps равной 1. Не работает в Web-приложениях.
Инициирует связь с DDEсервером и возвращает полученный идентификатор связи с сервером.
В DOMINO R 6.0.1 ДОКУМЕНТИРОВАНА НЕ ПОЛНОСТЬЮ. Нельзя использовать в формулах отбора, колонок, видимости объекта, редактируемой секции, заголовка окна, формы и навигатора. Не работает под управлением операционной среды MacOS и UNIX. Не работает при установке переменной окружения NoExternalApps равной 1. Не работает в Web-приложениях.
Передает данные указанному DDEприложению. Возвращаемое значение @True(1) в случае удачного выполнения команды, @False(0) в противном случае. В случае передачи некорректного ID связи с DDE-сервером возвращается состояние ошибки.
@DDETerminate
В DOMINO R 6.0.1 ДОКУМЕНТИРОВАНА НЕ ПОЛНОСТЬЮ. Нельзя использовать в формулах отбора, колонок, видимости объекта, редактируемой секции, заголовка окна, формы и навигатора. Не работает под управлением операционной среды MacOS и UNIX. Не работает при установке переменной окружения NoExternalApps равной 1. Не работает в Web-приложениях.
Завершает связь с указанным DDEприложением. В случае передачи некорректного ID связи с DDE-сервером возвращается состояние ошибки, в противном случае возвращается пустое значение.
DEFAULT
Без ограничений.
На время выполнения формулы присваивает полю значение по умолчанию.
Разрешается использовать только в формулах агентов. В Web-приложениях не работает.
Удаляет документ, обрабатываемый агентом.
Нельзя использовать в формулах заголовка окна, отбора, колонок, формы и навигатора.
Удаляет поле из текущего документа.
Нельзя использовать в формулах отбора, колонок, агентов,
выполняющихся на сервере (почтовые и по расписанию), заголовка окна и формы. Не передает данные из RTF-полей. Не работает при установке переменной окружения NoExternalApps равной 1. В Webприложениях не работает.
документ по указанной форме. При закрытии модального окна может передать изменения, произошедшие в его полях, в основной документ.
@Do
Нельзя использовать в формулах отбора и столбцов.
Используется для последовательного вычисления нескольких выражений. Вычисляет выражения слева направо и возвращает значение последнего выражения.
Разрешается использовать только в формулах колонок и заголовка окна. В Webприложениях работает только в формулах колонок.
Используется для определения числа ответных документов у текущего документа или категории (считаются только документы-ответы на текущий документ, но ни ответы на ответы).
Разрешается использовать только в формулах колонок и заголовка окна. В Webприложениях работает только в формулах колонок.
Используется для определения числа ответных документов у текущего документа или категории (считаются документы-ответы и ответна-ответ у текущего документа).
Нельзя использовать в формулах отбора, колонок и навигатора.
Возвращает текстовый список, содержащий имена всех полей в текущем документе.
Нельзя использовать в формулах навигатора.
Возвращает приблизительный размер документа в байтах.
только в формулах колонок и заголовка окна. Ограниченно применима в формулах полей. В Web-приложениях работает только в формулах колонок.
представляющее текущий уровень документа или категории в дереве ответов.
@DocLock
Нельзя использовать в формулах отбора, колонок, полей, формы и навигатора. Не работает в Webприложениях.
Выполняет операции блокировки, разблокировки текущего документа, а также может возвращать статус документа (заблокирован/разблокиров ан) и включен ли в текущей БД механизм блокировки.
@DocMark
Разрешается использовать только в формулах агентов. В Web-приложениях не работает.
Устанавливает для текущего документа пометку: сохранять или не сохранять изменения документа на диске.
@DocNumber
Разрешается использовать только в формулах колонок и заголовка окна. Ограниченно применима в формулах полей. В Web-приложениях работает только в формулах колонок.
Возвращает значение, представляющее иерархический уровень текущего документа или категории в дереве ответов.
Нельзя использовать в формулах навигатора.
Возвращает приблизительный размер “усеченной“ при репликации части документа в байтах.
Разрешается использовать только в формулах колонок и заголовка окна. Ограниченно применима в формулах полей. В Web-приложениях работает только в формулах колонок.
Возвращает значение, представляющее иерархический уровень родительского документа или категории в дереве ответов.
Разрешается использовать только в формулах колонок и заголовка окна. Ограниченно применима в формулах полей. В Web-приложениях работает только в формулах колонок.
Возвращает значение представляющее количество документов или категорий на текущем уровне иерархии в дереве ответов.
Нельзя использовать в формулах навигатора. В формулах полей создает ссылку (DocLink) на текущий документ.
Возвращает так называемый универсальный идентификатор документа (UNID) - 32-x символьную комбинацию букв и цифр, уникально идентифицирующую текущий документ во всех репликах распределенной базы.
Нельзя использовать в формулах навигатора. При выполнении на сервере возвращает домен сервера. В Web-приложениях не работает.
Возвращает имя домена для текущего пользователя из личной адресной книги, в соответствии с текущим местом вызова.
Нельзя использовать в формулах отбора, колонок, видимости объекта, редактируемой секции, заголовка окна, всплывающих окон и области размещения.
Осуществляет организацию циклов с постусловием.
@EditECL
Нельзя использовать в формулах отбора, колонок, редактируемой секции, видимости объекта, заголовка окна, всплывающих окон, поля, формы, акций видов и формы и области размещения.
Выводит модальное диалоговое окно с параметрами списка управления выполнением рабочей станции администратора для указанного списка управления выполнением и указанной адресной книги.
@EditUserECL
Нельзя использовать в формулах отбора, колонок, редактируемой секции, видимости объекта, заголовка окна, всплывающих окон, поля, формы, акций видов и формы и области размещения.
Выводит модальное диалоговое окно с параметрами списка управления выполнением текущей рабочей станции.
@Elements
Без ограничений.
Возвращает в формате числа количество текстовых, числовых или "дата-время" элементов в списке.
В DOMINO R 6.0.1 ДОКУМЕНТИРОВАНА НЕ ПОЛНОСТЬЮ. Нельзя использовать в формулах отбора, колонок, видимости объекта, редактируемой секции
Включает или выключает механизм оповещения в почтовом ящике.
. @Ends
Без ограничений.
Определяет, находится ли заданная подстрока (или хотя бы один из элементов списка подстрок) в самом конце строки.
Нельзя использовать в формулах отбора, колонок, навигатора и Web-приложениях. Ограниченно применима в формулах всплывающих окон. Для присвоения переменным окружения значения при использовании в теле других функций (таких как @If или @Do) применяйте функцию @SetEnvironment. В формулах выполняющихся на сервере, например, в теле агента по расписанию, идет обращение к переменным окружения сервера, а не рабочей станции. Возвращаемое значение всегда есть текстовая строка.
Устанавливает или возвращает значение переменной окружения.
Нельзя использовать в формулах отбора, колонок, видимости объекта, навигатора и Webприложениях. Ограниченно применима в формулах всплывающих окон.
Присваивает значение переменной окружения
Без ограничений.
Генерирует ситуацию ошибки. Возвращаемое значение @Error.
однако применение функции в формулах отбора и колонок может привести к непредсказуемым результатам.
рассматривает свой параметр как текстовое представление @формулы, компилирует и вычисляет ее. Возвращает значение последнего выражения в @-формуле или ситуацию ошибки.
@Exp
Без ограничений. Аргумент должен лежать в пределах [-11355.1371, 11356.5234].
Вычисляет значение экспоненциальной функции от числа или числового списка.
@Explode
Без ограничений.
Возвращает список, составленный из подстрок списка строк или диапазона дат.
Предназначена для использования в формулах проверки вводимых данных редактируемых полей, но может быть также использована в формулах формы и агентов. В последнем случае, только возвращает значение, но не выводит предупреждающих сообщений.
В формуле проверки вводимых данных редактируемых полей, функция выводит диалоговое окно с текстом сообщения об ошибке.
@False
Без ограничений.
Возвращает 0 (False).
FIELD Стр.15
Нельзя использовать в формулах отбора, колонок, видимости объекта, заголовка окна, формы и навигатора.
Присваивает полю.
@FileDir
Без ограничений.
Выделяет и возвращает из своего параметра-строки имя директории, или другими словами часть строки от начала до первого правого символа слеша (включая его), или если этого символа нет, то пустую строку.
Нельзя использовать в формулах отбора, колонок, агентов, запускаемых вручную и фоновых. Не работает в Web-приложениях.
Возвращает список доступных для клиетна Notes шрифтов в виде текстового списка.
Нельзя использовать в формулах отбора, колонок, видимости объекта, редактируемой секции, заголовка окна, всплывающих окон и области размещения.
Осуществляет организацию циклов по счетчику.
@FormLanguage
В DOMINO R 6.0.1 ДОКУМЕНТИРОВАНА.
НЕ
Для баз, использующих формы с поддержкой нескольких языков, возвращает имя языка текущей формы.
@GetAddressBooks
Нельзя использовать в формулах отбора и колонок.
Возвращает список адресных книг клиента или сервера (в зависимости от расположения БД, в которой выполняется формула).
Без ограничений.
Функция возвращает текущие настройки часового пояса в каноническом формате. При выполнении функции на стороне сервера возвращает настройки часового пояса сервера, в клиенте – соответственно рабочей станции.
Нельзя использовать в формулах отбора, колонок, всплывающих окон и навигатора.
Возвращает значение поля по его имени и универсальному идентификатору документа.
Нельзя использовать в формулах заголовка окна и кнопок панели инструментов.
Возвращает для текущего документа значение поля по его имени. Если указанное поле в текущем документе отсутствует, то возвращается пустая строка. Для полей, содержащих значение типа список, возвращается только первое значение из списка.
Разрешается использовать только в формулах кнопок панели инструментов, акций формы и полей. Не работает в Web-приложениях. Документ должен находиться либо в режиме редактирования, либо чтения, в этом случае текст или входящий в таблицу объект должен быть выделен.
Возвращает в зависимости от флага либо номер текущей строки, либо номер колонки, либо программное имя таблицы. В R 6.0.1 функция корректно работает только в обработчике события onHelp. В остальных контекстах не зависимо от флагов функция возвращает 1, как число (а не текст).
Разрешается использовать только в Web-приложениях и в контексте формул видимости объекта, редактируемой секции, заголовка окна, гиперобъекта, полей, формы, акций вида и формы, а также навигатора. В интерфейсе клиента Notes всегда возвращает пустую строку.
В Web-приложениях возвращает значение полей типа header fields.
@GetPortsList
Нельзя использовать в формулах отбора, колонок. Не работает в Web-приложениях.
Возвращает текстовый список включенных/выключенных портов.
@GetProfileField
Нельзя использовать в формулах отбора, колонок, видимости объекта, редактируемой секции, заголовка окна, полей, формы, акций формы и вида и области размещения.
Функция возвращает значение поля из профильного документа по имени поля и имени документа.
Нельзя использовать в формулах отбора, колонок, агентов по расписанию, видимости объекта, редактируемой секции, заголовка окна, гиперобъектов, всплывающих окон, формы, акции формы, навигатора и области размещения. Не работает в Web-приложениях.
Возвращает значения атрибутов текущего вида.
Физически удаляет документ из базы данных.
Стр. 130
В DOMINO R 6.0.1 ДОКУМЕНТИРОВАНА НЕ ПОЛНОСТЬЮ. Предназначена для использования только в формулах агентов. Не работает в Web-приложениях.
@HashPassword
Без ограничений.
Функция осуществляет кодирование строки более стойкое, чем функция @Password.
Стр. 231
@HardDeleteDocum ent
Стр. 136
@Hour Стр. 96
Без ограничений. "чувствительна" к поясу.
@If
Без ограничений.
Осуществляет проверку входящих в него условий, и выполняет связанное с истинным (TRUE) условием действие. Возвращается значение выполненного действия.
Без ограничений.
Возвращает значение первого параметра, если в нем нет ошибки. В противном случае возвращается значение второго параметра (если он есть), или пустая строка (при его отсутствии).
Без ограничений.
"Сцепляет" все элементы списка строк в одну строку.
Стр. 38
@IfError Стр. 235
@Implode Стр. 58
290
Функция часовому
Возвращает количество часов в параметре "датавремя".
Нельзя использовать в формулах навигатора. Предназначена для работы с документами, созданными по форме с включенной опцией наследования полей. Если опция не включена, возвращает такое же значение, что и @DocumentUniqueID. В формулах полей создает ссылку (DocLink) на указанный документ.
Возвращает универсальный идентификатор документа, который был текущим в момент создания документа, для которого используется эта функция.
@Integer
Без ограничений.
Возвращает целую часть числа или числового списка.
@IsAgentEnabled
Нельзя использовать в формулах отбора, колонок, и не предназначена для использования в формулах заголовка окна и формы. БД должна быть открыта, в противном случае возвращается 0. Для агентов созданных в LN версии 3.х, и для агентов, выполняющихся не по расписанию, всегда возвращает 1. Не работает в Webприложениях.
Возвращает 1 (True) для "включенного" агента, 0 (False) если он не включен, или не существует.
@IsAppInstalled
Нельзя использовать в формулах отбора и редактируемой секции.
Определяет тип установленного клиентского программного обеспечения (дизайнерский клиент/администраторский клиент).
Нельзя использовать в формулах навигатора. В формуле колонок и отбора может использоваться только с полями, имеющими флаг SUMMARY.
Проверяют наличие документе поля указанным именем.
@IsCategory
Разрешается использовать только в формулах колонок.
Проверяет, является ли строка в виде категорией или нет.
отбора, колонок, агентов, формы, акций вида и навигатора.
текущий документ находится в режиме редактирования, или 0 (FALSE) в противном случае.
@IsDocBeingLoaded
Разрешается использовать только в формулах видимости объекта, заголовка окна, полей и формы.
Возвращает 1 (TRUE), если текущий документ в настоящее время загружается в память для последующего отображения, или 0 (FALSE) в противном случае.
Разрешается использовать в формулах полей, может ограниченно использоваться в формулах кнопок панели инструментов, кнопок, гиперобъектов и акций формы. В Web-приложениях не работает.
Возвращает 1 (TRUE), если в настоящее время текущий документ отправляется почтой, или 0 (FALSE) в противном случае.
Разрешается использовать в формулах полей, может ограниченно использоваться в формулах кнопок панели инструментов, кнопок, гиперобъектов и акций формы.
Возвращает 1 (TRUE), если в настоящее время текущий документ пересчитывается, или 0 (FALSE) в противном случае.
Разрешается использовать в формулах полей, может ограниченно использоваться в формулах кнопок панели инструментов, кнопок, гиперобъектов и акций формы.
Возвращает 1 (TRUE), если в настоящее время текущий документ сохраняется, или 0 (FALSE) в противном случае.
@IsDocTruncated
Нельзя использовать в формулах навигатора.
Возвращает 1 (TRUE), если текущий документ является "усеченным" в процессе репликации, или 0 (FALSE) в противном случае.
@IsError
Нельзя использовать в формулах навигатора.
Возвращает 1 (TRUE) если аргумент соответствует @ERROR, и 0 (FALSE) в противном случае.
Разрешается использовать только в формулах колонок. В
данный уровень документов в виде "разворачиваемым".
@IsMember
Без ограничений.
Возвращает 1 (TRUE), если строка является элементом списка строк, или 0 (FALSE) в противном случае.
Стр. 102
@IsModalHelp
Без ограничений. В приложениях не работает.
Web-
Возвращает 1 (TRUE), если текущий документ является документом модальной подсказки, и 0 (FALSE) в противном случае.
@IsNewDoc
Нельзя использовать в формулах навигатора. Корректно работает в формулах кнопок панели инструментов, кнопок, видимости абзацев, доступа к секции, заголовка окна, полей, формы и акций формы. При использовании в формулах столбцов, отбора документов, агентах и акциях видов всегда возвращает значение 0.
Возвращает 1 (TRUE), если редактируемый документ еще не сохранялся на диске, или 0 (FALSE) в противном случае.
Без ограничений.
Возвращает 1 (TRUE), если строка не является элементом списка строк, или 0 (FALSE) в противном случае.
Нельзя использовать в формулах заголовка окна.
Возвращает 1 (TRUE), если параметр является пустой строкой и 0 (FALSE) во всех остальных случаях, включая состояние ошибки (@Error) и список из пустых строк.
Без ограничений.
Проверяет значение и возвращает 1 (TRUE), если параметр является числом или числовым списком, или 0 (FALSE) в противном случае.
Нельзя использовать в формулах навигатора. Для документов, которые еще не разу не сохранялись на диске, всегда
Возвращает 1 (TRUE), если документ является документом-ответом (Response), или 0 (FALSE) в
Возвращает 1 (TRUE), если параметр является строкой или списком строк, или 0 (FALSE) в противном случае.
Без ограничений.
Возвращает 1 (TRUE), если параметр является величиной или списком величин "дата-время", или 0 (FALSE) в противном случае.
Нельзя использовать в формулах навигатора. В формуле колонок может использоваться только с полями, имеющими флаг SUMMARY.
Проверяет наличие документе поля указанным именем.
@IsValid
Нельзя использовать в формулах отбора, колонок, агентов по расписанию, видимости объектов и заголовка окна.
Возвращает 1 (True) если все формулы проверки для значений полей текущей формы возвращают 1 (True), или 0 (FALSE) в противном случае.
@IsVirtualizedDirector y
В DOMINO R 6.0.1 ДОКУМЕНТИРОВАНА.
Возвращает 1 (True) если на сервере разрешен режим виртуальных директорий, 0 (FALSE) в противном случае. Под виртуальными директориями понимается режим сервера xSP (т.е. когда на одном сервере могут хоститься несколько организаций).
@Keywords
Без ограничений. При использовании с третьим параметром может возвращать некорректный результат.
Без ограничений. Аргумент должен быть больше нуля.
Возвращает число или числовой список, являющийся десятичным логарифмом от аргумента.
@LowerCase
Без ограничений.
Преобразует все символы строки-аргумента к нижнему регистру.
Нельзя использовать в формулах колонок. В Web-приложениях не работает.
Возвращает двухэлементный текстовый список формата "сервер": "файл почтового ящика", соответствующий текущему размещению почтового ящика пользователя.
Нельзя использовать в формулах колонок и отбора. В Webприложениях не работает.
Возвращает 1 (TRUE), если в общих почтовых настройках отмечена опция "Encrypt saved copy of mail that you send" (шифровать сохраняемую в почтовом ящике копию почтового сообщения), и 0 (FALSE) в противном случае.
Нельзя использовать в формулах колонок и отбора. В Webприложениях не работает.
Возвращает 1 (TRUE), если в общих почтовых настройках отмечена опция "Encrypt mail that you send" (шифровать отправляемую почту), и 0 (FALSE) в противном случае.
Нельзя использовать в формулах колонок и отбора. В Webприложениях не работает.
почтовых настройках выбрано "Don't keep a copy" (не сохранять копию);
• •
@MailSend Стр.138
@MailSignPreferenc e Стр. 145
@Matches
Стр. 100
2, если выбрано "Always prompt" (всегда выводить окно, позволяющее конкретно разрешить вопрос о сохранении).
Нельзя использовать в формулах отбора, колонок, видимости объекта, заголовка окна и всплывающих окон. Не работает при установке переменной окружения NoExternalApps равной 1. В Web-приложениях не работает.
Функция текущий получателю.
Нельзя использовать в формулах колонок и отбора. В Webприложениях не работает.
Возвращает 1 (TRUE), если в общих почтовых настройках отмечена опция "Sign mail that you send" ("подписывать" отправляемую почту), и 0 (FALSE) в противном случае.
Без ограничений.
Проверяет указанную строку на соответствие строке-образцу.
Без ограничений.
При двух параметрах возвращает наибольшее из двух чисел или числовых
Стр. 64
@Max
1, если выбрано "Always keep a copy" (всегда сохранять копию);
списков. Для списков выполняется попарное сравнение. В варианте с одним параметров – возвращает значение наибольшего элемента списка.
@Member
Без ограничений.
Возвращает 0, если строка не содержится в списке строк; возвращает величину от 1 до N, определяющую положение строки в списке строк.
Без ограничений.
Возвращает указанное число символов из средины строки, просматривая ее слева направо.
Без ограничений.
Возвращает указанное число символов из средины строки, просматривая ее справа налево.
Без ограничений.
При двух параметрах возвращает наименьшее из двух чисел или числовых списков. Для списков выполняется попарное сравнение. В варианте с одним параметров – возвращает значение наименьшего элемента списка.
Стр. 103
@Middle Стр. 70
@MiddleBack Стр. 78
@Min Стр. 101
@Minute Стр. 96
@Modified Стр. 115
298
Без ограничений. "чувствительна" к поясу.
Корректно формулах
Функция часовому
работает только в столбцов. Нельзя
Возвращает количество минут в параметре "датавремя".
использовать в формулах навигатора, видимости объекта, формы, редактируемой секции, почтовых агентах и агентах, запускаемых по событию вставки документов из буфера обмена. При использовании в формулах вычисляемых и вычисляемых для показа полей возвращает значение соответствующее предпоследнему, а не последнему времени модификации. Функция "чувствительна" к часовому поясу.
показывающую, когда документ в последний раз редактировался и сохранялся.
@Modulo
Без ограничений. Второй аргумент не должен содержать элементов равных нулю.
Возвращает число или числовой список, соответствующий остатку от деления первого аргумента на второй. В случае списков выполняется попарная операция вычисления остатка.
@Month
Без ограничений. "чувствительна" к поясу.
Функция часовому
Возвращает номер месяца в параметре "дата-время".
Без ограничений. При использовании с именами, полученными из адресных книг Lotus Notes, не работают форматы [A], [G], [I], [P], [Q] и [S]. Они предназначены для работы с именами адресов, пришедших из внешней (не Lotus Notes) почты.
Возвращает определенные составляющие имени пользователя.
Нельзя использовать в формулах отбора, колонок.
Функция просматривает все доступные адресные книги, ищет в них пользователей с именами из второго
аргумента и возвращает объединенный текстовый список с определенной параметрами функции информацией об этих пользователях. @Narrow
Предназначена для использования только в формулах преобразования значений полей.
Преобразует строку из двухбайтовой кодировки DBCS в однобайтовую SBCS.
@NewLine
Нельзя использовать в формулах отбора, колонок, видимости объекта, формы, заголовка окна, области размещения и в контексте функции @Prompt. В Web-приложениях не работает в формулах отбора, формы и заголовка окна.
Вставляет символ перехода на новую строку (возврат каретки) в текстовую строку.
@No
Без ограничений.
Всегда возвращает 0.
@NoteID
Нельзя использовать в формулах формы и навигатора.
Возвращает 8-и символьный идентификатор документа в базе.
Нельзя использовать в формулах отбора, колонок, видимости объекта, редактируемой секции, заголовка окна, всплывающих окон, формы и области размещения.
В контексте функции @Transform возвращает значение, которое не добавляется в результирующий список. Во всех остальных контекстах возвращает пустую строку.
Без ограничений.
Возвращает текущие дату и время как значение типа "дата-время".
Нельзя использовать в формулах отбора, колонок, заголовка окна и формы.
Функция удаляет почтового адреса повторяющиеся в домены.
В DOMINO R 6.0.1 ДОКУМЕНТИРОВАНА.
Возвращает поддиректорию, содержащую каталог данных компании, в которой
зарегистрирован текущий пользователь. Имеется в виду режим сервера xSP (т.е. когда на одном сервере могут хоститься несколько организаций). В остальных случаях возвращает пустую строку.
@Password
Без ограничений.
Возвращает закодированную исходной.
Без ограничений. Функция работает в Web-приложениях.
Возвращает в виде числа уровень сложности пароля для расшифровки.
@Pi
Без ограничений.
Возвращает число "пи".
@PickList
Нельзя использовать в формулах отбора, колонок, почтовых агентов и агентов, выполняющихся по расписанию, видимости объекта, заголовка окна, всплывающих окон и формы. Не работает при установке переменной окружения NoExternalApps равной 1. В Webприложениях не работает.
Выдает модальное диалоговое окно с информацией из определенной базы данных или из доступных адресных книг.
Без ограничений. При использовании в формулах отбора, колонок и фоновых агентов возвращает платформу
Возвращает текстовый список или строку, определяющую платформу сервера/клиента.
согласно местонахождению базы данных. Для серверных баз данных соответственно платформу сервера, для локальной базы данных платформу клиента. В остальных формулах возвращает серверную платформу. В Webприложениях возвращает только серверную платформу. @PostedCommand
Нельзя использовать в формулах отбора, колонок, видимости объектов, редактируемой секции, формы, полей, заголовка окна, всплывающих окон и фоновых агентов.
Выполняет команду LN. Большинство стандартных команд из системного меню LN можно выполнить с помощью этой функции. Отличается от @Command тем, что выполняется в формуле в последнюю очередь, и не имеет возвращаемого значения.
@Power
Без ограничений.
Возвращает число или числовой список, соответствующий возведению первого аргумента в степень второго. Для списков операция осуществляется попарно.
@Prompt
Нельзя использовать в формулах отбора, колонок, почтовых агентов и агентов, выполняющихся по расписанию, видимости объекта и всплывающих окон. Ограниченно применима в формулах заголовка окна и формы. Не работает при установке переменной окружения NoExternalApps равной 1. В Webприложениях не работает.
Используется для запроса информации у пользователя. Функция показывает диалоговое окно заданного стиля, с заданным заголовком и текстом, и содержащее информацию на основании остальных параметров.
Без ограничений.
Преобразует первый символ каждого слова строки или текстового списка к верхнему регистру,
Нельзя использовать в формулах отбора, колонок, видимости объекта, редактируемой секции, заголовка окна, полей, формы, области размещения, акций видов и формы и области размещения.
Копирует список управления выполнением администратора из указанной адресной книги на текущую рабочую станцию.
@RegQueryValue Стр. 218
В DOMINO R 6.0.1 НЕ ДОКУМЕНТИРОВАНА. Для не Windows-платформ возвращает пустую строку.
Возвращает ключей из реестра.
REM
Без ограничений.
Позволяет включать формулу комментарии.
Стр. 61
Без ограничений. Длина возвращаемой строки не должна превышать 1024 символа.
Возвращает строку, полученную из исходной путем многократной операции конкатенации ее с собой.
@Replace
Без ограничений.
Ищет в списке строк значения, указанные в списке для поиска и заменяет каждое найденное значение соответствующим значением из списка для замены.
Без ограничений.
Выполняет замены в исходной строке или списке строк всех вхождений слов или фраз из списка строк для поиска, на соответствующие слова или фразы из списка строк для замены.
Нельзя использовать в формулах отбора.
Возвращает идентификатор реплики текущей базы данных.
Нельзя использовать в формулах области размещения.
Возвращает имя сервера текущей базы данных.
Без ограничений.
Присваивает значение временной переменной.
Нельзя использовать в формулах отбора, колонок, всплывающих окон и навигатора.
Присваивает новое значение полю по его имени и универсальному идентификатору.
Нельзя использовать в формулах отбора, колонок, всплывающих окон и Web-приложениях. Следует помнить, что в формулах выполняющихся на сервере идет обращение к переменным окружения сервера, а не рабочей станции. Возвращаемое значение всегда есть текстовая строка.
Устанавливает значение переменной окружения.
Нельзя использовать в формулах отбора, колонок, видимости объекта, заголовка окна, всплывающих окон, формы, полей и навигатора.
Присваивает значение полю в текущем документе.
Нельзя использовать в формулах кнопок панели инструментов, колонок, любых типов агентов, видимости объекта, редактируемой секции, всплывающих окон и области размещения.
В Web-приложениях устанавливает значение для полей типа response header fields.
Нельзя использовать в формулах отбора, колонок, видимости объекта, заголовка окна, всплывающих окон, полей, формы, и навигатора.
Присваивает значение полю в профильном документе или создает профильный документ.
Стр. 193
Предназначена для использования только в формулах акций, гиперобъектов, кнопок панели инструментов и агентов, запускаемых вручную.
Позволяет указать фрейм, в котором необходимо открыть вид, страницу, набор фреймов или создать/отредактировать документ.
Определяет знак числа или элементов числового списка.
@Sin
Без ограничений.
Определяет синус числа или элементов числового списка.
@Sort
Нельзя использовать в формулах навигатора.
Осуществляет сортировку элементов списка.
@Soundex
Предназначена для использования только в формулах колонок БД Domino Directory.
Возвращает код "созвучия" для текстовой строки.
@Sqrt
Без ограничений. Аргумент должен быть положительным числом.
Определяет корень квадратный от числа или элементов числового списка.
@StatusBar
Предназначена для использования только в формулах кнопок панели инструментов, заголовка окна, гиперобъектов, полей, акций видов и формы, а также навигатора. В Web-приложениях не работает.
Выводит сообщение строку состояния.
Без ограничений.
Возвращает указанное число значений, считая от начала или конца списка.
Возвращает 1 (TRUE).
Стр. 234
Предназначена для использования в формулах проверки вводимых данных редактируемых полей.
@Sum
Без ограничений.
Возвращает сумму всех элементов числового списка или нескольких
Без ограничений. При использовании в формулах полей, возвращает значение текущей даты по таймеру рабочей станции, а не сервера.
Возвращает текущую дату.
Без ограничений. При использовании в формулах полей, возвращает значение "дата-время" по таймеру рабочей станции, а не сервера.
Возвращает значение "дата-время", соответствующее завтрашнему дню.
Нельзя использовать в формулах заголовка окна.
Преобразует, если возможно, значение или список значений в число или числовой список.
Нельзя использовать в формулах заголовка окна.
Преобразует, если возможно, значение или список значений в величину "дата-время" или список величин "дата-время".
Стр. 46
Нельзя использовать в формулах отбора, колонок, видимости объекта, редактируемой секции, заголовка окна, всплывающих окон и области размещения.
Осуществляет выполнение цикла по элементам списка.
@Trim
Без ограничений.
Удаляет пробелы в начале, в конце и внутри строки, или в списке строк.
@True
Без ограничений.
Возвращает 1 (TRUE).
@Unavailable
Нельзя использовать в формулах заголовка окна, отбора, колонок, формы, навигатора и видимости объекта.
Удаляет поле в текущем документе.
Стр. 128
Нельзя использовать в формулах отбора, колонок, видимости объекта, редактируемой секции, заголовка окна, всплывающих окон, полей, формы, навигатора и области размещения.
В случае если у базы установлено свойство "мягких" отметок об удалении, снимает такие отметки с удаленных документов.
@Unique
Без ограничений.
При вызове без параметра возвращает случайным образом сгенерированную
уникальную строку. При вызове с параметром, удаляет из списка строк повторяющиеся значения. @UpdateFormulaCo ntext Стр. 43
Предназначена для использования в интерактивных приложениях, не работает в контекстах, где не допустимо использование @Command. Не работает в Web-приложениях.
В рамках интерфейса клиента Notes используется для обновления контекста текущей формулы.
@UpperCase
Без ограничений.
Преобразует все символы строки или списка строк к верхнему регистру.
Без ограничений.
Выполняет преобразование отношению к @URLDecode.
Без ограничений.
Преобразует строку или список строк к формату пригодному для использования в URL.
@URLGetHeader
Может использовать только в контексте баз данных "Server Web Navigator" и "Personal Web Navigator". Нельзя использовать в формулах отбора, колонок, видимости объекта, редактируемой секции, заголовка окна, полей и формы. Не работает в Web-приложениях.
Возвращает значение header полей URL.
@URLHistory
Может использовать только в контексте баз данных "Server Web Navigator" и "Personal Web Navigator". Нельзя использовать в формулах отбора, колонок, видимости объекта, агентов по расписанию, редактируемой секции, заголовка окна, полей и формы. Не работает в Web-
Выполняет определенные команды с ресурсами URL, которые уже когда-либо загружались и информация о них была сохранена в списке предысторий URL (History URL List).
Нельзя использовать в формулах отбора, колонок, видимости объекта, редактируемой секции, заголовка окна, полей и формы.
Выдает диалоговое окно для открытия ресурса URL, или открывает ресурс URL.
Нельзя использовать в формулах кнопок панели инструментов, отбора, колонок, агентов, всплывающих окон и области размещения. В интерфейсе клиента Notes всегда возвращает пустую строку.
В Web-приложениях возвращает параметры из текущего URL.
Нельзя использовать в формулах отбора, колонок, фоновых агентов и всплывающих окон. В Notes R 4.х автоматически заменяется на функцию @V4UserAccess. Для локальных баз в варианте синтаксиса без второго параметра и с опущенным в ACL флагом "Enforce a consistent Access Control List across all replicas of this database." (Использовать единый список управления доступом для всех реплик) всегда возвращает значение 6:1:1:1:1:1:1:1:1. Если пользователь не имеет доступа к базе, он получит сообщение: "You are not authorized to perform that operation." (Вы неавторизованы для выполнения данной операции). Не работает с оператором Evaluate LotusScript.
Возвращает число или числовой список, элементы которого позволяют определить уровень доступа текущего пользователя к указанной БД.
Без ограничений.
Возвращает основное или альтернативное имя пользователя или сервера в каноническом формате ([Canonicalize]).
Возвращает имя основного или альтернативного языка.
Стр. 181
@UserNamesList
Нельзя использовать в формулах отбора, колонок, фоновых агентов, заголовка окна, навигатора и области размещения. Предназначена для использования в БД, расположенных на сервере, или для локальных баз данных с установленным свойством "Enforce a consistent Access Control List across all replicas" (Использовать единый список управления доступом для всех реплик). Для локальных баз данных без этого свойства всегда возвращает пустую строку.
Функция текстовый содержащий доступа пользователя базе данных.
@UserPrivileges
Нельзя использовать в формулах отбора, колонок и фоновых агентов. Не работает в Webприложениях.
Функция возвращает для текущего пользователя текстовый список порядковых номеров, назначенных ему привилегий (аналог ролей в LN R 2.x), но не сами имена привилегий.
@UserRoles
Нельзя использовать в формулах отбора, колонок и фоновых агентов. Предназначена для использования в БД, расположенных на сервере, или для локальных баз данных с установленным свойством "Enforce a consistent Access Control List across all replicas"
Возвращает текстовый список имен ролей, на которые в списке управления доступом текущей базы назначен текущий пользователь.
(Использовать единый список управления доступом для всех реплик). Для локальных баз данных без этого свойства всегда возвращает пустую строку. @V2If
Без ограничений.
Аналог функции @If для версии LN 2.х
@V3UserName
Без ограничений.
Аналог функции @UserName для версии 3.х. Возвращает имя текущего пользователя или имя сервера в сокращенном формате ([Abbreviate]).
@V4UserAccess
Нельзя использовать в формулах отбора, колонок и фоновых агентов. Для локальных баз с опущенным в ACL флагом "Enforce a consistent Access Control List across all replicas of this database." (Использовать единый список управления доступом для всех реплик) всегда возвращает значение 6:1:1. Если пользователь не имеет доступа к базе, он получит сообщение: "You are not authorized to perform that operation." (Вы неавторизованы для выполнения данной операции).
Аналог функции @UserAccess для версии 4.х. Возвращает числовой список из трех элементов, позволяющий определить уровень доступа текущего пользователя в указанной базе.
@ValidateInternetAd dress
В DOMINO R 6.0.1 НЕ ДОКУМЕНТИРОВАНА. Работает в формулах проверки значения полей и в формулах вычисляемых полей.
Функция проверяет почтовый адрес на соответствие его стандартам RFC 822 или RFC 821.
В DOMINO R 6.0.1 ДОКУМЕНТИРОВАНА.
НЕ
Сравнивает два пароля, и возвращает 1 (TRUE), если пароли эквивалентны, и 0 (FALSE) в противном случае.
Без ограничений. При использовании в формулах отбора, колонок и фоновых
Возвращает текстовую строку соответствующую релизу версии Domino.
агентов возвращает версию Lotus Notes/Domino согласно местонахождению базы данных. Если она находится на сервере, то для сервера, и для локальной базы данных соответственно версию клиента LN. В остальных формулах возвращает версию рабочей станции. @ViewTitle Стр. 231
@WebDBName
Нельзя использовать в формулах отбора, колонок, фоновых агентов, заголовка окна, полей, редактируемой секции, видимости объектов (за исключением акций видов).
Возвращает название текущего вида или папки.
Без ограничений.
Возвращает имя текущей базы данных в формате, пригодном для использования в URL
Стр. 228
@Weekday Стр. 94 @While Стр. 45
@Wide
@Word
Без ограничений. "чувствительна" к поясу.
Функция часовому
Определяет день недели для величины типа "датавремя".
Нельзя использовать в формулах отбора, колонок, видимости объекта, редактируемой секции, заголовка окна, всплывающих окон, формы и области размещения.
Осуществляет организацию циклов с предусловием.
Предназначена использования формулах полей.
Преобразует строку из однобайтовой кодировки SBCS в двухбайтовую DBCS.
только
для в
Без ограничений.
Функция просматривает исходную строку слева направо и возвращает "слово" по его позиции в строке.
Стр. 87
@Year Стр. 95
Без ограничений. "чувствительна" к поясу.
Функция часовому
Из указанной величины "дата-время" извлекает и возвращает год.
Без ограничений. Использование функции в формулах колонок и отбора документов может иногда приводить к отображению недостоверных данных, особенно в момент перехода дат. При использовании в формулах полей, возвращает значение "дата-время" по таймеру рабочей станции, а не сервера.
Добавляет для указанной БД ее иконку на рабочее пространство без открытия БД.
AddDatabaseRepID
Без ограничений.
Добавляет для БД, указанной идентификатором реплики и сервером, ее иконку на рабочее пространство без открытия БД.
AdminCertify
Нельзя применять в формулах диалогового окна.
Используется для сертификации ID-файлов пользователей и серверов.
AdminCreateGroup
Работает только когда в клиенте администратора открыт вид «Группы».
В документации сказано, что в 6-й версии команда является устаревшей. В 5-й версии при открытом в клиенте администратора виде «Группы», выводила форму для ввода группы с пустыми значениями. В 6-й версии при аналогичных условиях выводит предупреждающее окно с текстом «Command is not supported.» (команда не поддерживается).
AdminCrossCertifyIDF ile
Нельзя применять в формулах диалогового окна.
Используется для кросс-сертификатов.
AdminCrossCertifyKey
Нельзя применять в формулах диалогового окна.
Используется для создания кросс-сертификата с использованием ключа, ассоциированного с ID-файлом.
В документации сказано, что в 6-й версии команда является устаревшей. В предыдущих версиях должна была выдавать диалоговое окно для анализа характеристик выбранной базы данных. В 6-й версии выводит предупреждающее окно с текстом «Command is not supported.» (команда не поддерживается).
AdminDatabaseQuota s
Работает только в клиенте администратора.
В документации сказано, что в 6-й версии команда является устаревшей. В предыдущих версиях должна была для выбранного сервера выдавать список баз данных, у которых можно изменить их максимальный размер. В 6-й версии выводит предупреждающее окно с текстом «Command is not supported.» (команда не поддерживается).
AdminIDFileClearPass word
Нельзя применять в формулах диалогового окна.
Используется для снятия пароля с ID-файла без переключения на этот ID-файл.
AdminIDFileExamine
Нельзя применять в формулах диалогового окна.
Используется для получения информации о ID-файла (тип лицензии, сертификат, ключи шифрования и т.д.)
AdminIDFileSetPassw ord
Нельзя применять в формулах диалогового окна.
Используется для смены пароля ID-файла, в частности может быть использована для смены пароля ID-файла сертификатора.
Administration
Нельзя применять в формулах диалогового окна.
Открывает или передает фокус на клиент администратора, если последний установлен на локальной машине.
Выдает диалоговое окно для создания иерархического IDфайла сертификатора новой организации.
AdminNewOrgUnit
Нельзя применять в формулах диалогового окна.
Используется для создания иерархического ID-файла сертификатора новой организационной единицы.
AdminOpenAddressB ook
Работает только в клиенте администратора.
В документации сказано, что в 6-й версии команда является устаревшей. В предыдущих версиях должна была для выбранного сервера открывать адресную книгу, если их несколько, выдавалось диалоговое окно для выбора адресной книги. В 6-й версии выводит предупреждающее окно с текстом «Command is not supported.» (команда не поддерживается).
AdminOpenCatalog
Работает только в клиенте администратора.
В документации сказано, что для выбранного сервера должна открывать базу данных каталога (Catalog.nsf). К сожалению, у автора команда выдавала только предупреждающее окно с текстом «Cannot execute the specified command.» (не могу выполнить указанную команду).
AdminOpenCertLog
Работает только в клиенте администратора.
В документации сказано, что в 6-й версии команда является устаревшей. В предыдущих версиях должна была для выбранного сервера открывать базу данных журнала сертификатов (Certlog.nsf). В 6й версии выводит предупреждающее окно с текстом «Command is not supported.» (команда не поддерживается).
В документации сказано, что в 6-й версии команда является устаревшей. В предыдущих версиях должна была для выбранного сервера открывать адресную книгу и выводит вид "Группы" (Groups), если адресных книг несколько выдавалось диалоговое окно для выбора адресной книги. В 6-й версии выводит предупреждающее окно с текстом «Command is not supported.» (команда не поддерживается).
AdminOpenServerLog
Работает только в клиенте администратора.
В документации сказано, что в 6-й версии команда является устаревшей. В предыдущих версиях должна была для выбранного сервера открывать базу данных журнала сервера (Log.nsf). В 6-й версии выводит предупреждающее окно с текстом «Command is not supported.» (команда не поддерживается).
AdminOpenServersVi ew
Работает только в клиенте администратора.
В документации сказано, что в 6-й версии команда является устаревшей. В предыдущих версиях должна была для выбранного сервера должна открывать адресную книгу и выводить вид "Сервера" (Servers), если адресных книг несколько выдавалось диалоговое окно для выбора адресной книги. В 6-й версии выводит предупреждающее окно с текстом «Command is not supported.» (команда не поддерживается).
В документации сказано, что в 6-й версии команда является устаревшей. В предыдущих версиях должна была для выбранного сервера открывать базу данных статистики работы сервера (Statrep.nsf). В 6-й версии выводит предупреждающее окно с текстом «Command is not supported.» (команда не поддерживается).
AdminOpenUsersView
Работает только в клиенте администратора.
В документации сказано, что в 6-й версии команда является устаревшей. В предыдущих версиях должна была для выбранного сервера открывать адресную книгу и выводить вид "Пользователи" (Users), если адресных книг несколько выдавалось диалоговое окно для выбора адресной книги. В 6-й версии выводит предупреждающее окно с текстом «Command is not supported.» (команда не поддерживается).
AdminOutgoingMail
Работает только в клиенте администратора.
В документации сказано, что в 6-й версии команда является устаревшей. В предыдущих версиях должна была для выбранного сервера открывать базу данных почтового ящика сервера (Mail.box). В 6-й версии выводит предупреждающее окно с текстом «Command is not supported.» (команда не поддерживается).
AdminRegisterFromFil e
Нельзя применять в формулах диалогового окна.
Используется для регистрации пользователей, в случае если информация о них хранится в текстовом файле.
AdminRegisterServer
Нельзя применять в формулах диалогового окна.
Используется для создания IDфайла для нового сервера.
В документации сказано, что в 6-й версии команда является устаревшей. В предыдущих версиях должна была выдавать диалоговое окно трассировки прохождения почты (Mail Path Tracing). В 6-й версии выводит предупреждающее окно с текстом «Command is not supported.» (команда не поддерживается).
AdminStatisticsConfig
Работает только в клиенте администратора.
В документации сказано, что в 6-й версии команда является устаревшей. В предыдущих версиях должна была для выбранного сервера открывать базу данных статистики работы сервера (Events4.nsf). В 6-й версии выводит предупреждающее окно с текстом «Command is not supported.» (команда не поддерживается).
AdminTraceConnectio n
Нельзя применять в формулах диалогового окна.
Выдает диалоговое окно трассировки соединений (Trace Connections) для серверапосредника.
AgentEdit
Агент должен быть выбран в виде "Агенты" текущей базы данных.
Открывает редактор агентов и загружает в него выбранного агента.
AgentEnableDisable
Без ограничений. Если параметры опущены, то агент должен быть выбран в виде "Агенты" текущей базы данных.
Нельзя применять в формулах диалогового окна. Агент должен быть выбран в виде "Агенты" текущей базы данных. Агент должен быть хотя бы раз выполнен.
Выводит диалоговое окно с журналом работы последнего запуска агента.
AgentRun
Нельзя применять в формулах диалогового окна. Агент должен быть выбран в виде "Агенты" текущей базы данных.
Запускает выбранного агента и затем выводит журнал его работы.
AgentSetServerName
Без ограничений.
Для указанного агента по расписанию, устанавливает на каком сервере он должен выполняться.
AgentTestRun
Нельзя применять в формулах диалогового окна. Агент должен быть выбран в виде "Агенты" текущей базы данных.
Выполняет тестовый запуск выбранного агента и выводит журнал его работы.
AttachmentDetachAll
Нельзя применять в формулах диалогового окна. Текущий документ должен быть открыт на чтение или редактирование, или форма/подформа должны быть открыты в режиме редактирования. Документ должен иметь присоединенные файлы.
Выдает диалоговое окно для сохранения на диске присоединенных файлов (Save Attachments To).
AttachmentLaunch
Нельзя применять в формулах диалогового окна. Текущий документ должен быть открыт на чтение или редактирование, или форма/подформа должны быть открыты в режиме редактирования. Документ должен иметь присоединенные файлы, и один из них должен быть выделен.
Запускает, если это возможно, приложение, в котором было подготовлен выбранный присоединенный файл и выполняет его.
Нельзя применять в формулах диалогового окна. Текущий документ должен быть открыт на чтение или редактирование, или форма/подформа должны быть открыты в режиме редактирования. Документ должен иметь присоединенные файлы, и один из них должен быть выделен.
Выдает свойств файла.
AttachmentView
Нельзя применять в формулах диалогового окна. Текущий документ должен быть открыт на чтение или редактирование, или форма/подформа должны быть открыты в режиме редактирования. Документ должен иметь присоединенные файлы, и один из них должен быть выделен.
Запускает, если это возможно, программу просмотра содержимого присоединенного файла, и отображает в ней содержимое выбранного присоединенного файла. Загрузки приложения, в котором готовился присоединенный файл, не происходит.
CalendarFormat
Вид календарного стиля должен быть открыт.
Меняет формат отображения вида календарного стиля, изменяя число дней или месяцев, одновременно показываемых на экране.
CalendarGoTo
Вид календарного стиля должен быть открыт. При использовании с одним параметром нельзя применять в формулах диалогового окна.
В виде календарного стиля осуществляет переход на день, указанный вторым параметром, или выдает диалоговое окно для определения дня, на который необходимо перейти.
CheckCalendar
Текущая БД должна содержать хотя бы один вид календарного стиля.
Выдает диалоговое окно с видом календарного стиля в формате на один день.
Нельзя применять в формулах диалогового окна. Документ должен быть открыт в режиме редактирования.
Выдает диалоговое окно для выбора папок, в которые необходимо поместить текущий документ.
Clear
Необходимо выполнения одного из условий:
Выполняет команду меню Edit Clear (Правка - Очистить). Аналогична @Command( [EditClear] ) за тем лишь исключением, что выполняется немедленно в формуле, а не после всех остальных команд.
Стр. 247
•
в виде/папке документ(ы) должны быть выделены (помечены или на документе стоит световой маркер) или документ должен находиться в режиме редактирования;
•
документ должен находиться в режиме редактирования, и данные для удаления (текст, присоединенные файлы, объекты и т.д.) должны быть выделены. В этом контексте нельзя использовать команду следом за командой [EditGotoField];
•
элементы дизайна (форма, подформа, вид, папка и т.д.) должны находиться в режиме редактирования и данные для удаления (поля, столбцы и т.д.) должны быть выделены;
•
в рабочем пространстве иконки баз данных должны быть выделены.
Можно использовать в Web-приложениях при условии, что у базы установлено свойство "Allow Javascript on the Web" (использовать Javascript при создании Web-страниц). Не закрывает окно с рабочим пространством.
Закрывает текущее окно LN. В случае если в окне присутствует не сохраненный отредактированный документ или элемент дизайна, выдает диалоговое окно с вопросом о сохранении изменений. Аналогична [FileCloseWindow], но в отличие от нее выполняется немедленно.
Нельзя применять в формулах диалогового окна.
Создает в указанной базе данных новый документ по определенной форме и переключает на него фокус LN.
БД должна быть открыта, на документе, на которой создается ответ, должен стоять световой маркер или документ должен быть открыт в режиме чтения/редактирования.
Создает ответный документ для документа, на котором стоит световой маркер, и переключает фокус Domino на него.
CreateAction
Форма, или подформа, или вид, или папка должны быть открыты в режиме редактирования.
Создает новую кнопку-акцию.
CreateAgent
Нельзя применять в формулах диалогового окна. БД должна быть открыта или выбрана в рабочем пространстве. Пользователь должен иметь доступ к базе данных не ниже дизайнера, или в списке управления доступом ему должно быть разрешено создавать личных агентов.
Создает нового агента в текущей базе данных и загружает агент в рабочую панель и выводит окно свойств агента.
CreateControlledAcce ssSection
Форма или подформа должна быть открыта в режиме редактирования, и текст секции должен быть выделен.
Создает в выбранной форме или подформе секцию с управляемым доступом.
Навигатор должен быть открыт в режиме редактирования.
Создает объект "эллипс" текущем навигаторе.
в
CreateFolder
Нельзя применять в формулах диалогового окна. БД должна быть открыта или выбрана в рабочем пространстве. Пользователь должен иметь доступ к базе данных не ниже дизайнера, или в списке управления доступом ему должно быть разрешено создавать личные папки.
Выдает диалоговое окно для создания новой папки.
CreateForm
Нельзя применять в формулах диалогового окна. БД должна быть открыта или выбрана в рабочем пространстве. Пользователь должен иметь доступ к базе данных не ниже дизайнера.
Создает новую пустую форму в текущей базе данных.
CreateLayoutRegion
Форма или подформа должна быть открыта в режиме редактирования.
Создает новую область размещения в форме или подформе.
CreateNavigator
Нельзя применять в формулах диалогового окна. БД должна быть открыта или выбрана в рабочем пространстве. Пользователь должен иметь доступ к базе данных не ниже дизайнера.
Создает навигатор данных.
CreatePolygon
Навигатор должен быть открыт в режиме редактирования.
Создает "многоугольник" навигаторе.
CreatePolyline
Навигатор должен быть открыт в режиме редактирования.
Создает объект "ломаная линия" в текущем навигаторе.
CreateRectangle
Навигатор должен быть открыт в режиме редактирования.
Навигатор должен быть открыт в режиме редактирования.
Создает "гиперпрямоугольник" текущем навигаторе.
объект в
CreateSection
Документ должен быть открыт в режиме редактирования, или форма/подформа должны быть открыты в режиме редактирования. Текст секции должен быть выделен.
Создает секцию в документе форме/подформе.
текущем или
CreateSubform
Нельзя применять в формулах диалогового окна. БД должна быть открыта или выбрана в рабочем пространстве. Пользователь должен иметь доступ к базе данных не ниже дизайнера.
Создает подформу данных.
CreateTextbox
Навигатор должен быть открыт в режиме редактирования.
Создает объект типа "надпись" в текущем навигаторе.
CreateView
Нельзя применять в формулах диалогового окна. БД должна быть открыта или выбрана в рабочем пространстве. Пользователь должен иметь доступ к базе данных не ниже дизайнера.
Выдает диалоговое окно для создания нового вида.
DatabaseDelete
Иконка БД должна быть выделена, но база не должна быть открыта. Пользователь должен иметь доступ менеджера к текущей БД.
Физически удаляет БД с диска локальной станции или сервера. Если с БД в данный момент кто-то работает, то появится предупреждающее сообщение, что база будет удалена позднее. Выполняется немедленно в отличие от команды [FileDatabaseDelete].
формулах диалогового окна. БД должна быть открыта или выбрана в рабочем пространстве.
параметров текущей БД.
DebugLotusScript
Нельзя применять в формулах диалогового окна.
Включает/выключает отладчик кода LotusScript.
DesignDocumentInfo
Нельзя применять в формулах диалогового окна. На документе в виде или папке должен стоять световой указатель, или документ должен быть открыт на чтение/редактирование.
Выдает окно свойств текущего документа.
DesignFormAttributes
Форма/подформа или страница должны быть открыты в режиме редактирования.
Выдает окно свойств для текущей формы/подформы или страницы.
DesignFormFieldDef
Форма/подформа должны быть открыты в режиме редактирования. Поле должно быть выделено
Выдает окно свойств для выделенного поля текущей формы/подформы.
DesignFormNewField
Форма/подформа должны быть открыты в режиме редактирования. Ни одно поле не должно быть выделено.
Создает новое поле в текущей форме/подформе и выдает для него окно свойств.
DesignForms
Нельзя применять в формулах диалогового окна. БД должна быть открыта или выбрана в рабочем пространстве. Пользователь должен иметь доступ к БД не ниже дизайнера.
Открывает в текущей БД папку дизайнера с имеющимися в БД формами.
DesignFormShareFiel d
Форма/подформа должны быть открыты в режиме редактирования. Поле должно быть выделено.
Делает выделенное поле общим в текущей форме/подформе.
быть открыты в режиме редактирования. Ни одно поле не должно быть выделено.
вставки общего поля (Insert Shared Field) для текущей формы/подформы.
DesignFormWindowTi tle
Форма должна быть открыта в режиме редактирования.
Переходит в Designer в режим определения заголовка окна для текущей формы.
DesignHelpAboutDoc ument
Нельзя применять в формулах диалогового окна. БД должна быть открыта или выбрана в рабочем пространстве. Пользователь должен иметь доступ к БД не ниже дизайнера.
Открывает на редактирование документ о БД для текущей БД.
DesignHelpUsingDocu ment
Нельзя применять в формулах диалогового окна. БД должна быть открыта или выбрана в рабочем пространстве. Пользователь должен иметь доступ к БД не ниже дизайнера.
Открывает на редактирование документ "О работе с БД " для текущей БД.
DesignIcon
Нельзя применять в формулах диалогового окна. БД должна быть открыта или выбрана в рабочем пространстве. Пользователь должен иметь доступ к БД не ниже дизайнера.
Выдает диалоговое окно для редактирования иконки выбранной БД.
DesignMacros
Нельзя применять в формулах диалогового окна. БД должна быть открыта или выбрана в рабочем пространстве.
Открывает в текущей базе данных папку Designer с имеющимися в БД агентами и макросами для БД версий 3.х.
Нельзя применять в формулах диалогового окна. БД должна быть открыта или выбрана в рабочем пространстве. Пользователь должен иметь доступ к БД не ниже дизайнера.
Выдает диалоговое окно для определения сервера с шаблонами баз данных для обновления дизайна текущей БД.
DesignReplace
Нельзя применять в формулах диалогового окна. БД должна быть открыта или выбрана в рабочем пространстве. Пользователь должен иметь доступ к БД не ниже дизайнера.
Выдает диалоговое окно для определения сервера с шаблонами БД для замены дизайна текущей БД.
DesignSharedFields
Нельзя применять в формулах диалогового окна. БД должна быть открыта или выбрана в рабочем пространстве. Пользователь должен иметь доступ к БД не ниже дизайнера.
Открывает в текущей БД папку Designer с имеющимися в БД общими полями.
DesignSynopsis
Нельзя применять в формулах диалогового окна. БД должна быть открыта или выбрана в рабочем пространстве.
Выдает диалоговое окно со сведениями о структуре БД (Design Synopsis).
DesignViewAppendCo lumn
Вид или папка должны находиться в режиме редактирования. Столбец в виде/папку должен быть выбран.
Создает новый столбец, следующий за выбранным в текущем виде/папке.
DesignViewAttributes
Вид или папка находиться в редактирования.
должны режиме
Выдает окно свойств текущего вида/папки.
DesignViewColumnDe f
Вид или папка должны находиться в режиме редактирования. Столбец должен быть выбран.
Переходит в Designer в режим определения формулы формы (Design Form Formula), по которой должны открываться документы в текущем виде/папке.
DesignViewNewColu mn
Вид или папка должны находиться в режиме редактирования. Столбец должен быть выбран.
Создает новый столбец перед выбранным в текущем виде/папке.
DesignViews
Нельзя применять в формулах диалогового окна. БД должна быть открыта или выбрана в рабочем пространстве. Пользователь должен иметь доступ к БД не ниже дизайнера.
Открывает в Designer папку с имеющимися в текущей БД видами.
DesignViewSelectFor mula
Вид должен находиться в режиме редактирования.
Переходит в Designer в режим определения формулы отбора документов в виде.
Нельзя применять в формулах диалогового окна. Должен быть открыт либо документ Server из Domino Directory, либо документ Location из личной адресной книги.
Выдает диалоговое окно установки параметров модемной связи в соответствии с текущим местом вызова.
Directories
Нельзя применять в формулах диалогового окна.
Выдает диалоговое окно поиска адресов (Directories) по всем доступным клиенту адресным книгам, с возможностью переноса нужных записей в личную адресную книгу.
EditBottom
Форма или документ должны находиться в режиме редактирования.
Переводит курсор для документа в последнее редактируемое поле, для формы в конец формы.
EditButton
Документ должен находиться в режиме редактирования. Кнопка должна быть выделена.
Переходит в клиенте Notes в режим определения действий по выделенной кнопке и выдает ее окно свойств.
последней в формуле. Для корректной работы необходимо выполнения одного из условий: •
в виде/папке документ(ы) должны быть выделены (помечены или на документе стоит световой маркер) или документ должен находиться в режиме редактирования;
•
документ должен находиться в режиме редактирования и данные для удаления (текст, присоединенные файлы, объекты и т.д.) должны быть выделены. В этом контексте нельзя использовать команду следом за командой [EditGotoField];
•
элементы дизайна (форма, подформа, вид, папка и т.д.) должны находиться в режиме редактирования и данные для удаления (поля, столбцы и т.д.) должны быть выделены;
Clear (Правка - Очистить).
• в рабочем пространстве иконки БД должны быть выделены. В Webприложениях может использоваться только в акциях формы, для пометки текущего (не выделенных) документа на удаление. EditCopy
332
Необходимо выполнения одного из условий:
Выполняет команду меню Edit Copy (Правка – Копировать).
в виде/папке документ(ы) должны быть выделены (помечены или на документе стоит световой маркер);
•
документ должен находиться в режиме редактирования или чтения, и данные для копирования (текст, присоединенные файлы, объекты и т.д.) должны быть выделены;
•
элементы дизайна (форма, подформа, вид, папка и т.д.) должны находиться в режиме редактирования, и данные для копирования (поля, столбцы и т.д.) должны быть выделены.
Необходимо выполнения одного из условий:
Выполняет команду меню Edit Cut (Правка - Вырезать).
в виде/папке документ(ы) должны быть выделены (помечены или на документе стоит световой маркер);
•
документ должен находиться в режиме редактирования, и данные для копирования в буфер обмена с удалением (текст, присоединенные файлы, объекты и т.д.) должны быть выделены;
•
элементы дизайна (форма, подформа, вид, папка и т.д.) должны находиться в режиме редактирования, и данные для копирования (поля, столбцы и т.д.) должны быть выделены.
Необходимо выполнения одного из условий:
Выполняет команду меню Edit Deslect All (Правка - Снять все
документ должен находиться в режиме редактирования или чтения, и данные для снятия с них отметки выделения (текст, присоединенные файлы, объекты и т.д.) должны быть выделены;
•
элементы дизайна (форма, подформа, вид, папка и т.д.) должны находиться в режиме редактирования, и данные для копирования (поля, столбцы и т.д.) должны быть выделены;
•
в рабочем пространстве иконки БД должны быть выделены.
EditDetach
Документ должен находиться в режиме редактирования или чтения. Без указания параметров присоединенный файл должен быть выделен.
Используется для сохранения на диске присоединенных файлов.
EditDocument
В виде/папке на документе должен стоять световой
Переводит текущий документ в режим редактирования/чтения.
маркер, или документ открыт в режиме чтения/редактирования. Можно использовать в Web-приложениях в акциях формы (но не в акциях видов) без параметров. При использовании данной команды могут не работать формулы видимости объектов в форматируемых полях. Используйте команду @Command( [OpenDocument] ), которая поддерживает работу всех формул видимости объектов.
EditDown
Форма/подформа документ находиться в редактирования.
или должны режиме
Переводит курсор для документа в пределах поля на одну или определенное число строк вниз, если выходим за рамки поля перемещаемся в поле ниже текущего. Для формы/подформы на одну или определенное число строк вниз.
EditEncryptionKeys
Вид/папка должны быть открыты и световой указатель стоит на документе, или документ должен находится в режиме редактирования или чтения.
Выдает диалоговое окно свойств текущего документа, сразу переходя на закладку Security (безопасность). Здесь можно назначить ключи шифрования для текущего документа.
EditFind
Вид/папка должны быть открыты, или документ должен находиться в режиме чтения/редактирования.
Выполняет команду Edit Find/Replace (Правка Найти/Заменить).
открыты, или документ должен находиться в режиме просмотра.
предварительного просмотра выполняет команду Edit – Find/Replace (Правка – Найти/Заменить) без перехода фокуса в панель предварительного просмотра документа. Если панель предварительного просмотра закрыта, действие аналогично команде @Command( [EditFind] ).
EditFindNext
Вид/папка должны быть открыты, или документ должен находиться в режиме чтения/редактирования.
Выполняет команду Edit – Find Next (Правка - Найти далее). Оперирует с результатами полнотекстового поиска, если он был произведен, и фокус находится либо в виде на отобранном документе, либо в отобранном документе на найденном слове/фразе. В противном случае выдает диалоговое окно обычного поиска.
EditGotoField
Документ находиться в редактирования.
должен режиме
Перемещает курсор в указанное поле текущего документа.
EditHeaderFooter
Форма/подформа должны находиться в режиме редактирования, или документ должен быть выбран в виде/папке, или находиться в режиме чтения.
Выдает окно свойств текущего документа или формы/подформы для изменения параметров печати.
EditHorizScrollbar
Документ должен быть открыт. Команда не поддерживается на платформах OS/2 и Macintosh.
Отображает горизонтальную линейку "прокрутки" для текущего документа.
Форма/подформа должны находиться в режиме редактирования, или документ должен находиться в режиме редактирования. Курсор должен быть для документа в форматируемом поле, для формы/подформы в бланке формы (но не в формулах и т.д.).
Для текущего и всех абзацев ниже текущего увеличивает отступ от левого края на 1/4 дюйма.
EditIndentFirstLine
Форма/подформа должны находиться в режиме редактирования, или документ должен находиться в режиме редактирования. Курсор должен быть для документа в форматируемом поле, для формы/подформы в бланке формы (но не в формулах и т.д.).
Для текущего и всех абзацев ниже текущего увеличивает отступ от левого края на 1/4 дюйма первой строки абзаца ("красная строка").
EditInsertButton
Форма/подформа должны находиться в режиме редактирования и ничего не должно быть выделено, или документ должен находиться в режиме редактирования. Курсор должен быть для документа в форматируемом поле, для формы/подформы в бланке формы (но не в формулах и т.д.).
Создает новую кнопку в документе или форме/подформе и выдает окно свойств кнопки.
EditInsertFileAttachme nt
Документ должен находиться в режиме редактирования. Курсор должен быть в форматируемом поле.
Форма/подформа должны находиться в режиме редактирования, или документ должен находиться в режиме редактирования. Курсор должен быть для документа в форматируемом поле, для формы/подформы в бланке формы (но не в формулах и т.д.). Команда не поддерживается на платформах OS/2, UNIX и Macintosh.
Используется для встраивания в документ или форму/подформу OLEобъектов.
EditInsertPageBreak
Форма/подформа или страница должны находиться в режиме редактирования, или документ должен находиться в режиме редактирования. Курсор должен быть для документа в форматируемом поле, для формы/подформы в бланке формы (но не в формулах и т.д.).
Добавляет/удаляет в документе, форме/подформе, или странице символ перевода страницы.
EditInsertPopup
Форма/подформа или страница должны находиться в режиме редактирования, или документ должен находиться в режиме редактирования. Текст для документа в форматируемом поле, для формы/подформы в бланке формы должен быть выделен.
Создает гиперобъект типа текстового "всплывающего" окна.
Форма/подформа или страница должны находиться в режиме редактирования, или документ должен находиться в режиме редактирования. Курсор должен быть для документа в форматируемом поле, для формы/подформы в бланке формы (но не в формулах и т.д.).
Выдает диалоговое окно создания объекта таблицы.
EditIsertText
Форма/подформа или страница должны находиться в режиме редактирования, или документ должен находиться в режиме редактирования. Курсор должен быть для документа в поле, для формы/подформы в бланке формы (но не в формулах и т.д.).
Вставляет указанную текстовую строку с текущего положения курсора.
EditLeft
Форма/подформа, страница, или документ должны находиться в режиме редактирования.
Переводит курсор для документа в пределах поля на один или определенное число символов влево, если выходим за рамки поля перемещаемся в поле левее текущего. Для формы/подформы или страницы на одну или определенное число символов левее.
EditLinks
Форма/подформа или документ должны находиться в режиме редактирования и иметь одну или более OLE или DDE-связей.
Выдает диалоговое внешних связей.
EditLocations
Нельзя применять в формулах диалогового окна.
Открывает личную адресную книгу по виду "Место вызова" (Location).
На документе в виде/папке должен стоять световой указатель или документ должен находиться в режиме редактирование/чтение.
Создает ссылку на текущий документ и помещает ее в буфер обмена. Пользователь может затем вставить эту ссылку в любое форматируемое поле.
EditNextField
Документ находиться в редактирования.
должен режиме
Перемещает указатель курсора в следующее редактируемое поле. Перемещаясь слева направо, сверху вниз, независимо от порядка обхода полей определенных в форме.
EditOpenLink
Документ должен находиться в режиме редактирования/чтения. Ссылка должна быть выделена, и указывать на объекты Domino (не OLE, или DDE).
Открывает объекты, на которые указывает выбранная ссылка.
EditPaste
Вид/папка должны быть открыты, или документ должен находиться в режиме редактирования, или элементы дизайна (форма, подформа, вид и т.д.) должны находиться в режиме редактирования. Информация в буфере обмена должна соответствовать типу приемника. В случае если в буфере обмена находится информация из форматируемого поля, а вставка осуществляется в текстовое поле, часть информации может быть утеряна.
Выполняет команду Edit - Paste (Правка - Вставить).
Документ должен находиться в режиме редактирования и курсор должен быть в пределах форматируемого поля, или форма/подформа должны находиться режиме редактирования.
Выдает диалоговое специальной вставки Special).
EditPhoneNumbers
Нельзя применять в формулах диалогового окна.
Открывает личную адресную книгу по виду "Дополнительно\Подключения" (Advanced\Connections).
EditPrevField
Документ находиться в редактирования.
должен режиме
Перемещает указатель курсора в предыдущее редактируемое поле. Перемещение осуществляется справа налево, снизу вверх, независимо от порядка обхода полей определенных в форме.
EditProfile
В R 6 всегда выполняется последней в формуле. Нельзя применять в формулах диалогового окна. Для создания профильного документа нужен доступ к БД не ниже автора.
Открывает на редактирование новый или существующий профильный документ.
Нельзя применять в формулах диалогового окна. Для создания профильного документа нужен доступ к БД не ниже автора.
Создает новый или открывает существующий профильный документ на редактирование. Аналогична @Command( [EditProfile] ) за тем лишь исключением, что выполняется немедленно в формуле, а не после всех остальных команд.
Документ должен быть открыт в режиме редактирования, и текст должен быть выделен.
Преобразует выделенный текст к формату принятому в письмах ответах с использованием цитирования. Другими словами, вставляет в начало каждой строки символ больше (“>”), форматирует текст в строках по 70 символов, и удаляет из текста присоединенные файлы и другие объекты.
EditResizePicture
Документ должен находиться в режиме редактирования и рисунок должен быть выделен.
Используется для изменения размеров вставленного в форматируемое поле рисунка.
EditRestoreDocume nt
На документе стоит световой маркер или документы выделены в рамках вида, отображающего «мягко» удаленные документы, или документ находится в режиме чтения.
Выполняет команду меню Edit -> Restore. Другими словами восстанавливает «мягко» удаленные документы.
EditRight
Форма/подформа документ находиться в редактирования.
или должны режиме
Переводит курсор для документа в пределах поля на один или определенное число символов вправо, если выходим за рамки поля перемещаемся в поле правее текущего. Для формы/подформы на одну или определенное число символов правее.
EditSelectAll
Документ должен находиться в режиме чтения/редактирования, или вид/папка должны быть открыты, или в текущем окне отображается лист рабочего пространства, или форма/подформа находятся в режиме редактирования.
Выполняет команду Edit - Select All (Правка - Выделить все).
Документ форма/подформа находиться в редактирования.
или должны режиме
Отображает/скрывает отображение скрытых символов (табуляция, пробел, возврат каретки). Для документа показывает скрытые символы только в форматируемых полях.
EditTableDeleteRowC olumn
Документ или форма/подформа/страница должны находиться в режиме редактирования. Указатель курсора должен находиться в пределах таблицы.
Выдает диалоговое окно удаление строк/столбцов в текущей таблице.
EditTableFormat
Документ или форма/подформа/страница должны находиться в режиме редактирования. Указатель курсора должен находиться в пределах таблицы.
Выдает окно свойств таблицы.
EditTableInsertRowCo lumn
Документ или форма/подформа/страница должны находиться в режиме редактирования. Указатель курсора должен находиться в пределах таблицы.
Выдает диалоговое окно вставки строк/столбцов в текущей таблице.
EditTop
Форма или документ должны находиться в режиме редактирования.
Переводит курсор для документа в первое редактируемое поле, для формы в начало формы.
EditUndo
Нельзя применять в формулах диалогового окна.
Выполняет команду Edit - Undo (Правка - Отменить). Для формул акции и кнопок работает только при открытом в текущем окне виде/папке, снимая при этом отметку об удалении документа.
версию усеченного документа из базы, которая участвовала в репликации с параметрами усечения больших документов.
EditUp
Форма/подформа документ находиться в редактирования.
или должны режиме
Переводит курсор для документа в пределах поля на одну или определенное число строк вверх, если выходим за рамки поля перемещаемся в поле выше текущего. Для формы/подформы на одну или определенное число строк вверх.
EmptyTrash
Без ограничений.
Удаляет документы из предопределенной папки ($Trash) и обновляет индекс вида.
ExchangeUnreadMark s
В текущем окне должны быть помечены две иконки реплик одной базы. Иконки не должны быть наложены друг на друга.
Помечает как прочтенные документы в одной реплике, если они помечены как прочтенные в другой реплике.
Execute
Нельзя применять в формулах диалогового окна. Параметры должны соответствовать формату операционной системы.
Запускает внешнее приложение операционной системы.
Стр. 264
Нельзя применять в формулах диалогового окна.
Выполняет команду File - Exit (Файл - Выход из Notes). Аналогична @Command( [FileExit] ) за тем лишь исключением, что выполняется немедленно в формуле, а не после всех остальных команд.
Web-приложениях при условии, что у базы установлено свойство "Allow Javascript on the Web" (использовать Javascript при создании Web-страниц). Не закрывает окно с рабочим пространством. Всегда выполняется последней в формуле.
случае если в окне присутствует не сохраненный отредактированный документ или элемент дизайна, выдает диалоговое окно с вопросом о сохранении изменений.
FileDatabaseACL
БД должна быть открыта или ее иконка должна быть выделена в рабочем пространстве. Пользователь должен иметь уровень доступа к базе выше, чем "Нет доступа" для чтения информации, и менеджера для изменения.
Выдает диалоговое окно со списком управления доступом (ACL) к текущей БД.
FileDatabaseCompact
БД должна быть открыта или ее иконка выделена в рабочем пространстве. Пользователь должен иметь уровень доступа Менеджера к БД.
Вызывает процесс сжатия неиспользованного пространства в БД, и одновременно, если дизайн БД подготовлен в старых версиях LN, конвертирует его в текущую версию.
FileDatebaseCopy
БД должна быть открыта или ее иконка должна быть выделена в рабочем пространстве. Пользователь должен иметь уровень доступа к базе не ниже читателя и иметь привилегию "Replicate or copy documents" (реплицировать или копировать документы).
Выдает диалоговое окно создания новой копии текущей БД.
Иконка БД должна быть выделена в рабочем пространстве, но сама база не должна быть открыта. Пользователь должен иметь уровень доступа Менеджера к базе. Всегда выполняется последней в формуле.
Физически удаляет файл текущей БД с диска. Если с БД в данный момент кто-то работает, то появится предупреждающее сообщение, что база будет удалена позднее.
FileDatabaseInfo
БД должна быть открыта или ее иконка должна быть выделена в рабочем пространстве. Пользователь должен иметь уровень доступа к БД Депозитор или выше.
Выдает окно свойств текущей БД.
FileDatabaseRemove
Иконки БД должны быть выделены в рабочем пространстве, но сами базы не должны быть открыты.
Удаляет иконки выделенных БД с рабочего пространства. Если базы открыты, то появится предупреждающее сообщение, что иконка базы будет удалена позднее.
FileDatabaseUseServ er
Иконка БД должна быть выделена в рабочем пространстве.
Согласно документации должна выдавать диалоговое окно выбора сервера (Switch Server) для переключения на другую реплику текущей БД. Из личного опыта в R 6.0.1 команда не работает.
FileExit
Нельзя применять в формулах диалогового окна. Всегда выполняется последней в формуле.
Выполняет команду File - Exit (Файл - Выход из Notes). В случае если в каком-либо окне присутствует не сохраненный отредактированный документ или элемент дизайна, выдает диалоговое окно с вопросом о сохранении изменений.
Документ должен быть открыт в режиме чтения/редактирования, или вид/папка должны быть открыты в текущем окне.
Используется для экспорта содержимого документа или вида/папки в файлы приложений не LN.
БД должна быть открыта или ее иконка должна быть выделена в рабочем пространстве. Пользователь должен иметь уровень доступа к БД Дизайнера или выше.
Выдает диалоговое окно создания полнотекстового индекса для текущей БД.
FileFullTextDelete
БД должна быть открыта или ее иконка должна быть выделена в рабочем пространстве. Пользователь должен иметь уровень доступа к БД Дизайнера или выше. У базы должен быть полнотекстовый индекс.
Удаляет у текущей полнотекстовый индекс.
FileFullTextInfo
БД должна быть открыта или ее иконка должна быть выделена в рабочем пространстве. Пользователь должен иметь уровень доступа к БД Депозитора или выше.
Выдает окно свойств текущей БД, отображая сразу закладку с информацией о полнотекстовом индексе.
FileFullTextUpdate
БД должна быть открыта или ее иконка должна быть выделена в рабочем пространстве. Пользователь должен иметь уровень доступа к БД Дизайнера или выше.
Используется для обновления полнотекстового индекса текущей БД.
FileImport
Документ должен быть открыт в режиме редактирования и курсор должен находиться в форматируемом поле, или вид/папка должны быть открыты в текущем окне.
Используется для импорта содержимого файла приложений не LN в документ или вид/папку LN.
создания новой реплики текущей БД. Если в текущем окне БД не открыта и не выбрана, то сначала выдается диалоговое окно для выбора текущей БД. FileOpenDatabase
Нельзя применять в формулах диалогового окна. Можно использовать в Web-приложениях при условии, что параметр "сервер" есть пустая строка, и если используется синтаксис с третьим параметром "вид", то следующей командой в формуле обязательно должна быть [OpenDocument].
Открывает указанную БД с использованием заданного вида или навигатора.
Нельзя применять в формулах диалогового окна. В Web-приложениях не работает.
Открывает БД, указанную ее идентификатором реплики, с использованием заданного вида или навигатора.
FilePageSetup
БД должна быть открыта или ее иконка должна быть выделена в рабочем пространстве.
Выдает диалоговое окно параметров страницы для печати (Page Setup), или для OS Macintosh диалоговое окно File Print Margin.
FilePrint
Вид/папка должны быть открыты, или документ должен находиться в режиме чтения/редактирования.
Печатает текущий/выбранные документы или содержимое вида/папки целиком.
Без ограничений. Команда не поддерживается на платформе Macintosh.
Документ или элементы дизайна (форма/подформа, вид/папка, навигатор и т.д.) должны находиться в режиме редактирования. Можно использовать в Web-приложениях при условии, что у БД установлено свойство "Web access: Use JavaScript when generating pages" (использовать Javascript при создании Web-страниц)
Выполняет команду File - Save (Файл - Сохранить).
FileSaveNewVersion
Документ должен находиться в режиме редактирования. В форме, по которой редактируется документ, должна быть включена поддержка версии.
Сохраняет редактируемый документ как новую версию.
FindFreeTimeDialog
Документ должен находиться в режиме редактирования. Все параметры должны быть заданы (необязательные могут быть пустой строкой). Время собрания не должно приходиться на полночь.
Выдает диалоговое окно поиска свободного времени для собрания (Free Time).
Folder
Документ должен быть открыт, либо документы выделены в виде. Документ(ы) должен быть уже сохранен(ы) на диске ( не новый документ). В R 6 всегда выполняется последней в формуле.
Копирует, или копирует с удалением документ(ы) в папку.
Вид/папка должны быть открыты, и указатель курсора должен находиться в области навигации.
"Cвертывает" в области навигации выделенную категорию вида/папки, содержащие вложенные документы или категории.
Замечание по поводу использования команд [FolderCollapse], [FolderExpand], [FolderExpandAll], [FolderExpandWithChildren]. Один из вариантов как добиться контекста, чтобы на момент выполнения курсор находился в области навигации. Перечисленные команды используются в формулах кнопок панели инструментов, курсор устанавливаем на нужную папку/вид и нажимаем правую кнопку мыши (при этом число пунктов основного меню должно значительно уменьшиться), затем «кликаем» по кнопке панели инструментов. FolderCustomize
Вид/папка открыты.
быть
Переводит дизайн вида/папки в режим редактирования.
FolderDocuments
Документ должен быть открыт, либо документы выделены в виде. Документ(ы) должен быть уже сохранен(ы) на диске ( не новый документ).
Копирует, или копирует с удаление документ(ы) в папку. Аналогична [Folder] за тем лишь исключением, что выполняется немедленно в формуле, а не после всех остальных команд.
FolderExpand
Вид/папка должны быть открыты, и указатель курсора должен находиться в области навигации.
"Раскрывает" в области навигации выделенную категорию вида/папки, содержащие вложенные документы или категории на один уровень вниз.
FolderExpandAll
Вид/папка должны быть открыты, и указатель курсора должен находиться в области навигации.
"Раскрывает" в области навигации все категории всех видов/папок, содержащих вложенные виды/папки.
FolderExpandWithChil dren
Вид/папка должны быть открыты, и указатель курсора должен находиться в области навигации.
"Раскрывает" в области навигации на все уровни выделенную категорию вида/папки, содержащие вложенные виды/папки.
FolderMove
Вид/папка открыты.
Выдает диалоговое окно для перемещения текущего вида/папки в другой вид/папку.
Вид/папка должны быть открыты в режиме редактирования. Указатель курсора должен находиться в области навигации.
Согласно документации, выдает окно свойств текущего вида/папки. Автору не удалось добиться от команды данного результата. Применение команды вызывало сообщение об ошибке.
FolderRename
Вид/папка должны быть открыты в клиенте Notes.
Выдает диалоговое окно для переименования текущего вида/папки.
FormActions
Форма/подформа или страница должны быть открыты в режиме редактирования.
Открывает/скрывает в Designer панель акций.
FormTestDocument
Форма или страница должны быть открыты в режиме редактирования. Для подформ не работает.
Создает по текущей форме документ или открывает страницу. Можно использовать для проверки формул полей, скриптов и т.д.
GoUpLevel
Документ должен быть открыт на чтение/редактирование.
Выводит вид, в котором текущий документ отображается. Может быть использована для открытия вида, в котором хранится ссылка на документ (DocLink), перед закрытием документассылки.
HelpAboutDatabase Стр. 262
БД должна быть открыта или ее иконка должна быть выделена в рабочем пространстве.
Открывает документ "О БД" для текущей БД.
HelpAboutNotes
Без ограничений.
Выводит модальное окно с информацией о текущей версии и релизе LN.
HelpUsingDatabase
БД должна быть открыта или ее иконка должна быть выделена в рабочем пространстве.
Документ или форма/подформа/страница должны находиться в режиме редактирования. Указатель курсора должен находиться в пределах гиперобъекта. Работает только для гиперобъектов, созданных с помощью команд пункта меню Create – HotSpot (Создание – Гиперобъект) за исключением Button (кнопок).
Удаляет гиперобъект, не удаляя сам объект (картинка, текст и т.д.)
HotSpotProperties
Документ или форма/подформа/страница должны находиться в режиме редактирования. Указатель курсора должен находиться в пределах гиперобъекта. Работает только для гиперобъектов, созданных с помощью команд пункта меню Create – HotSpot (Создание – Гиперобъект) за исключением Button (кнопок).
Выдает окно гиперобъекта.
InsertSubform
Форма должны находиться в режиме редактирования. Указатель курсора должен находиться в пределах бланка формы.
Выдает вставки Subform).
LayoutAddGraphic
Форма/подформа должны находиться в режиме редактирования. Указатель курсора должен находиться в пределах области размещения. В буфере обмена должно находиться вставляемое изображение.
Вставляет графическое изображение из буфера обмена в область размещения.
Форма/подформа должны находиться в режиме редактирования. Указатель курсора должен находиться в пределах области размещения.
Создает пустой ярлык (статичный текст) в области размещения.
LayoutElementBringT oFront
Форма/подформа должны находиться в режиме редактирования. Объект области размещения должен быть выделен.
Переносит выделенный объект области размещения на передний план. Т.е. он будет отображаться поверх других объектов, если они есть.
LayoutElementPropert ies
Форма/подформа должны находиться в режиме редактирования. Объект области размещения должен быть выделен.
Выдает окно свойств для выделенного объекта области размещения.
LayoutElementSendT oBack
Форма/подформа должны находиться в режиме редактирования. Объект области размещения должен быть выделен.
Переносит выделенный объект области размещения на задний план. Т.е. он будет отображаться под другими объектами, если они есть.
LayoutProperties
Форма/подформа должны находиться в режиме редактирования. Область размещения или ее объект должны быть выделены.
Выдает окно свойств области размещения.
MailAddress
Документ должен находиться в режиме редактирования. Указатель курсора должен находиться в пределах редактируемого поля. В документе должно быть хотя бы одно поле, используемое для адресации (SendTo, CopyTo, BlindCopyTo).
Выдает диалоговое окно определения почтового адреса (Mail Address). Пользователь может выбрать адресата и при нажатии Ok выбранная информация занесется в соответствующие адресные поля документа.
Нельзя применять в формулах диалогового окна.
Создает в почтовом ящике пользователя пустое почтовое сообщение по форме, используемой по умолчанию для почтовой базы (обычно Memo), и устанавливает фокус на него.
На документе в виде/папке должен стоять световой указатель или он должен быть выделен, или документ должен находиться в режиме редактирование/чтение.
Создает новое почтовое сообщение и помещает в него содержимое выбранных документов.
MailForwardAsAttach ment
Работает при установленной почтовой системе cc:Mail. На документе в виде/папке должен стоять световой указатель, или документ должен находиться в режиме редактирование/чтение.
Пересылает текущий документ, как cc:Mail присоединенный файл.
MailOpen
Без ограничений.
Выводит представление или навигатор почтовой базы пользователя, открывавшиеся последними в этой базе.
MailReqestCrossCert
Нельзя применять в формулах диалогового окна.
Используется для создания и отправки по почте защищенной копии ID-файла сертификатора.
MailReqestNewName
Нельзя применять в формулах диалогового окна.
Используется для создания пользователем запроса на изменение имени и отправки по почте этого запроса.
MailReqestNewPublic Key
Нельзя применять в формулах диалогового окна. ID-файл пользователя должен быть заверен иерархическим сертификатом.
Используется для создания пользователем запроса на изменение открытого ключа (Public Key) и отправки по почте этого запроса.
MaiScanUnread
Нельзя применять в формулах диалогового окна.
Проверяет почтовую базу пользователя на наличие не прочтенной почты. Если таковая имеется, открывает первый непрочтенный документ.
На документе в виде/папке должен стоять световой указатель или он должен быть выделен, или документ должен находиться в режиме редактирование/чтение. В документе должно быть поле, используемое для адресации (SendTo). Не работает в Webприложениях.
Используется для отправки по почте текущего или выбранных документов.
MailSendCertificateRe quest
Нельзя применять в формулах диалогового окна.
Используется для создания и отправки по почте защищенной копии ID-файла пользователя.
MailSendEncryptionK ey
Нельзя применять в формулах диалогового окна.
Используется для отправки по почте пользовательских ключей шифрования.
MailSendPublicKey
Нельзя применять в формулах диалогового окна.
Используется для отправки по почте открытого ключа (Public Key) пользователя.
Навигатор должен быть открыт в режиме редактирования, графическое изображение должно находиться в буфере обмена.OpenNavig atorНеобходимо, чтобы к почтовой базе, или к календарному виду был доступ у текущего пользователя,
Открывает определенную страницу текущей БД.БД должна быть открыта или ее иконка должна быть выделена в рабочем пространстве. Можно использовать в Web-приложениях при опущенном третьем параметре.Предназначе на для использования в акциях формы и видов. Можно использовать в Webприложениях.Открывает
Вставляет графическое изображение из буфера обмена в виде фонового изображения на задний план навигатора.Открывает определенный набор фреймов текущей БД.По действию аналогична команде [EditClear]. Помечает к удалению текущий (выделенные) документы.
либо через ACL, либо через профиль делегирования.Отк рывает OLEобъект для редактирования.Ви д/папка должны быть открыты, или документ должен находиться в режиме чтения/редактиров ания. В Webприложениях не работает.В виде/папке осуществляет навигацию на предыдущий непрочтенный в виде/папке документ для текущего. Работает снизу вверх, по кругу. Аналогична [NavigatePrevUnrea d] за тем лишь исключением, что выполняется немедленно в формуле, а не после всех остальных команд.NavPrevMai nВид/папка должны быть открыты, или документ должен находиться в режиме чтения/редактиров ания. В Webприложениях может использоваться
календарный вид почтовой базы указанного или выбираемого пользователя.Форма/под форма/страница должны находиться в режиме редактирования, или документ должен находиться в режиме редактирования. OLEобъект должен быть выделен. Команда не поддерживается на платформах OS/2, UNIX и Macintosh.ObjectDisplayA sNavPrevUnreadВид/папк а должны быть открыты, или документ должен находиться в режиме чтения/редактирования. В Web-приложениях не работает.Вид/папка должны быть открыты, или документ должен находиться в режиме чтения/редактирования. В Web-приложениях может использоваться только в акциях формы.Работает в акциях видов и формы В Web-приложениях работает только в акциях видов, у которых установлено либо свойство Use applet in the browser (использовать апплет при отображении вида в Web), либо Allow selection of documents (разрешить выделение документов) в этом контексте помечает документ к удалению, но
только в акциях формы.В виде/папке осуществляет навигацию на предыдущий главный в дереве ответов документ по отношению к текущему. Аналогична [NavigatePrevMain] за тем лишь исключением, что выполняется немедленно в формуле, а не после всех остальных команд.Вид/папка должны быть открыты, или документ должен находиться в режиме чтения/редактиров ания. В Webприложениях не работает.NavNextS electedВид/папка должны быть открыты, или документ должен находиться в режиме чтения/редактиров ания. В Webприложениях не работает.В виде/папке осуществляет навигацию на следующий выбранный в виде/папке
документ для текущего. Работает сверху вниз, по кругу. Аналогична [NavigateNextSelect ed] за тем лишь исключением, что выполняется немедленно в формуле, а не после всех остальных команд.В виде/папке осуществляет навигацию на следующий документ. Аналогична [NavigateNext] за тем лишь исключением, что выполняется немедленно в формуле, а не после всех остальных команд.NavNextMai nВид/папка должны быть открыты, или документ должен находиться в режиме чтения/редактиров ания. В Webприложениях может использоваться только в акциях формы.В виде/папке осуществляет навигацию на следующий главный в дереве
ответов документ по отношению к текущему. Аналогична [NavigateNextMain] за тем лишь исключением, что выполняется немедленно в формуле, а не после всех остальных команд.NavNextВи д/папка должны быть открыты, или документ должен находиться в режиме чтения/редактиров ания. В Webприложениях может использоваться только в акциях формы.В виде/папке осуществляет навигацию на предыдущий главный в дереве ответов документ по отношению к текущему.Navigate PrevSelectedВид/па пка должны быть открыты, или документ должен находиться в режиме чтения/редактиров ания. Всегда выполняется последней в формуле. В Webприложениях не
работает.В виде/папке осуществляет навигацию на предыдущий выбранный в виде/папке документ для текущего. Работает снизу вверх, по кругу.NavigatePrev UnreadВид/папка должны быть открыты, или документ должен находиться в режиме чтения/редактиров ания. Всегда выполняется последней в формуле. В Webприложениях не работает.В виде/папке осуществляет навигацию на предыдущий непрочтенный в виде/папке документ для текущего. Работает снизу вверх, по кругу.NavigateToBa ckLinkДокумент должен находиться в режиме чтения/редактиров ания. В Webприложениях не работает.Возвращ ает фокус на документ, из которого по ссылке был открыт
текущий документ. Текущий документ и база, его содержащая, при этом закрываются.Navig atorPropertiesНавиг атор должен находиться в режиме редактирования.В ыдает окно свойств для навигатора.Navigat orTestНавигатор должен находиться в режиме редактирования.За пускает навигатор в тестовом режиме для проверки работы его компонент. Повторный вызов команды возвращает навигатор в режим редактирования.Пе реходит в документе к предыдущему значению, удовлетворяющем у результатам поиска. Работает справа налево, снизу вверх.NavigatePrev MainВид/папка должны быть открыты, или документ должен находиться в режиме чтения/редактиров
ания. Всегда выполняется последней в формуле. В Webприложениях может использоваться только в акциях формы.В виде/папке осуществляет навигацию на предыдущий документ.Navigate PrevHighlightДокум ент должен находиться в режиме чтения/редактиров ания. Поиск с использованием полнотекстового индекса должен быть выполнен. В Web-приложениях не работает.В виде/папке осуществляет навигацию на следующий непрочтенный в виде/папке документ для текущего. Работает сверху вниз, по кругу.NavigatePrev Вид/папка должны быть открыты, или документ должен находиться в режиме чтения/редактиров ания. Всегда выполняется последней в формуле. В Web-
приложениях может использоваться только в акциях формы.В виде/папке осуществляет навигацию на следующий выбранный в виде/папке документ по отношению к текущему. Работает сверху вниз, по кругу.NavigateNext UnreadВид/папка должны быть открыты, или документ должен находиться в режиме чтения/редактиров ания. Всегда выполняется последней в формуле. В Webприложениях не работает.В виде/папке осуществляет навигацию на следующий главный в дереве ответов документ по отношению к текущему.Navigate NextSelectedВид/па пка должны быть открыты, или документ должен находиться в режиме чтения/редактиров
ания. Всегда выполняется последней в формуле. В Webприложениях не работает.Переходи т в документе к следующему значению, удовлетворяющем у результатам поиска. Работает слева направо, сверху вниз.NavigateNext MainВид/папка должны быть открыты, или документ должен находиться в режиме чтения/редактиров ания. Всегда выполняется последней в формуле. В Webприложениях может использоваться только в акциях формы.В виде/папке осуществляет навигацию на следующий документ.Navigate NextHighlightДокум ент должен находиться в режиме чтения/редактиров ания. Поиск с использованием полнотекстового индекса должен быть выполнен. В Web-приложениях
не работает.Navigate NextВид/папка должны быть открыты, или документ должен находиться в режиме чтения/редактиров ания. Всегда выполняется последней в формуле. В Webприложениях может использоваться только в акциях формы.MoveToTra sh Стр. 261
Стр. 247 PasteBitmapAsObject Открывает вид/папку для текущей базы данных.PasteBitmapA sBackgroundБаза данных должна быть открыта или ее иконка должна быть выделена в рабочем пространстве. Можно использовать в Webприложениях.OpenVi ewБД должна быть открыта или ее иконка должна быть выделена в рабочем пространстве. Предназначена для использования в акциях формы и видов. Можно использовать в Webприложениях.Открыв ает указанный навигатор в текущей БД.OpenPageСправо чная БД должна быть одна на сервер или в локальной директории. Первый столбец указанного вида должен быть сортировочным. Можно использовать в Web-приложениях в формулах кнопок.Открывает определенный вид, указанной справочной БД, и
Навигатор должен быть открыт в режиме редактирования, графическое изображение должно находиться в буфере обмена.
Вставляет графическое изображение из буфера обмена как гиперобъект навигатора.
становится на нужный документ.OpenHelpD ocumentВид/папка БД должны быть открыты в текущем окне. В открытом виде/папке должен присутствовать открываемый документ.Открывает документ на чтение/редактирован ие по его универсальному идентификатору.Ope nFramesetOpenDocu mentВыдает окно свойств для OLEобъекта.OpenCalenda rObjectPropertiesObje ctOpenФорма/подфор ма/страница должны находиться в режиме редактирования, или документ должен находиться в режиме редактирования. OLE-объект должен быть выделен. Команда не поддерживается на платформах OS/2, UNIX и Macintosh.Форма/под форма/страница должны находиться в режиме редактирования, или документ должен находиться в режиме редактирования (для некоторых OLEобъектов достаточно режима чтения). OLEобъект должен быть выделен. Команда не
поддерживается на платформах OS/2, UNIX и Macintosh.Выдает окно свойств OLEобъекта.В виде/папке осуществляет навигацию на предыдущий выбранный в виде/папке документ для текущего. Работает снизу вверх, по кругу. Аналогична [NavigatePrevSelected ] за тем лишь исключением, что выполняется немедленно в формуле, а не после всех остальных команд.NavPrevSelect edВ виде/папке осуществляет навигацию на предыдущий документ. Аналогична [NavigatePrev] за тем лишь исключением, что выполняется немедленно в формуле, а не после всех остальных команд.NavPrevВ виде/папке осуществляет навигацию на следующий непрочтенный в виде/папке документ для текущего. Работает сверху вниз, по кругу. Аналогична [NavigateNextUnread] за тем лишь
исключением, что выполняется немедленно в формуле, а не после всех остальных команд.NavNextUnrea d
Стр. 260
Стр. 261 Стр. 262 Стр. 261 Стр. 258
PictureProperties
Документ или элемент дизайна должны быть открыты на редактирование, графическое изображение должно быть выбрано.
Выдает окно свойств графического изображения.
PublishDatabase
БД должна быть открыта или ее иконка должна быть выделена в рабочем пространстве, причем только одна. В рабочем пространстве должна присутствовать как минимум одна библиотечная БД.
Выдает диалоговое окно размещение информации о текущей БД в библиотечной БД.
Работает в формулах акций форм и видов и гиперобъектах. Может использоваться в Webприложениях.
"Перезагружает" или обновляет содержимое указанного фрейма.
Вид/папка должны быть открыты, или документ должен находиться в режиме чтения/редактирования.
Пересчитывает только формулы видимости объектов в документе или виде.
Работает формулах окна.
только в диалогового
Передает изменения из одноименных полей диалогового окна в основной документ.
Работает в формулах акций форм и кнопок. В акциях видов для клиента Notes команда работает только в случае, если вид входит в набор фреймов. Может использоваться в Webприложениях.
"Перезагружает" или обновляет содержимое текущего окна LN. Для набора фреймов обновляет содержимое всех входящих в него фреймов. Аналогична [ReloadWindow] за тем лишь исключением, что выполняется немедленно в формуле, а не после всех остальных команд.
Работает в формулах акций форм и кнопок. В акциях видов для клиента Notes команда работает только в случае, если вид входит в набор фреймов. В R 6 всегда выполняется последней в формуле. Может использоваться в Web-приложениях.
"Перезагружает" или обновляет содержимое текущего окна LN. Для набора фреймов обновляет содержимое всех входящих в него фреймов.
Работает только при открытой странице удаленного отладчика (File -> Tools – Remote
Выдает диалоговое окно для определения местоположения удаленно отлаживаемого агента.
В папке документ(ы) должны быть выделены (помечены или на документе стоит световой маркер) или документ должен находиться в режиме чтения/редактирования.
Удаляет текущий документ(ы) из текущей папки.
RenameDatabase
Иконка БД должна находиться в рабочем пространстве. БД не должна быть открыта.
Для указанной БД переключает ее иконку на реплику этой базы на другом сервере.
Replicator
Нельзя применять в формулах диалогового окна.
Отображает "Репликатор" пространства.
ReplicatorReplicateHi gh
Нельзя применять в формулах диалогового окна.
Начинает процесс репликации для баз с высоким приоритетом в параметрах репликации.
ReplicatorReplicateNe xt
Процесс реплицирования должен идти.
Заканчивает реплицирование текущей БД и переходит к реплицированию следующей базы согласно установкам. Может привести к частичной репликации текущей базы.
ReplicatorReplicateSe lected
Иконка БД должна быть выделена на странице "Репликатор".
Начинает процесс репликации выделенной БД.
ReplicatorReplicateWi thServer
Нельзя применять в формулах диалогового окна.
Выдает диалоговое окно определения сервера для репликации и начинает процесс репликации для выбранного сервера.
ReplicatorSendMail
Нельзя применять в формулах диалогового окна.
Отправляет исходящую почту на почтовый сервер.
ReplicatorSendReceiv eMail
Нельзя применять в формулах диалогового окна.
Начинает процесс репликации между почтовым сервером и локальной почтовой БД пользователя.
Начинает/продолжает процесс репликации для выделенных баз.
ReplicatorStop
Нельзя применять в формулах диалогового окна.
Останавливает процесс репликации. Может привести к частичной репликации текущей базы.
RunAgent
БД должна быть открыта или ее иконка должна быть выделена в рабочем пространстве.
Выполняет в текущей БД указанного агента. Аналогична [ToolsRunMacro] за тем лишь исключением, что выполняется немедленно в формуле, а не после всех остальных команд.
RunScheduledAgents
БД должна быть открыта или ее иконка должна быть выделена в рабочем пространстве.
Выполняет в текущей БД все фоновые агенты, независимо от времени их запуска и статуса Enable/Disable. Аналогична [ToolsRunBackgroundMacros] за тем лишь исключением, что выполняется немедленно в формуле, а не после всех остальных команд.
SectionCollapse
Документ должен быть открыт в режиме чтение/редактирование, или форма/подформа/страница должны быть открыты в режиме редактирования. Секция должна быть выбрана.
Свертывает/разворачивает текущую секцию в документе или форме/подформе/странице.
SectionCollapseAll
Документ должен быть открыт в режиме чтение/редактирование, или форма/подформа/страница должны быть открыты в режиме редактирования.
Свертывает все секции в документе или форме/подформе/странице.
Форма/подформа должны быть открыты в режиме редактирования, секция с управляемым доступом должна быть выбрана, и поле, хранящее имена редакторов секции (Section field name (for R3 compatability only) должно иметь тип редактируемый (Editable).
Выдает диалоговое окно определения редакторов текущей секции.
SectionExpand
Документ должен быть открыт в режиме чтение/редактирование, или форма/подформа/страница должны быть открыты в режиме редактирования. Секция должна быть выбрана.
Разворачивает/свертывает текущую секцию в документе или форме/подформе/странице.
SectionExpandAll
Документ должен быть открыт в режиме чтение/редактирование, или форма/подформа/страница должны быть открыты в режиме редактирования.
Разворачивает все секции в документе или форме/подформе/странице.
SectionProperties
Документ должен быть открыт в режиме редактирования, и секция в форматируемом поле должна быть выбрана, или форма/подформа/страница должны быть открыты в режиме редактирования и секция должна быть выбрана.
Документ должен быть открыт в режиме редактирования, и секция в форматируемом поле должна быть выбрана, или форма/подформа/страница должны быть открыты в режиме редактирования и секция должна быть выбрана.
Удаляет текущую секцию как объект, возвращая документ или форму/подформу/страницу к состоянию до создания секции.
SetCurrentLocation
Без ограничений.
Выдает диалоговое окно определения места вызова.
ShowHideLinkPreview
Документ должен быть открыт в режиме чтение/редактирование.
Используется для отображения/скрытия панели предварительного просмотра, для документов, связанных с текущим по ссылке.
ShowHideParentPrevi ew
Документ должен быть открыт в режиме чтение/редактирование.
Используется для отображения/скрытия панели предварительного просмотра для родительского, по отношению к текущему документа.
ShowHidePreviewPan e
В виде/папке на документе должен стоять световой маркер.
Используется для отображения/скрытия панели предварительного просмотра для текущего в виде/папке документа.
ShowProperties
Без ограничений.
Выдает окно свойств для выбранного в текущем окне объекта LN (БД, документа, секции и т.д.).
SmartIconFloating
Без ограничений.
В документации сказано, что в 6-й версии команда не поддерживается. В 5-й версии разрешает перемещение панели инструментов по текущему экрану. В 6-й версии не выполняет никаких
В документации сказано, что в 6-й версии команда не поддерживается. В 5-й версии переключала на следующий набор кнопок панели инструментов. В 6-й версии не выполняет никаких действий.
StyleCircleKey
Документ или форма/подформа/страница должны быть открыты в режиме редактирования. Хотя бы один стиль параграфа для объекта должен существовать.
Циклически переключает для документа или формы/подформы/страницы существующие стили параграфов из имеющихся.
SwitchForm
Документ должен быть открыт в режиме чтения/редактирования, или он должен находиться в панели предварительного просмотра, и фокус должен находиться в этой панели. Команда не работает если в виде/папке, из которого был открыт документ, определена формула формы.
Для текущего документа переключает его отображение по новой указанной форме. Аналогична [ViewSwitchForm] за тем лишь исключением, что выполняется немедленно в формуле, а не после всех остальных команд.
Вид/папка должны быть открыты в текущем окне. Может использоваться в Web-приложениях с обязательным указанием второго параметра.
Осуществляет переход в указанный вид/папку текущей БД. Аналогична [ViewChange] за тем лишь исключением, что выполняется немедленно в формуле, а не после всех остальных команд.
должны находиться в режиме редактирования, или документ должен находиться в режиме редактирования. Курсор должен быть для документа в форматируемом поле, для формы/подформы/страниц ы в бланке формы.
центру абзаца.
TextAlignFull
Форма/подформа/страница должны находиться в режиме редактирования, или документ должен находиться в режиме редактирования. Курсор должен быть для документа в форматируемом поле, для формы/подформы/страниц ы в бланке формы.
Форматирует текущий текст по ширине абзаца.
TextAlignLeft
Форма/подформа/страница должны находиться в режиме редактирования, или документ должен находиться в режиме редактирования. Курсор должен быть для документа в форматируемом поле, для формы/подформы/страниц ы в бланке формы.
Форматирует текущий текст по левому краю абзаца.
TextAlignNone
Форма/подформа/страница должны находиться в режиме редактирования, или документ должен находиться в режиме редактирования. Курсор должен быть для документа в форматируемом поле, для формы/подформы/страниц ы в бланке формы.
должны находиться в режиме редактирования, или документ должен находиться в режиме редактирования. Курсор должен быть для документа в форматируемом поле, для формы/подформы/страниц ы в бланке формы.
правому краю абзаца.
TextBold
Документ или элемент дизайна должен находиться в режиме редактирования. Для документа курсор должен быть в форматируемом поле, для элемента дизайна в рамках объекта допускающего менять параметры шрифта.
Устанавливает/снимает для выделенного или текущего текста свойство шрифта "полужирный".
TextBullet
Форма/подформа/страница должны находиться в режиме редактирования, или документ должен находиться в режиме редактирования. Курсор должен быть для документа в форматируемом поле, для формы/подформы/страниц ы в бланке формы.
Устанавливает/снимает для выделенного или текущего текста форматирование типа маркированный список.
TextCycleSpacing
Форма/подформа/страница должны находиться в режиме редактирования, или документ должен находиться в режиме редактирования. Курсор должен быть для документа в форматируемом поле, для формы/подформы/страниц ы в бланке формы.
Устанавливает для выделенного или текущего текста величину межстрочного интервала (одинарный, полуторный, двойной). Работает по кругу.
должны находиться в режиме редактирования, или документ должен находиться в режиме редактирования. Курсор должен быть для документа в форматируемом поле, для формы/подформы/страниц ы в бланке формы.
выделенного или текущего текста свойство размер шрифта на следующий по отношению к текущему размеру.
TextFont
Форма/подформа/страница должны находиться в режиме редактирования, или документ должен находиться в режиме редактирования. Курсор должен быть для документа в форматируемом поле, для формы/подформы/страниц ы в бланке формы.
Выдает окно свойств для выделенного или текущего текста.
TextItalic
Документ или элемент дизайна должен находиться в режиме редактирования. Для документа курсор должен быть в форматируемом поле, для элемента дизайна в рамках объекта допускающего менять параметры шрифта.
Устанавливает/снимает для выделенного или текущего текста свойство шрифта "курсив".
TextNormal
Форма/подформа/страница должны находиться в режиме редактирования, или документ должен находиться в режиме редактирования. Курсор должен быть для документа в форматируемом поле, для формы/подформы/страниц ы в бланке формы.
Устанавливает/снимает для выделенного или текущего текста свойство шрифта "обычный".
должны находиться в режиме редактирования, или документ должен находиться в режиме редактирования. Курсор должен быть для документа в форматируемом поле, для формы/подформы/страниц ы в бланке формы.
выделенного или текущего текста форматирование типа нумерованный список.
TextOutdent
Форма/подформа/страница должны находиться в режиме редактирования, или документ должен находиться в режиме редактирования. Курсор должен быть для документа в форматируемом поле, для формы/подформы/страниц ы в бланке формы.
Форматирует текущий или выделенный текст, уменьшая его левый отступ.
TextParagraph
Форма/подформа/страница должны находиться в режиме редактирования, или документ должен находиться в режиме редактирования. Курсор должен быть для документа в форматируемом поле, для формы/подформы/страниц ы в бланке формы.
Выдает окно свойств текущего или выделенного текста, становясь сразу на закладку с параметрами форматирования.
TextParagraphStyles
Форма/подформа/страница должны находиться в режиме редактирования, или документ должен находиться в режиме редактирования. Курсор должен быть для документа в форматируемом поле, для формы/подформы/страниц ы в бланке формы.
Выдает окно свойств текущего или выделенного текста, становясь сразу на закладку с параметрами стилей параграфа.
Форма/подформа/страница должны находиться в режиме редактирования, или документ должен находиться в режиме редактирования. Курсор должен быть для документа в форматируемом поле, для формы/подформы/страниц ы в бланке формы.
Устанавливает/снимает для текущего текста свойство шрифта типа "фломастер".
TextReduceFont
Форма/подформа/страница должны находиться в режиме редактирования, или документ должен находиться в режиме редактирования. Курсор должен быть для документа в форматируемом поле, для формы/подформы/страниц ы в бланке формы.
Устанавливает для выделенного или текущего текста свойство "размер шрифта" на предыдущий по отношению к текущему размеру.
TextSetFontColor
Форма/подформа/страница должны находиться в режиме редактирования, или документ должен находиться в режиме редактирования. Курсор должен быть для документа в форматируемом поле, для формы/подформы/страниц ы в бланке формы.
Устанавливает для выделенного или текущего текста свойство "цвет шрифта" на указанный.
TextSetFontFace
Форма/подформа/страница должны находиться в режиме редактирования, или документ должен находиться в режиме редактирования. Курсор должен быть для документа в форматируемом поле, для формы/подформы/страниц ы в бланке формы.
Устанавливает для выделенного или текущего текста свойство "имя шрифта" на указанное.
режиме редактирования, или документ должен находиться в режиме редактирования. Курсор должен быть для документа в форматируемом поле, для формы/подформы/страниц ы в бланке формы.
текста свойство "размер шрифта" на указанный.
TextSpacingDouble
Форма/подформа/страница должны находиться в режиме редактирования, или документ должен находиться в режиме редактирования. Курсор должен быть для документа в форматируемом поле, для формы/подформы/страниц ы в бланке формы.
Устанавливает для выделенного или текущего текста величину двойного межстрочного интервала.
TextSpacingOneAndA Half
Форма/подформа/страница должны находиться в режиме редактирования, или документ должен находиться в режиме редактирования. Курсор должен быть для документа в форматируемом поле, для формы/подформы/страниц ы в бланке формы.
Устанавливает для выделенного или текущего текста величину полуторного межстрочного интервала.
TextSpacingSingle
Форма/подформа/страница должны находиться в режиме редактирования, или документ должен находиться в режиме редактирования. Курсор должен быть для документа в форматируемом поле, для формы/подформы/страниц ы в бланке формы.
Устанавливает для выделенного или текущего текста величину одинарного межстрочного интервала.
Документ или элемент дизайна должен находиться в режиме редактирования. Для документа курсор должен быть в форматируемом поле, для элемента дизайна в рамках объекта допускающего менять параметры шрифта.
Устанавливает/снимает для выделенного или текущего текста свойство шрифта "подчеркнутый".
ToolsCall
Порты должны быть соответствующим образом настроены.
Выдает диалоговое подключение к серверу.
ToolsCategories
Документ должен быть открыт в режиме чтение/редактирование, или в текущем окне должен быть открыт вид/папка и документы должны быть выделены или на документе стоит световой маркер. Документ(ы) должны иметь поле "Categories", и вид/папка должны иметь первый категоризированный столбец, в формуле которого присутствует поле "Categories".
Категоризирует текущий выбранные документы.
ToolsHangUp
Порты должны быть соответствующим образом настроены.
Выдает диалоговое отключение от сервера.
ToolsMarkAllRead
Документ должен быть открыт в режиме чтение/редактирование, или в текущем окне должен быть открыт вид/папка.
Помечает все документы в БД как прочтенные.
Документ должен быть открыт в режиме чтение/редактирование, или в текущем окне должен
В текущем окне должен быть открыт вид/папка, и документы должны быть помечены, или на документе стоит световой маркер.
Помечает текущий или выбранные документы в БД как прочтенные.
В текущем окне должен быть открыт вид/папка, и документы должны быть помечены, или на документе стоит световой маркер, или документ должен быть открыт в режиме чтения/редактирование.
Помечает текущий или выбранные документы в БД как непрочтенные.
В текущем окне должен быть открыт вид/папка.
Перевычисляет все формулы во всех документах текущего вида/папки и сохраняет изменения.
В текущем окне должен быть открыт вид/папка, и документы должны быть помечены, или на документе стоит световой маркер.
Перевычисляет все формулы в текущем или выделенных документах текущего вида/папки и сохраняет изменения.
ToolsReplicate
БД должна быть открыта или ее иконка должна быть выделена в рабочем пространстве.
Используется для реплицирования текущей БД.
ToolsRunBackground Macros
БД должна быть открыта или ее иконка должна быть выделена в рабочем пространстве. Всегда выполняется последней в формуле.
Выполняет в текущей БД все фоновые агенты, независимо от времени их запуска и статуса Enable/Disable. В дальнейшем фоновые агенты будут выполняться по расписанию.
ToolsRunMacro
БД должна быть открыта
Выполняет
Стр. 255
ToolsMarkSelectedU nread Стр. 256
ToolsRefreshAllDoc s Стр. 268 ToolsRefreshSelecte dDocs Стр. 268
или ее иконка должна быть выделена в рабочем пространстве. Всегда выполняется последней в формуле, за исключением Web-приложений, где все @-команды выполняются последовательно.
указанного агента.
ToolsScanUnreadCho ose
Нельзя применять в формулах диалогового окна.
Выдает диалоговое окно определения имен БД, в которых необходимо осуществить поиск непрочтенных документов.
ToolsScanUnreadPref erred
Нельзя применять в формулах диалогового окна.
Выдает диалоговое окно результатов поиска непрочтенных документов в базах данных, определенных командой [ToolsScanUnreadChoose].
ToolsScanUnreadSele cted
Нельзя применять в формулах диалогового окна.
При открытой (или выбранной в рабочем пространстве одной БД) открывает первый непрочтенный документ текущей БД. Если в рабочем пространстве выбрано несколько БД, то выдает диалоговое окно (как по команде [ToolsScanUnreadPreferred]) для выбранных БД. Если не одна БД в рабочем пространстве не выбрана, то выдает диалоговое окно (как по команде [ToolsScanUnreadPreferred]) для выбранных БД. В указанном диалоге пользователь может ограничить набор БД для сканирования.
ToolsSetupLocation
Нельзя применять в формулах диалогового окна.
Открывает на редактирование документ, соответствующий текущему месту вызова, из личной адресной книги.
панель предварительного показа - в правой части экрана.
Устанавливает для всех видов/папок в текущей БД следующий порядок отображения панелей: •
панель навигации - в левой верхней части экрана;
•
панель показа - в правой верхней части экрана;
•
панель предварительного показа - в нижней части экрана.
ViewCertify
Должен быть открыт вид "Пользователь" ("Person") общей адресной книги, и в виде выбран один или несколько документов.
Используется ресертификации пользователей.
ViewChange
В R 6 всегда выполняется последней в формуле. Вид/папка должны быть открыты в текущем окне. Можно использовать в Web-приложениях при условии задания второго параметра.
Осуществляет переход в указанный вид/папку текущей БД.
Вид/папка должны быть открыты в текущем окне. Можно использовать в Web-приложениях.
Для текущей строки-категории "свертывает" все категории и документы ниже ее.
Вид/папка должны быть открыты в текущем окне. Можно использовать в Web-приложениях.
"Свертывает" все категории и документы в текущем виде/папке.
Вид/папка должны быть открыты в текущем окне. Можно использовать в
Для текущей строки-категории "раскрывает" один уровень категории или документов ниже
Вид/папка должны быть открыты в текущем окне. Можно использовать в Web-приложениях.
"Раскрывает" все категории и документы в текущем виде/папке.
Вид/папка должны быть открыты в текущем окне. Можно использовать в Web-приложениях.
Для текущей строки-категории "раскрывает" все уровни категории или документов ниже ее.
ViewHorizScrollBar
Вид/папка должны быть открыты в текущем окне. Указатель курсора должен находиться в панели показа. Команда не поддерживается на платформах OS/2 и Macintosh.
Отображает в виде/папке горизонтальную полосу «прокрутки». Из личного опыта автора команда в версии R 6.0.1 не работает.
ViewMoveName
Должен быть открыт вид "Пользователь" ("Person") Domino Directory, и в виде выбран один или несколько документов.
Используется для ресертификации выбранных пользователей в новой организационной единице.
ViewNavigatorsFolder s
Вид/папка должны быть открыты в текущем окне.
Отображает навигации стандартный умолчанию.
ViewNavigatorsNone
Вид/папка должны быть открыты в текущем окне.
Скрывает панель навигации в текущем виде/папке.
ViewRefreshFields
Документ должен быть открыт в режиме редактирования, или вид/папка должны быть открыты в текущем окне. Можно использовать в Web-приложениях.
Осуществляет пересчет всех формул полей для текущего документа, или обновляет содержимое вида/папки.
ViewRefreshUnread
В текущем окне должна быть открыта страница рабочего пространства.
Обновляет значение числа непрочтенных документов в иконках БД на текущем листе рабочего пространства.
ViewRenamePerson
Должен быть открыт вид "Пользователь" ("Person")
Используется для изменения общего или иерархического
В текущем окне должна быть открыта страница рабочего пространства.
Отображает/скрывает серверов на иконках рабочем пространстве.
ViewShowUnread
В текущем окне должна быть открыта страница рабочего пространства.
Отображает/скрывает число непрочтенных документов на иконках БД в рабочем пространстве.
ViewSwitchForm
Документ должен быть открыт в режиме чтения/редактирования, или он должен находиться в панели предварительного просмотра, и фокус должен находиться в этой панели. Всегда выполняется последней в формуле. Команда не работает если в виде/папке, из которого был открыт документ, определена формула формы.
Для текущего документа переключает его отображение по новой указанной форме.
WindowCascade
Нельзя применять в формулах диалогового окна. Не работает в Webприложениях.
Отображает все открытые окна Notes/Domino каскадным стилем, т.е. уменьшенным размером окон и “лесенкой”. Обратите внимание, что под окнами здесь подразумеваются окна Notes/Domino, присутствующие в панели задач операционной системы, а не открытые в рамках одного приложения, например, Domino Designer.
WindowMaximize
Нельзя применять в формулах диалогового окна. Не работает в Webприложениях.
Раскрывает на весь размер главного окна активное окно Notes/Domino.
WindowMaximizeAll
Нельзя применять в формулах диалогового окна. Не работает в Webприложениях.
Раскрывает на весь размер все открытые окна Notes/Domino.
WindowMinimize
Нельзя применять в формулах диалогового окна. Не работает в Web-
Нельзя применять в формулах диалогового окна. Не работает в Webприложениях.
Свертывает все открытые окна Notes/Domino.
WindowNext
Нельзя применять в формулах диалогового окна. Не работает в Webприложениях.
Делает активным окно, следующим за текущим, т.е. лежащим правее в панели задач операционной системы.
WindowRestore
Нельзя применять в формулах диалогового окна. Работает только для окон, у которых изменялись размеры после выполнения команд максимизации/минимизаци и. На окна, размеры которых были изменены с помощью [WindowCascade] или [WindowTile] влияние не оказывает. Не работает в Web-приложениях.
Возвращает активное окно к размерам до применения максимизации/минимизации.
WindowTile
Нельзя применять в формулах диалогового окна. Не работает в Webприложениях.
Размещает все окна Notes/Domino в рамках главного окна.
WindowWorkspace
Нельзя применять в формулах диалогового окна.
Переключается или открывает окно рабочего пространства.
WorkspaceProperties
В текущем окне должна быть открыта страница рабочего пространства.
Выдает окно свойств текущей страницы рабочего пространства.
WorkspaceStackRepli caIcons
В текущем окне должна быть открыта страница рабочего пространства.
10 Разработка тестовых приложений Разработку тестового приложения начнем с простейшего варианта. Создадим форму и реализуем функции: создания нового, редактирование, удаление и печать документа. Указанную функциональность будем реализовать через акции вида и формы.
10.1 Простые операции с документами 10.1.1 Создание нового документа по форме Для создания нового документа воспользуемся @-командой Compose (см. стр. 239). В итоге акция вида будет иметь формулу: @Command([Compose];"";"Country"). Для сохранения нового документа предусмотрим акцию формы с действиями: сохранение (см. стр. 244) и закрытие текущего документа (см. стр. 245). Код акции будет следующим: @Command([FileSave]); @Command([FileCloseWindow])
Перед сохранением формы следует не забыть «скрыть» акцию в режиме чтения документа (на второй закладке свойств акции). Продемонстрировать форму и вид Country.
10.1.2 Редактирование текущего документа Для редактирования документа можно воспользоваться системной акцией вида. Однако, системные акции не транслируются в Web. Для реализации редактирования текущего документа можно воспользоваться одной из следующих команд [EditDocument] (см. стр. 242) или [OpenDocument] (см. стр. 258). В обоих случаях акции «напрямую» не работают в Web-приложениях на уровне вида, даже если вид транслируется в Web апплетом. Существуют и другие недостатки/достоинства этих команд по отношению друг к другу (см. их описание). Для редактирования на уровне открытого документа можно использовать команду [EditDocument]. Следует не забыть «скрыть» акцию формы в режиме редактирования. Для Web-приложений надо использовать эту команду без параметров.
10.1.3 Удаление документа Для пометки документа на удаление можно использовать команду [EditClear] (см. стр. 246). В клиенте Notes эта команда работает на уровне вида и формы. В Web-приложениях команда работает только на уровне открытого документа, и сразу удаляет (т.е. не помечает к удалению) текущий документ. Кроме [EditClear] для удаления документов могут быть использованы команды [MoveToTrash] (см. стр. 247) и [EmptyTrash] (см. стр. 248). В частности для немедленного удаления документа(ов) на уровне вида в клиенте Notes может быть использованы следующие последовательности команд: Вариант 1 (исправить в книге пример со страницы 248). @Command( [Clear] ); @Command( [EmptyTrash] )
Вариант 2. @Command([MoveToTrash]); @Command([EmptyTrash])
В Web-приложениях для видов с установленными свойствами: Use applet in the browser (использовать апплет при отображении вида в Web), либо Allow selection of documents (разрешить выделение документов) можно использовать команды [MoveToTrash] и [EmptyTrash]. Единственно не допускается их совместное использование в рамках одной формулы.
10.1.4 Печать документа и вида Для печати в рамках клиента Notes используется команда [FilePrint] (см. стр. 249). Для печати содержимого вида можно использовать следующую команду в акции вида: @Command( [FilePrint]; ""; ""; ""; ""; "printview" )
Для печати открытого документа можно использовать следующую команду в акции формы: @Command( [FilePrint]; "" );
При печати открытого документа можно переключить отображение его контента на другую форму, распечатать его по этой форме, а затем обратно переключиться на отображение по старой форме. В этом случае команда акции вида может выглядеть следующим образом: @Command( [SwitchForm] ; "новая_форма" );
Для корректной работы такой формулы, форма не должна быть сохранена в документе и вид/папка, из которого осуществлялось открытие документа, не должна иметь формулы формы.
10.1.5 Упражнение В рамках этого упражнения слушатели должны самостоятельно реализовать рассмотренные в этом параграфе, а именно создание нового, редактирование, удаление и печать документа и вида.
10.2 Формулы полей У объекта поле в Domino/Notes R 6, в зависимости от типа поля, может присутствовать от одного до четырех подобъектов, значение которых определяется на языке @-формул. Это:
• • • • • •
Default value formula (значение поля по умолчанию). Результат должен быть пригоден для сохранения в данном поле; Input translation formula (формула преобразования значения поля). Результат должен быть пригоден для сохранения в данном поле; Input validation formula (формула проверки значения поля). Результат истина или ложь; Input enabled formula (формула разрешения ввода значения в поле). Результат - истина или ложь; Computed field formula (формула вычисляемого поля). Результат должен быть пригоден для сохранения в данном поле; Keyword field formula (формула ключевых слов). Результат – значение или список значений, пригодный для сохранения в данном поле.
Начнем рассмотрение с Input validation formula. Запретим сохранять документ с некоторым пустым полем. Данную функциональность можно реализовать с использованием функций @Failure (см. стр. 233), @Success (см. стр. 234) и @If (см. стр. 38). Продемонстрировать форму Country. @If(Country=""; @Failure("Поле Country не должно быть пустым"); @Success)
Демонстрация на примере формы DeadLine. Формула по умолчанию можно использовать для задания начального значения некоторых полей. Например, для поля, в которое требуется поместить текущую на момент создания документа дату плюс два дня, можно определить следующую формулу по умолчанию: @Adjust(@Today;0;0;2;0;0;0)
Формула преобразования введенного значения обеспечивает функциональность по изменению значений текущего или иных полей документа. Например, @SetField("Dline";@Today); @Trim(@ThisValue)
Демонстрация на примере формы Chair. В рамках формул полей в 6-й версии Notes/Domino можно использовать новые команды: @ThisValue (см. стр. 125), @ThisName (см. стр. 125) и @GetField (см. стр. 125). Эти функции позволяет писать переносимый код, очень часто без явного указания в формуле конкретных имен полей. Модифицируем пример со стульями из примера к функции @GetField. В нашем случае формула вычисляемых полей общей цены будет следующая: chairName := @Left(@ThisName; "_"); @IfError(@ToNumber(@GetField(chairName + "_Quantity")) @IfError(@ToNumber(@GetField(chairName + "_Price"));0)
;
0)
*
Демонстрация на примере формы DeadLine. Формула разрешения ввода значения в поле применима только к полям типа NativeOS style. Если эта формула возвращает значение истина (1), то поле доступно для ввода в клиенте Notes, в противном случае поле недоступно для ввода. Например, @IsMember("[admin]";@UserRoles)
Формулы ключевых слов будут рассмотрены в следующем параграфе.
10.2.1 Упражнение В форме Страна реализовать запрет ввода в поле Country пустого значения.
10.3 Получения доступа к данным, находящимся вне текущего документа До настоящего момента мы получали данные только из текущего документа. Существуют возможности получения доступа к другим данным в рамках языка @-формул. Рассмотрим некоторые из них.
10.3.1 Доступ к данным вида Для получения в виде списка значений столбца вида используется функция @DbColumn (см. стр. 150), а для поиска информации по ключу из колонки вида - @DbLookup (см. стр. 155). Внимательно рассмотреть синтаксис и параметры функций. Реализуем следующую функциональность: ввод документов по странам, городам и отелям. В рамках документа «город» необходимо осуществить выбор страны из списка. В документе «отель» после выбора из списка стран, поле «город» тоже должно выбираться из списка и соответствовать выбранному значению страны. В этом случае значение формулы ключевых слов поля Country в формах «город» и «отель» может иметь вид: "... страна "Country"; 1) ,
не
выбрана
..."
:
@DbColumn("":"NoCache";
"";
а формула поля Town в форме «отель»: @If(@IsMember(Country ; "... страна не выбрана ..." : ""); "... выберите сначала страну ..."; @IsError(@DbLookup("" : "NoCache"; ""; "Town"; Country; 2)); "... в данной стране не введено ни одного города ..."; "... город не выбран ..." : @DbLookup("" : "NoCache"; ""; "Town"; Country; 2))
Виды «Country» и «Town» должны присутствовать в БД и иметь соответствующие настройки. Для корректной работы примера у свойств полей типа список требуется поднять флаги Refresh fields on keyword change (для Country) и Refresh choices on document refresh (для Town). Продемострировать форму Letter.
10.3.2 Наследование Демонстрация на примере форм Inherit, ForInherit и вида Inherit. Поля формы могут наследовать данные из текущего документа в момент создания нового документа. Включение режима наследования осуществляется в свойствах формы на закладке Defaults в секции On Create. В клиенте Notes наследование можно выполнять как на уровне вида, так и на уровне открытого документа. В Web-приложениях наследование работает только на уровне
открытого документа, даже в случае когда вид отображается с помощью апплета. В качестве приемника наследуемых значений лучше всего использовать редактируемые и вычисляемые при создании поля.
10.3.3 Упражнение Реализовать пример Страна – Город – Отель. В форме «отель» реализовать наследование полей «страна» и «город».
10.3.4 Работа с профильными документами Демонстрация на примере БД HOTEL. Для работы с профильными документами (см. раздел 6.19) на языке @-формул можно использовать две функции: @GetProfileField (см. стр. 192), @SetProfileField (см. стр. 192) и одну из двух команд: [EditProfile] (см. стр. 264) или [EditProfileDocument] (см. стр. 265).
10.3.5 Упражнение Видоизменить пример Страна – Город – Отель следующим образом. Информация о странах и городах находится в одной БД, а об отелях в другой БД. В этой же БД для обеспечения доступа к информации Страна – Город в профильном документе хранятся путь к БД с информацией о Стране – Городе.
10.3.6 Работа с переменными окружения Демонстрация на примере БД HOTEL. Для работы с переменными окружения можно использовать функции @Environment (см. стр.111) и @SetEnvironment (см. стр. 113).
10.3.7 Упражнение Видоизменить предыдущий пример так, чтобы информация о местонахождении БД со странами и городами хранилась в переменных окружения. Объяснить недостатки этого метода.
10.4 Диалог с пользователем 10.4.1 Функция @Prompt Демонстрация на примере форм Prompt и Hotel. Рассмотреть синтаксис и пример с функцией @Prompt (см. стр. 194). Объяснить синтаксис и применение
команд [NavNext] и [NavPrev]. С помощью этой функции в форме Отель реализовать акцию, осуществляющую переход на предыдущий/следующий документ. Формула акции может быть следующая: rez := @Prompt([OkCancelCombo]:[NoSort]; перейти?"; "вниз"; "вверх":"вниз");
10.4.2 Функция @DialogBox Демонстрация на примере формы HotelDialogBox. Рассмотреть синтаксис и пример с функцией @DialogBox (см. стр. 210). Объяснить синтаксис и применение функции @Eval (см. стр. 42) и команды [RefreshParentNote] (см. стр. 267). С помощью функции @DialogBox в форме Отель реализовать две кнопки, которые осуществляют соответственно выбор в отдельных формах Страны и Города.
10.4.3 Функция @PickList Демонстрация на примере формы HotelPikList. Рассмотреть синтаксис и пример с функцией @PickList (см. стр. 205). С помощью функции @PickList в форме Отель реализовать кнопку, которая вызывает диалог и заполнение полей Страны и Города.
10.5 Формулы скрытия информации В рамках Domino R6 может применяться формулы, которые осуществляют скрытие информации. Это формулы скрытия: абзаца формы/подформы/страницы, акций форм/видов, строк аутлайна столбцов вида. Во всех случаях формулы должны возвращать 1 (Истина) для скрытия информации, и 0 (Ложь) – в противном случае. Следует обратить внимание, что формулы скрытия информации не являются дополнительным уровнем безопасности, т.к. к «скрытой» информации можно добраться другим путем (показать окно свойств документа).
10.5.1 Формулы скрытия абзаца формы Демонстрация на примере формы Hide и Hotel. Как видно из названия формула может быть применена только к абзацу текста, т.е., нельзя «скрыть» одно слово в строке. Для решения этой проблемы можно примерить ячейки таблицы с невидимыми границами (см. форму Hotel). В рамках формы можно в формулах скрытия использовать значения полей. Формы скрытия автоматически не перевычисляются при изменении внешних условий (показать форму Hide). Для принудительного перевычисления формул скрытия можно применять обновление документа (F9), его аналог на языке @-формул - [ViewRefreshFields]
(см. стр.266) или [RefreshHideFormulas] (см. стр. 267). Последняя команда предпочтительней. Кроме собственно формулы скрытия абзаца можно скрывать последний в зависимости от режима документа и типа клиента.
10.5.2 Формулы скрытия акций формы и вида Демонстрация на примере формы и вида Hotel (акции English). В формулах скрытия акций формы также можно использовать значения полей. Для акций вида это возможно только при условии поднятия в свойствах вида флага Evaluate actions for every document change.
10.5.3 Формулы скрытия столбцов вида и строк аутлайна Демонстрация на примере формы Out, аутлайна Out1 (строка Hotel) и вида Hotel (последний столбец). Контекст этих формул не очень хорошо документирован. Для формулы скрытия столбца вида она выполняется единократно при открытия вида и не перевычисляется при использовании команд [ViewRefreshFields] и [RefreshHideFormulas]. Для строк аутлайна перевычисление их формул скрытия может быть произведено по команде [ViewRefreshFields] (но не [RefreshHideFormulas]).
10.5.4 Упражнение В форме Отель создать поле «Название отеля по латински». Это поле должно скрываться, если в поле Страна введено значение «Россия». Создать акцию формы, выводящую значение поля «Название отеля по латински» или строку: «Название отеля по латински не введено». Акция также должна скрываться , если в поле Страна введено значение «Россия». Создать аналогичную акцию в виде Отель.
10.6 Формулы работы с видами 10.6.1 Формула отбора документов Демонстрация на примере видов Main+Resp, Cal1, Cal2, Cal3. Формула отбора документов в вид является одной самых важнейших формул вида. Формула строится с использованием ключевого слова SELECT (см. стр. 16). Наиболее часто эта формула строится на основании значений полей и свойств документов. Например, SELECT Form="Hotel"
В формулах отбора (как впрочем и в формулах столбцов вида) настоятельно не рекомендуется использовать функции, оперирующие с компонентами текущей дата/времени. Если это все-таки необходимо, то желательно предварительно ограничить число документов (это условие должно быть первым в операторе SELECT), а затем применить условие, имеющее отношение к текущей дате/времени. Например, SELECT Form = "Main" & @Created > @Adjust(@Now; 0; 0; -3; 0; 0; 0), а не наоборот SELECT @Created > @Adjust(@Now; 0; 0; -3; 0; 0; 0) & Form = "Main". В 6-й версии Domino для этих целей можно еще использовать «раскраску» строк вида через профайл (см. вид Cal3). Такие виды не помечаются сервером, как требующие частого обновления, однако индекс этих видов автоматически не изменяется в зависимости от таймера. Самостоятельно реализовать аналог примера с видом Cal3. Для отбора документов «родителей» вместе со своими потомками можно использовать функции @AllChildren (см. стр. 170) и @AllDescendants (см. стр. 171). Продемонстрировать пример организации галереи (см. БД TestJPG.nsf). Рассмотреть функции @DocumentUniqueID (см. стр. 146) и @WebDBName (см. стр. 228). Самостоятельно реализовать аналог галереи.
10.6.2 Формулы столбцов вида Для задания формулы столбца необходимо сначала перейти в объектно-событийной панели на конкретный объект Column Value (значение столбца). При этом в панели программного кода можно определить характеристики выводимого значения. В верхней части программной панели расположено поле Display (отображение), которое с помощью трех радиокнопок определяет способ задания значения колонки вида. Интерфейс радиокнопок предлагает для выбора следующие значения:
•
Simple Function (простые функции). Определение значения столбца идет на основании предопределенного набора функции. Все они имеют аналоги в языке @-формул. Ниже в таблице приведен список этих функций с расшифровкой выполняемых ими действий:
Отображает иерархический уровень текущего документа. Номер 2.1.2 говорит, что документ на верхнем уровне иерархии лежит во второй категории, на втором уровне иерархии в первой категории, а сам принадлежит к третьему уровню иерархии и в рамках его лежит вторым, считая сверху вниз.
@DocNumber
# Responses Level)
of (1
Число ответных документов на первом уровне иерархии
Определяет число документов или подкатегорий, лежащих на один уровень ниже от текущей категории. Колонка с этой формулой должна находится левее колонки с категорией, для которой определяется число ответных документов.
@DocChildre n
# of Responses (All Level)
Число ответных документов на всех уровнях иерархии
Определяет число документов или подкатегорий, лежащих на всех уровнях ниже текущей категории. Колонка с этой формулой должна находиться левее колонки с категорией, для которой определяется число ответных документов.
Возвращаемое значение есть число, или числовой список, если присоединенных файлов несколько.
@Attachment Lengths
Attachment Names
Имена присоедин енных файлов
Возвращаемое значение есть текст, или текстовый список, если присоединенных файлов несколько.
@Attachment Names
Attachments
Количество присоедин енных файлов
Возвращаемое значение есть число, соответствующее числу присоединенных файлов.
@Attachment s
Author(s) (Distinguished Name)
Автор (ы) (полное иерархичес кое имя)
Возвращает имя автора документа в иерархическом формате
@Author
Author(s) (Simple Name)
Автор(ы) (сокращенн ое имя)
Возвращает имя автора документа в сокращенном формате
@Name([CN]; @Author)
Collapse/Expa nd (+/-)
Уровень «свернут/р азвернут»
Возвращает строку "+", если уровень в виде разворачиваемый, и "-" если нет. Столбец должен иметь категоризацию (свойство Categorized), либо лежать левее категоризующей колонки.
@IsExpandab le
Creation Date
Дата создания
Возвращает время документа
дату и создания
@Created
Last Modified
Дата последней модификац ии
Возвращает дату и время последнего сохранения документа
Дата последнего чтения или редактиров ания документа
Возвращает дату и время последнего чтения или редактирования документа
@Accessed
Size (bytes)
Размер байтах
Возвращает размер документа в байтах
@DocLength
•
•
в
Field (поля). Определение значения столбца идет на основании полей, присутствующих в текущей БД. В панели программного кода перечислен список этих полей. Следует помнить, что в колонках видов нельзя отображать значение Rich Text полей. Имена таких полей обычно отсутствуют в панели программного кода. Это происходит в случае, когда у всех документов текущей БД поле с таким именем имеет тип Rich Text. Далее, если текущая колонка категоризованная (Categorized), и в значении поля присутствует символ обратного слеша («\»), то в колонке возникают дополнительные уровни иерархии, число которых зависит от количества обратных слешей в значении поля. Например, значение поля «Европа\Россия\Москва» в категоризованной колонке вида будет отображено тремя уровнями иерархии, соответственно «Европа», «Россия» и «Москва». При этом, следует не забывать, что Domino поддерживает до 32 уровней иерархии; Formula (@-формула). Определение значения столбца идет на основании языка @-формул. Это наиболее гибкий способ определения значения колонки вида. В контексте формулы колонки видов допускается использовать ссылки на значения полей, а также ряд @-функции, которые поддерживаются в этом контексте (подробнее см. документацию). Аналогично предыдущему пункту в категоризованных колонках допускается использовать символ обратного слеша («\»). В этом случае стоит не забывать, что согласно синтаксису @-формул, символ слеша должен быть удвоен. Например, формула столбца может выглядеть так: Country + "\\" + Region + "\\" + Town. Продемонстрировать формулу столбца со слешем (см. вид Hotel with
slash). Продемонстрировать и объяснить работу примера галереи в рамках вида (см. вид Table photo БД TestJPG.nsf). Самостоятельно реализовать аналог табличной галереи. Рассмотреть механизм использования циклов в формулах видов на примере видов Numb и NumbSelFormula. Рассмотреть синтаксис циклов (см. стр. 43).
10.6.3 Наложения фильтра на вид Рассмотреть синтаксис и описание функции @SetViewInfo (см. стр. 167). Продемонстрировать пример в видах Hotel и Calend. Обратите внимание на эффект снятия фильтра при переключении между разными типами видов (Календарный – Стандартный). Самостоятельно реализовать в виде Отели наложение/снятия фильтра по стране.
10.7 Работа с почтой Рассмотреть синтаксис и описание функций @MailSend (см. стр. 138) и @ValidateInternetAddress (см. стр. 142). Продемонстрировать примеры с формами Memo, Memo1, Memo2. Самостоятельно реализовать форму для отправки документа по почте. Необходимо выполнить три варианта:
•
@MailSend без параметров;
•
@MailSend с определением адресата из поля, отличного от SendTo;
•
@MailSend с пересылкой ссылки на документ.
10.8 Работа с именами пользователей Рассмотреть синтаксис и описание функций @UserName (см. стр. 177) и @Name (см. стр. 177). Продемонстрировать пример с формой Name+Access. Самостоятельно реализовать форму, в информации используются функции @UserName недостатки этого метода.
которой для скрытия и @Name. Объяснить
10.9 Работа с уровнями доступа Рассмотреть синтаксис и описание функций @UserAccess (см. стр. 182), @UserRoles (см. стр. 184), @IsMember (см. стр. 102) и @IsNotMember (см. стр. 103) . Продемонстрировать пример с формой Name+Access. В виде Country скрыть акцию с командой Compose для пользователей, не имеющих доступа на создание документов. В форме из предыдущего параграфа скрыть абзац с использованием функции @UserRoles.
10.10Блокировка документов на редактирование Рассмотреть синтаксис и описание функций @DocLock (см. стр. 130), @IsAvailable (см. стр. 127) и @DbManager (см. стр. 182). Продемонстрировать пример с видом Lock. Самостоятельно реализовать вид, в котором присутствуют две акции. Первая блокирует, а вторая - разблокирует текущий документ.
10.11Операции с папками Рассмотреть синтаксис и описание функции @AddToFolder (см. стр. 134) и команд [Folder] (см. стр. 250), [FolderDocuments] (см. стр. 251), [RemoveFromFolder] (см. стр. 251) и [EditSelectAll] (см. стр. 253). Продемонстрировать пример с папкой Leningrad. Самостоятельно создать две папки. В первой создать три акции, каждая из которых реализует одну функций/команд: @AddToFolder, [Folder] и [RemoveFromFolder].
10.12Функции, используемые в Webприложениях Рассмотреть синтаксис и описание функций @URLOpen (см. стр. 222), @SetTargetFrame (см. стр. 193), @ReplicaID (см. стр. 230), @ReplaceSubstring (см. стр. 88), @URLEncode (см. стр. 223), @GetHTTPHeader (см. стр. 225), @SetHTTPHeader (см. стр. 225), @ClientType (см. стр. 216) и @BrowserInfo (см. стр. 219). Обратите внимание, что последняя функция только определяет физическую возможность поддержания указанных режимов, а не фактическое состояние (включен/выключен). Продемонстрировать примеры: с видом AllDocs (акции URLOpen1 и URLOpen2, URLOpen3), с видом Hotel (акция Категория) и формой $$Search. Самостоятельно реализовать поисковую форму по индексу вида.
10.13Формулы по месту применения Еще раз показать документы из БД Справки с заголовками «Where does this @function work?…».
10.13.1Формулы панели инструментов - Toolbar button Показать как вносить такие формулы (File -> Preferences -> Toolbar Preferences). Рассмотреть синтаксис и описание команд [ViewCollapseAll] (см. стр. 269) и [ViewExpandAll] (см. стр. 269) Самостоятельно реализовать две кнопки панели инструментов с указанными командами.
10.13.2Формулы агентов Рассказать про критерий отбора документов в комбинации Рассмотреть синтаксис и описание функций @Created (см. @HardDeleteDocument (см. стр. 130), @DeleteDocument (см. @DeleteField (см. стр. 126), @UndeleteDocument (см. стр. 128) [EditRestoreDocument] (см. стр. 243). Продемонстрировать агентов HardDelete и вид SoftDeletionView.
с SELECT. стр. 115), стр. 129), и команду SoftDelete,
Самостоятельно написать агента, который обрабатывает все документы созданные по определенной форме в заданном интервале времени и удаляет из этих документов поле Form.
10.13.3Формула секции с управляемым доступом Спросить (и при необходимости рассказать) про два функциональных предназначения секции с управляемым доступом. Формула секции с управляемым доступом предназначена для ограничения числа редакторов, которые могут изменять информацию из полей такой секции. В зависимости от типа поля секции редактируемое/вычисляемое формула секции с управляемым доступом представляет собой формулу поля секции либо Default Value, либо просто Value. Рассмотреть синтаксис и описание функций @IsNewDoc (см. стр. 119), @Now (см. стр. 89) и @Created (см. стр. 115). Продемонстрировать форму EdSection. Самостоятельно создать новую форму и реализовать в ней секцию с управляемым доступом так, чтобы входящие в нее поля можно было редактировать в течении 5 дней после создания документа всем уполномоченным пользователям, а после этого срока – только пользователи, назначенные на роль [admin].
10.13.4Формула заголовка окна Продемонстрировать пример с формой Country в клиенте Notes и Web. Самостоятельно реализовать аналогичный пример.
10.13.5Формулы гиперобъектов и всплывающих окон Продемонстрировать пример с формой HotSpot+PopUp. Напомнить, что формула всплывающих окон должна возвращать текстовую строку. Самостоятельно реализовать аналогичный пример.
10.13.6Формулы формы вида/папки Рассказать про общий алгоритм определения формы для отображения в рамках Domino (сохраненная в документе форма -> формула формы -> поле Form -> свойство формы Default database form. Продемонстрировать пример с видом ViewWithFormFormula. Самостоятельно создать новый вид и реализовать в нем формулы формы в зависимости от роли пользователей.
10.13.7Формулы навигатора и области размещения Под формулами навигатора подразумеваются формулы обработчики события «клик» по объектам, входящим в навигатор (например, гиперобъект – прямоугольник). Под формулами области размещения, скорее всего, подразумевается формула обработчик события «клик» по графической кнопке области размещения. Продемонстрировать примеры с навигатором Main и формой Layout Region.
10.13.8Недокументированные контексты формул К сожалению в документах Where does this @function work? … не упоминаются некоторые контексты применения @-формул, которые отличаются от приведенных в документации. В частности, формулы вычисляемого текста, определения графического ресурса, строк аутлайна. Показать элементы дизайна. Сказать, что, например, в формулах вычисляемого текста не работает функция @Prompt.
10.14Новые функции и команды в R 6.5.1 по отношению к R 6.0.1 10.14.1Работа с Instant Messaging ϑ @GetIMContactListGroupNames Область применения: В DOMINO ДОКУМЕНТИРОВАНА.
R
6.5.1
НЕ
Возвращает список групповых имен из контактного листа службы Instant Messaging.
ϑ @Command( [ShowHideIMContactList] ) Область применения: В DOMINO ДОКУМЕНТИРОВАНА.
R
6.5.1
НЕ
Отображает/скрывает контактный список службы Instant Messaging.
ϑ @Command( [AddToIMContactList] ; имена ; группа ) Область применения: В DOMINO R 6.5.1 ДОКУМЕНТИРОВАНА.
НЕ
Добавляет в контактный лист службы Instant Messaging новых пользователей из второго параметра команды. Третий параметр необязательный. Если он опущен, то появляется диалоговое окно для определения группы, в которую следует добавить новых пользователей. Если параметр не опущен, то добавление идет без диалога. Если указанная группа отсутствует, то она создается при выполнении команды.
ϑ @Command( [SendInstantMessage] ; имена ) Область применения: В DOMINO R ДОКУМЕНТИРОВАНА.
6.5.1
НЕ
Открывает чат с указанными во втором параметре пользователями. Продемонстрировать пример с формой NewFunction.
10.14.2Остальные функции ϑ @TemplateVersion Область применения: ДОКУМЕНТИРОВАНА.
В
DOMINO
R
6.5.1
НЕ
Возвращает версию, в которой был подготовлен шаблон текущей БД. Из опыта, функция корректно работает только для БД, созданных на основании шаблонов, входящих в стандартную поставку. Для собственных шаблонов возвращает 1 как число, а не текст.
ϑ @ViewShowThisUnread( флаг ) Область применения: В DOMINO ДОКУМЕНТИРОВАНА.
R
6.5.1
НЕ
При значении флага равном "1" отображает только непрочтенные документы в виде/папке. При любом другом значении флага отображает все документы вида/папки. Продемонстрировать пример с видом AllDocs.
Изучение новых возможностей IBM Lotus Domino Designer 6, М.: Светотон, 2003., 248 стр.
3.
Н.Н. Ионцев, Е.В. Поляков, О.Г. Таранченко, Программирование в Lotus Domino R. 5: формулы и функции, язык LotusScript, встроенные классы LotusScript и Java, - М.: Светотон, 1999 г., 935 с.
4.
Поляков Е.В., Средства разработки приложений в Lotus Domino R5: Domino Designer. – М. Светотон, 2002., 468 стр.
5.
Карандин С., Колосов М., Поляков Е., Краткий справочник по разработке Web-приложений на платформе Lotus Domino R5. - М: Светотон, 2001., 336 стр.
6.
Н.Н. Ионцев, В.К. Кулаков, В.А. Панов, LotuNotes R. 4: разработка приложений, язык LotusScript, встроенные классы, М.: Научная книга, 1996 г., 575 с.
3.1 ПЕРЕМЕННЫЕ.................................................................................................. 6 3.1.1 ПОЛЯ.................................................................................................. 6 3.1.2 ПРЕДОПРЕДЕЛЕННЫЕ ПОЛЯ....................................................................... 8 3.1.3 ВРЕМЕННЫЕ ПЕРЕМЕННЫЕ........................................................................ 8 3.2 КОНСТАНТЫ.................................................................................................... 9 3.3 ОПЕРАТОРЫ ВЫПОЛНЕНИЯ ОПЕРАЦИЙ................................................................. 10 3.4 ПОРЯДОК ВЫПОЛНЕНИЯ ВЫЧИСЛЕНИЙ..................................................................14 3.5 КЛЮЧЕВЫЕ СЛОВА.......................................................................................... 14 3.6 ФУНКЦИИ...................................................................................................... 17 3.6.1 ПОБОЧНЫЕ ЭФФЕКТЫ............................................................................ 19 3.6.2 ОГРАНИЧЕНИЯ ПРИМЕНИМОСТИ @-ФУНКЦИЙ И КОМАНД, НАЛАГАЕМЫЕ СПИСКОМ УПРАВЛЕНИЯ ВЫПОЛНЕНИЕМ (ECL)......................................................... 20 3.6.3 ОГРАНИЧЕНИЯ ПРИМЕНИМОСТИ @-ФУНКЦИЙ И КОМАНД ДЛЯ WEB-ПРИЛОЖЕНИЙ 24 4 КАК ВЫПОЛНЯЮТСЯ ФОРМУЛЫ
29
4.1 ПОРЯДОК ВЫПОЛНЕНИЯ................................................................................... 29 4.2 ФОРМУЛЫ, ВОЗВРАЩАЮЩИЕ ЗНАЧЕНИЯ................................................................30 4.3 ФОРМУЛЫ, ВЫПОЛНЯЮЩИЕ ПОСЛЕДОВАТЕЛЬНОСТЬ ДЕЙСТВИЙ...................................31 4.4 ВЫПОЛНЕНИЕ ФОРМУЛ, СОДЕРЖАЩИХ ВЫЗОВЫ @-КОМАНД...................................... 32 5 ОБРАБОТКА ОШИБОК В ФОРМУЛАХ
35
6 ОПИСАНИЕ @-ФУНКЦИЙ DOMINO
38
6.1 ФУНКЦИИ - БАЗОВЫЕ КОНСТРУКЦИИ ЯЗЫКА ФОРМУЛ................................................ 38 6.2 ФУНКЦИИ ВЫПОЛНЕНИЯ ЦИКЛОВ......................................................................... 43
6.3 ФУНКЦИИ ОПРЕДЕЛЕНИЯ И ПРЕОБРАЗОВАНИЯ ТИПОВ ДАННЫХ................................... 48 6.4 ФУНКЦИИ ДЛЯ РАБОТЫ СО СТРОКАМИ.................................................................. 60 6.4.1 ОПРЕДЕЛЕНИЕ ВХОЖДЕНИЯ ПОДСТРОКИ В СТРОКУ........................................62 6.4.2 ВЫДЕЛЕНИЕ И ЗАМЕНА ЧАСТИ СТРОКИ....................................................... 67 6.5 ФУНКЦИИ ДЛЯ РАБОТЫ СО ЗНАЧЕНИЯМИ ТИПА "ДАТА-ВРЕМЯ".................................... 89 6.5.1 ФУНКЦИИ, РАБОТАЮЩИЕ С КОМПОНЕНТАМИ ЗНАЧЕНИЯ ТИПА "ДАТА-ВРЕМЯ"....... 94 6.6 ФУНКЦИИ ДЛЯ РАБОТЫ С ЧИСЛЕННЫМИ ЗНАЧЕНИЯМИ.............................................. 99 6.7 ФУНКЦИИ ДЛЯ РАБОТЫ СО СПИСКАМИ................................................................ 101 6.8 РАБОТА С ПЕРЕМЕННЫМИ ОКРУЖЕНИЯ............................................................... 111 6.9 УСТАНОВКА ЗНАЧЕНИЯ ВРЕМЕННОЙ ПЕРЕМЕННОЙ................................................. 114 6.10 ФУНКЦИИ ДЛЯ РАБОТЫ С ТЕКУЩИМ ДОКУМЕНТОМ.............................................. 114 6.10.1 ОПРЕДЕЛЕНИЯ СВОЙСТВ, ХАРАКТЕРИСТИК И СОСТОЯНИЯ ТЕКУЩЕГО ДОКУМЕНТА ..................................................................................................... 115 6.10.2 ОПЕРАЦИИ С ПОЛЯМИ....................................................................... 124 6.10.3 ОПЕРАЦИИ С ДОКУМЕНТОМ................................................................. 128 6.11 ФУНКЦИИ ДЛЯ РАБОТЫ С ПАРОЛЯМИ.............................................................. 136 6.12 ФУНКЦИИ ДЛЯ РАБОТЫ С ПОЧТОЙ.................................................................. 138 6.12.1 ФУНКЦИИ, ОПРЕДЕЛЯЮЩИЕ ПОЧТОВЫЕ НАСТРОЙКИ.................................. 143 6.13 РАБОТА С ИДЕНТИФИКАТОРАМИ ДОКУМЕНТОВ................................................... 146 6.14 ПОЛУЧЕНИЕ ИНФОРМАЦИИ ИЗ БАЗ ДАННЫХ DOMINO...........................................150 6.14.1 @DBCOLUMN - ВЫБОР ЗНАЧЕНИЙ ИЗ КОЛОНКИ.......................................150 6.14.2 @DBLOOKUP - ВЫБОР ИЗ КОЛОНКИ ИЛИ ПОЛЯ ЗНАЧЕНИЙ ПО КЛЮЧУ............155 6.15 ПОЛУЧЕНИЕ ИНФОРМАЦИИ ИЗ БАЗ ДАННЫХ, ПОДДЕРЖИВАЮЩИХ ODBC-ДРАЙВЕРЫ..158 6.16 ФУНКЦИИ ДЛЯ РАБОТЫ С ВИДАМИ.................................................................. 167 6.16.1 ФУНКЦИИ, ИСПОЛЬЗУЕМЫЕ В ФОРМУЛАХ ОТБОРА ДОКУМЕНТОВ.................... 170 6.16.2 ФУНКЦИИ, ИСПОЛЬЗУЕМЫЕ В ФОРМУЛАХ КОЛОНОК....................................172 6.17 ФУНКЦИИ, РАБОТАЮЩИЕ С ИМЕНАМИ ПОЛЬЗОВАТЕЛЕЙ....................................... 176 6.18 ФУНКЦИИ, РАБОТАЮЩИЕ С ПРАВАМИ ДОСТУПА................................................. 182 6.19 ФУНКЦИИ, РАБОТАЮЩИЕ С ПРОФИЛЬНЫМИ ДОКУМЕНТАМИ................................... 191 6.20 ФУНКЦИЯ ВЫБОРА ТРЕБУЕМОГО ФРЕЙМА......................................................... 193
6.21 ДИАЛОГ С ПОЛЬЗОВАТЕЛЕМ........................................................................... 194 6.22 ФУНКЦИИ, ОПРЕДЕЛЯЮЩИЕ ТИП И ХАРАКТЕРИСТИКИ ИСПОЛЬЗУЕМОГО ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ............................................................................................216 6.23 ФУНКЦИИ, ИСПОЛЬЗУЕМЫЕ В WEB-ПРИЛОЖЕНИЯХ............................................ 222 6.24 ИНФОРМАЦИОННЫЕ ФУНКЦИИ........................................................................ 228 6.25 ФУНКЦИИ ДЛЯ ОБРАБОТКИ ОШИБОК................................................................. 233 7 ОПИСАНИЕ @-КОМАНД DOMINO
239
7.1 КОМАНДЫ ДЛЯ РАБОТЫ С ТЕКУЩИМ И ВЫДЕЛЕННЫМИ ДОКУМЕНТАМИ.........................239 7.2 КОМАНДЫ ОТКРЫТИЯ ОБЪЕКТОВ....................................................................... 256 7.3 КОМАНДЫ ДЛЯ РАБОТЫ С ПРОФИЛЬНЫМИ ДОКУМЕНТАМИ........................................ 264 7.4 КОМАНДЫ ОБНОВЛЕНИЯ ОТОБРАЖАЕМОЙ ИНФОРМАЦИИ..........................................265 7.5 КОМАНДЫ ДЛЯ РАБОТЫ С ВИДАМИ И ПАПКАМИ..................................................... 268 7.6 КОМАНДЫ ЗАПУСКА ПРИЛОЖЕНИЙ..................................................................... 271 7.7 КОМАНДЫ ДЛЯ РАБОТЫ С ПОЧТОЙ.................................................................... 272 8 АЛФАВИТНЫЙ СПИСОК @-ФУНКЦИЙ
275
9 АЛФАВИТНЫЙ СПИСОК @-КОМАНД
315
10 РАЗРАБОТКА ТЕСТОВЫХ ПРИЛОЖЕНИЙ
393
10.1 ПРОСТЫЕ ОПЕРАЦИИ С ДОКУМЕНТАМИ............................................................. 393 10.1.1 СОЗДАНИЕ НОВОГО ДОКУМЕНТА ПО ФОРМЕ............................................. 393 10.1.2 РЕДАКТИРОВАНИЕ ТЕКУЩЕГО ДОКУМЕНТА............................................... 393 10.1.3 УДАЛЕНИЕ ДОКУМЕНТА....................................................................... 394 10.1.4 ПЕЧАТЬ ДОКУМЕНТА И ВИДА................................................................ 394 10.1.5 УПРАЖНЕНИЕ.................................................................................. 395 10.2 ФОРМУЛЫ ПОЛЕЙ....................................................................................... 395 10.2.1 УПРАЖНЕНИЕ.................................................................................. 396 10.3 ПОЛУЧЕНИЯ ДОСТУПА К ДАННЫМ, НАХОДЯЩИМСЯ ВНЕ ТЕКУЩЕГО ДОКУМЕНТА........... 397 10.3.1 ДОСТУП К ДАННЫМ ВИДА.................................................................... 397 10.3.2 НАСЛЕДОВАНИЕ............................................................................... 397
10.3.3 УПРАЖНЕНИЕ.................................................................................. 398 10.3.4 РАБОТА С ПРОФИЛЬНЫМИ ДОКУМЕНТАМИ............................................... 398 10.3.5 УПРАЖНЕНИЕ.................................................................................. 398 10.3.6 РАБОТА С ПЕРЕМЕННЫМИ ОКРУЖЕНИЯ.................................................. 398 10.3.7 УПРАЖНЕНИЕ.................................................................................. 398 10.4 ДИАЛОГ С ПОЛЬЗОВАТЕЛЕМ........................................................................... 398 10.4.1 ФУНКЦИЯ @PROMPT........................................................................ 398 10.4.2 ФУНКЦИЯ @DIALOGBOX................................................................... 399 10.4.3 ФУНКЦИЯ @PICKLIST.......................................................................399 10.5 ФОРМУЛЫ СКРЫТИЯ ИНФОРМАЦИИ.................................................................. 399 10.5.1 ФОРМУЛЫ СКРЫТИЯ АБЗАЦА ФОРМЫ..................................................... 399 10.5.2 ФОРМУЛЫ СКРЫТИЯ АКЦИЙ ФОРМЫ И ВИДА............................................ 400 10.5.3 ФОРМУЛЫ СКРЫТИЯ СТОЛБЦОВ ВИДА И СТРОК АУТЛАЙНА........................... 400 10.5.4 УПРАЖНЕНИЕ.................................................................................. 400 10.6 ФОРМУЛЫ РАБОТЫ С ВИДАМИ........................................................................ 400 10.6.1 ФОРМУЛА ОТБОРА ДОКУМЕНТОВ........................................................... 400 10.6.2 ФОРМУЛЫ СТОЛБЦОВ ВИДА................................................................. 401 10.6.3 НАЛОЖЕНИЯ ФИЛЬТРА НА ВИД............................................................. 405 10.7 РАБОТА С ПОЧТОЙ...................................................................................... 405 10.8 РАБОТА С ИМЕНАМИ ПОЛЬЗОВАТЕЛЕЙ.............................................................. 405 10.9 РАБОТА С УРОВНЯМИ ДОСТУПА...................................................................... 405 10.10 БЛОКИРОВКА ДОКУМЕНТОВ НА РЕДАКТИРОВАНИЕ.............................................. 406 10.11 ОПЕРАЦИИ С ПАПКАМИ.............................................................................. 406 10.12 ФУНКЦИИ, ИСПОЛЬЗУЕМЫЕ В WEB-ПРИЛОЖЕНИЯХ........................................... 406 10.13 ФОРМУЛЫ ПО МЕСТУ ПРИМЕНЕНИЯ............................................................... 406 10.13.1 ФОРМУЛЫ ПАНЕЛИ ИНСТРУМЕНТОВ - TOOLBAR BUTTON........................... 407 10.13.2 ФОРМУЛЫ АГЕНТОВ.........................................................................407 10.13.3 ФОРМУЛА СЕКЦИИ С УПРАВЛЯЕМЫМ ДОСТУПОМ..................................... 407 10.13.4 ФОРМУЛА ЗАГОЛОВКА ОКНА...............................................................407 10.13.5 ФОРМУЛЫ ГИПЕРОБЪЕКТОВ И ВСПЛЫВАЮЩИХ ОКОН................................408
10.13.6 ФОРМУЛЫ ФОРМЫ ВИДА/ПАПКИ.......................................................... 408 10.13.7 ФОРМУЛЫ НАВИГАТОРА И ОБЛАСТИ РАЗМЕЩЕНИЯ...................................408 10.13.8 НЕДОКУМЕНТИРОВАННЫЕ КОНТЕКСТЫ ФОРМУЛ.......................................408 10.14 НОВЫЕ ФУНКЦИИ И КОМАНДЫ В R 6.5.1 ПО ОТНОШЕНИЮ К R 6.0.1.................. 409 10.14.1 РАБОТА С INSTANT MESSAGING......................................................... 409 10.14.2 ОСТАЛЬНЫЕ ФУНКЦИИ .................................................................... 410 11 ЛИТЕРАТУРА