NotesUIDocument
Properties
| Name | Description |
|---|---|
| AutoReload | Read-write. Indicates whether or not the current document should be refreshed whenever the corresponding back-end document changes. Refreshing the… |
| CurrentField | Read-only. The name of the field where the cursor is. |
| DialogBoxCanceled | Read-only. Indicates whether a user cancels a dialog. |
| Document (NotesUIDocument) | Read-only. The back-end document that corresponds to the currently open document. |
| EditMode | Read-write. Indicates whether a document is in Edit mode. |
| FieldHelp | Read-write. Indicates whether field Help for a document is displayed. |
| HiddenChars | Read-write. Indicates whether the hidden characters in a document (such as tabs and carriage returns) are displayed. |
| HorzScrollBar | Read-write. Indicates whether the horizontal scroll bar on a document is displayed. |
| InPreviewPane | Read-only. Indicates whether the document is being accessed from the preview pane. |
| IsNewDoc | Read-only. Indicates whether a document is new. A new document is one that hasn't been saved. |
| ModifiedSinceSaved | Read-only. Indicates whether a document contains unsaved changes. |
| PreviewDocLink | Read-write. Indicates whether the preview pane for a link is displayed. |
| PreviewParentDoc | Read-write. Indicates whether the parent document preview pane is displayed. |
| Ruler | Read-write. Indicates whether the ruler is displayed. |
| WindowTitle | Read-only. The window title of a document. |
Methods
| Name | Description |
|---|---|
| Categorize | Given the name of a category, places a document in the category. |
| Clear (NotesUIDocument) | Deletes the current selection from a document. The current selection can be anything in an editable field, such as text or graphics. |
| Close (NotesUIDocument) | Closes a document. |
| CollapseAllSections | Collapses all the sections in a document. |
| Copy | Copies the current selection in a document to the Clipboard. The current selection can be anything on the document, such as text or graphics. |
| CreateObject | In a document in Edit mode, creates an OLE object in the current rich-text field. |
| Cut | Cuts the current selection from a document and places it on the Clipboard. The current selection can be anything in an editable field, such as text or… |
| DeleteDocument (NotesUIDocument) | Marks the current document for deletion and closes it. The NotesUIDocument object is no longer available once you call this method. |
| DeselectAll (NotesUIDocument) | Deselects any selections in a document. |
| ExpandAllSections | Expands all the sections in a document. |
| FieldAppendText | Appends a text value into a field in a document without removing the existing contents of the field. |
| FieldClear | Clears the contents of a field in a document. |
| FieldContains | In an open document, checks if a field contains a specific text value. |
| FieldGetText | In a document in read or Edit mode, returns the contents of a field you specify, as a string. If the field is of type numbers or date-time, its contents… |
| FieldSetText | Sets the value of a field in a document. The existing contents of the field, if any, are written over. |
| FindFreeTimeDialog | Brings up a "Free Time" dialog box based on the current document. |
| FindFreeTimeDialogEx | Brings up a "Free Time" dialog box based on the current document. |
| FindString | Finds the text in any field in a given document. |
| Forward | Creates a new mail memo with the contents of a document. The user can enter recipients and mail the forwarded document like any other mail memo. |
| GetObject | Given a name, returns a handle to the OLE object of that name. |
| GetSchedulerObject | Returns an embedded scheduler. |
| GetSelectedText | Gets the text that is highlighted in the UI. |
| GotoBottom | Places the cursor in the last editable field or the last button in a document. |
| GotoField | Given a field name, puts the cursor in the specified field in a document. |
| GotoNextField | Places the cursor in the next field in a document. The next field is the one below and following the current field. |
| GotoPrevField | Places the cursor in the previous field in a document. |
| GotoTop | Places the cursor in the first editable field or the first button in a document. |
| Import (NotesUIDocument) | Imports a file. |
| InsertText | Inserts a text value at the current cursor position on a document. |
| NavBarSetText | Sets the text for the address bar of the Notes® client if the browser setting is "Notes® with Internet Explorer." |
| NavBarSpinnerStart | Starts the URL navigation bar spinner for an Internet Explorer browser. |
| NavBarSpinnerStop | Stops the navigation bar spinner for an Internet Explorer browser. |
| Paste | Pastes the contents of the Clipboard at the current cursor position on a document. |
| Print (NotesUIDocument) | Prints the current document: |
| Refresh (NotesUIDocument) | Refreshes a document. When you refresh a document, its computed fields are recalculated. |
| RefreshHideFormulas | Recalculates the hide-when formulas on the current document form. |
| Reload | Refreshes the current document with any changes made to the back-end document associated with the current editing session. |
| Save (NotesUIDocument) | Saves a document. |
| SaveNewVersion | Saves a copy of a document as a new version. |
| SelectAll | In a document in Edit mode, selects the entire contents of the current field. In a document in Read mode, selects the entire contents of the document. |
| Send (NotesUIDocument) | Mails a document. |
| SpellCheck | Checks the spelling of a UI document. |
Examples
| Name | Description |
|---|---|
| Examples: Clear method (NotesUIDocument) | This script deletes the contents of the current field. If the current field is empty, it does nothing. |
| Examples: Close method (NotesUIDocument) | This button script closes the current document. |
| Examples: DeleteDocument method (NotesUIDocument) | 1. This script closes the current document and marks it for deletion. If the document is in Edit mode, however, the script does nothing. |
| Examples: DeselectAll method (NotesUIDocument) | This button script deselects the current selection before pasting the contents of the Clipboard into the current field. |
| Examples: Document Property | This form action script places the current document and its immediate responses into the Interesting folder. It uses the PutInFolder method in… |
| Examples: Import method (NotesUIDocument) | 1. This form action imports a file into the Body field of the current UI document. The user selects the file and type. |
| Examples: OnFocus event (NotesUIDocument) | Examples: OnFocus event (NotesUIDocument - LotusScript) — HCL Domino Designer 14.5.1 reference. |
| Examples: QueryRecalc event (NotesUIDocument) | This QueryRecalc event verifies that the user wants to refresh. |
| Examples: Refresh method (NotesUIDocument) | This script refreshes the current document whenever the user moves the cursor out of a particular field. |
| Examples: Save method (NotesUIDocument) | This script saves the current document. The document must be in edit mode to be saved using this method. |
| Examples: Send method (NotesUIDocument) | This script sets the contents of the SendTo field based on the contents of the Status field, and then mails the document. Before the document is saved,… |
Reference
| Name | Description |
|---|---|
| OnBlur (NotesUIDocument) | Occurs when the subwindow displaying the document receives a loss-of-focus notification. |
| OnFocus (NotesUIDocument) | Occurs when the subwindow displaying the document receives a focus notification. |
| OnHelp | Occurs after the user chooses Help or presses F1. |
| OnLoad | Occurs after the current document is opened, but before the user has input focus. |
| OnSize | Occurs when document window is resized. |
| OnSubmit | Occurs just before the current document is saved. |
| OnUnload | Occurs just before the current document is closed. |
| PostModeChange | Occurs after the document has changed modes (from Read to Edit mode, or from Edit to Read mode) but before the user has been given input focus. |
| PostOpen (NotesUIDocument) | Occurs after the current document is opened, but before the user has input focus. |
| PostRecalc | Occurs just after the current document is recalculated (after all the formulas on the document form have executed). |
| PostSave | Occurs just after the current document is saved. |
| PostSend | Occurs just after the current document is sent (mailed). |
| QueryClose (NotesUIDocument) | Occurs just before the current document is closed. |
| QueryModeChange | Occurs just before the current document changes modes (from Read to Edit mode, or from Edit to Read mode). |
| QueryOpen (NotesUIDocument) | Occurs just before the current document is opened. |
| QueryRecalc (NotesUIDocument) | Occurs just before the current document is recalculated (before all the formulas on the document execute). |
| QuerySave | Occurs just before the current document is saved. |
| QuerySend | Occurs just before the current document is sent (mailed). |