Ниже рассматривается таблица часто используемых свойств и методов этих двух классов:
Таблица 1 Классы NotesUIWorkspace
| NotesUIWorkspace | ||
| Свойства | Описание | |
| CurrentCalendarDateTime | Возвращает значение типа Date. Когда вы в представлении календарного типа стоите в одной из ячеек, представляющей определенный день, и вызовете этот метод, то получаете дату этого дня. | |
| CurrentDatabase | Текущая база данных, открытая в рабочей области. Возвращает объект типа notesUIDatabase | |
| CurrentDocument | Открытый в рабочей области документ. Возвращает объект типа NotesUIDocument. Надо понимать, что если не открыт никакой документ, то вернет Nothing | |
| CurrentView | Открытое в рабочей области представление. Тип объекта notesUIView. Если не открыто никакого представления, вернется «nothing» | |
| Методы | Описание | |
| AddDatabase(server$, filename$) | Открывает в рабочей области базу на указанном сервере и с указанным путем к базе. В рабочей области подсвечивается иконка базы. | |
| CheckAlarms() | В почтовом файле пользователя находится информация о различных события - встречах, задачах и пр. Клиент запускает периодически задачу, которая называется alarm-daemon, которая выдает различные предупреждения о наступлении события, согласно настройкам. Этот метод запускает этот alarm-daemon, который проверяет почтовый ящик текущего пользователя на предмет необходимости выдачи окошка с предупреждениями. | |
| ComposeDocument | Set notesUIDocument = notesUIWorkspace.ComposeDocument([server$ [, file$ [, form$ [, windowWidth# [, windowHeight# ]]]]]) Этот метод позволяет программно открыть в рабочей области новый документ по форме, которая указывается в качестве параметра, и находится в соответствующей базе, на соответствующем сервере. Можно задать также размеры окна. Если база лежит локально, то всегда во всех методах, которые используют сервер, для обозначения локальности базы используется пустая строка "". При создании документа этим методом выполняются все события формы -QueryOpen, PostOpen. Пример: set uidoc = ws.composeDocument("","sf.nsf","SF",640,480) Если вы используете метод в кнопке, которая лежит представлении, в котором в Form formula написана другая форма, то документ создастся по форме указанной в form formula, чтобы этого избежать, можно модифицировать form formula: @if(@isnewdoc;return(form);"ViewPrefferedForm") | |
| Dialog Box | flag = notesUIWorkspace.DialogBox(form$ [, autoHorzFit [, autoVertFit [, noCancel [, noNewFields [, noFieldUpdate [, readOnly [, title$ [, notesDocument [, sizeToTable [, noOkCancel ]]]]]]]]]]) Этот метод открывает переданный ему notesDocument по указанной форме. При этом задается масса параметров отображения этого окна. Если форма имеет поля ввода, и пользователь что-то вносит в этот документ, то вся внесенная информация доступна в notesDocument в полях, соответствующих именам полей формы. Можно открыть существующий документ, который открыт в рабочей области, можно создать промежуточный документ, в котором сохранить результаты диалога, и потом использовать их в коде, как потребуется. | |
| EditDocument | Set notesUIDocument = notesUIWorkspace.EditDocument([editMode [, notesDocument [, notesDocumentReadOnly [, documentanchor$ ]]]]) Этот метод открывает в рабочей области переданный ему notesDocument. Указывается режим - чтение или редактирование. Опциональные параметры - это запрещение пользователю потом переключить документ из чтения в редактирование. Последним параметром автор не пользовался, поэтому описать, как он действует в реальности, не может. | |
| EditProfile | Set notesUIDocument = notesUIWorkspace.EditProfile(profileName$ [, userName$]) Этот метод открывает на редактирование существующий или создает новый профильный документ с этим именем или именем формы для текущего пользователя. Профиль может быть один для всех пользователей. | |
| EnableAlarms | flag = notesUIWorkspace.EnableAlarms(True/False) - включает/выключает alarm-daemon | |
| Folder | Отображает диалог перемещения в папку текущего документа | |
| New | Рождает новый экземпляр класса dim ws as new NotesUIWorkspace | |
| OpenDatabase | Call notesUIWorkspace.OpenDatabase(server$, file$, view$, key$, newInstance, temp) Открывает базу данных, указанное представление, в рабочей области, может открыть в новом окне, может не добавлять иконку на рабочий стол. | |
| OpenFileDialog | Открывает диалог выбора файла, можно выбрать несколько файлов, возвращает список имен выбранных файлов. | |
| OpenFrameSet | Call notesUIWorkspace.OpenFrameSet(frameset$) Открывает указанный по имени фрэймсет | |
| OpenPage | Call notesUIWorkspace.OpenPage(pagename$) Открывает указанную страницу в рабочей области | |
| PickListCollection PickListStrings | Эти методы выдают окно диалога, для выбора значений из представления. Возможен выбор из определенной категории. Первый метод возвращает объект NotesDocumentCollection - коллекцию документов, второй - массив строк из указанного столбца представления. | |
| Prompt | variant = notesUIWorkspace.Prompt(type%, title$, prompt$, [default ] [, values ]) Выдает диалоговое окно, тип которого задается первым параметром и позволяет вводить, выбирать значения из списка и пр. | |
| ReloadWindow | Заново загружает содержимое текущего окна | |
| RefreshView | Обновляет текущее представление. | |
Таблица 2. Классы NotesSession
| NotesSession | |
| Свойство | Описание |
| Ad dress Books | Все известные адресные книги |
| CommonUserName | Имя текущего пользователя в формате First Middle Last |
| CurrentAgent | Текущий агент, объект типа NotesAgent |
| CurrentDatabase | Текущая база данных, объект типа NotesDatabase |
| DocumentContext | Текущий документ, находящийся в памяти в момент старта агента, тип notesDocument |
| EffectiveUserName | Имя пользователя от имени, которого запущен агент |