Home
HCL Domino Designer User Guide and Reference
This guide provides information on using HCL Domino Designer and programming language reference information.
LotusScript/COM/OLE Classes
LotusScript® Classes A-Z
This documentation lists each class, property, and method in the Domino® class library. Each class is followed by an alphabetical listing of the properties for that class and an alphabetical listing of the methods for that class. To find the property or method you want, turn to the class to which the property or method belongs.
NotesUIDocument (LotusScript®)
Represents the document that's currently open in the Notes® workspace.
FieldHelp (NotesUIDocument - LotusScript®)
Read-write. Indicates whether field Help for a document is displayed.
Examples: FieldHelp property
This script turns field help on.

HCL Domino Designer User Guide and Reference
This guide provides information on using HCL Domino Designer and programming language reference information.
- What's new in Domino Designer 14?
  The following features are new for developers in HCL Domino® Designer 14.
- What's new in Nomad Designer?
  HCL Nomad for web browsers v1.0.10 introduces the capability to design Notes databases. For more information, see HCL Nomad for web browsers User Documentation, Nomad web Designer.
- Accessibility and keyboard shortcuts
  Accessibility features assist users who have a disability, such as restricted mobility or limited vision, to use information technology content successfully.
- Application Design
  Welcome to the Application Design section of Domino® Designer Help.
- Application Management
  Welcome to the Application Management section of Domino® Designer Help.
- Domino® Query Language
  Domino® Query Language (DQL) is a facility running on a Domino server that provides a terse, shorthand syntax for finding documents. It supports a wide variety and complexity of search terms. It leverages existing design elements, avoiding the need to write detailed code to access them. DQL consolidates all methods in Domino for searching document contents.
- Composite Applications - Design and Management
  Composite applications are a key element in a service-oriented architecture (SOA) and contextual collaboration strategy. The ability to create and edit composite applications lets you easily integrate different types of components and technologies.
- DB2® Access views
  Domino® Designer includes two types of design elements to assist you in managing data contained in DB2® enabled Notes® databases:
- Programming Overview and User Interface
  This section contains general guidelines and examples that show where to use Java, LotusScript, and the formula language.
- Formula Language
  This section documents the formula language.
- LotusScript® Language
  Welcome to the LotusScript® Language section of Domino® Designer Help.
- LotusScript/COM/OLE Classes
  - LotusScript® Classes Coding Guidelines
    The following topics cover some general guidelines for writing LotusScript® code using Domino® objects:
  - LotusScript® Classes A-Z
    This documentation lists each class, property, and method in the Domino® class library. Each class is followed by an alphabetical listing of the properties for that class and an alphabetical listing of the methods for that class. To find the property or method you want, turn to the class to which the property or method belongs.
    - Properties and methods with ECL security
      The following tables list the properties and methods affected by an Execution Control List (ECL). These properties cannot be accessed or set, and these methods do not execute on the workstation, unless the marked ECL privileges are granted to the signer of the formula.
    - LotusScript® constants
      The following sections provide contextual information for the constants used by the LotusScript® classes. Listed are the constant names, their integer values (in parentheses), and the properties and methods in which they are used.
    - Button (LotusScript®)
      Represents an action, action hotspot, or button on a form or document.
    - Field (LotusScript®)
      Represents a field on a form.
    - Navigator (LotusScript®)
      Represents a navigator button, hotspot, or other navigator object.
    - NotesACL (LotusScript®)
      Represents the access control list (ACL) of a database.
    - NotesACLEntry (LotusScript®)
      Represents a single entry in an access control list. An entry may be for a person, a group, or a server.
    - NotesAdministrationProcess (LotusScript®)
      Represents the administration process.
    - NotesAgent (LotusScript®)
      Represents an agent. The agent may be shared or private, and may be a Release 3 macro.
    - NotesCalendar (LotusScript)
      Represents a Domino® calendar.
    - NotesCalendarEntry (LotusScript)
      Represents a Domino® calendar entry.
    - NotesCalendarNotice (LotusScript)
      Represents a Domino® calendar notice.
    - NotesColorObject (LotusScript®)
      Represents a color.
    - NotesDatabase (LotusScript®)
      Represents a Notes® database.
    - NotesDateRange (LotusScript®)
      Represents a range of dates and times.
    - NotesDateTime (LotusScript®)
      Represents a date and time. Provides a means of translating between the LotusScript® date-time format and the Domino® format.
    - NotesDbDirectory (LotusScript®)
      Represents the Notes® databases on a specific server or local computer.
    - NotesDirectory (LotusScript®)
      Represents the Notes® directories on a specific server or local computer, each of which is associated with one or more directory navigators to allow directory lookups.
    - NotesDirectoryNavigator (LotusScript®)
      Allows lookups of a specific associated Notes® directory on a specific server or local computer.
    - NotesDocument (LotusScript®)
      Represents a document in a database.
    - NotesDocumentCollection (LotusScript®)
      Represents a collection of documents from a database, selected according to specific criteria.
    - NotesDominoQuery (LotusScript®)
      LotusScript® class to compile, tune, and run Domino® Query Language queries.
    - NotesDOMAttributeNode (LotusScript®)
      Represents an attribute in a NotesDOMElementNode object.
    - NotesDOMCDATASectionNode (LotusScript®)
      Represents a CDATA section in the XML data source.
    - NotesDOMCharacterDataNode (LotusScript®)
      Represents character data in a DOM node.
    - NotesDOMCommentNode (LotusScript®)
      Represents a comment in the XML.
    - NotesDOMDocumentFragmentNode (LotusScript®)
      Represents a document fragment in the XML.
    - NotesDOMDocumentNode (LotusScript®)
      Represents the entire XML document. The root of the document tree.
    - NotesDOMDocumentTypeNode (LotusScript®)
      The list of entities that are defined for the document.
    - NotesDOMElementNode (LotusScript®)
      Represents an element in an XML document.
    - NotesDOMEntityNode (LotusScript®)
      Represents an entity node in the XML.
    - NotesDOMEntityReferenceNode (LotusScript®)
      Represents an entity reference node in the XML.
    - NotesDOMNamedNodeMap (LotusScript®)
      Used by methods of the NotesDOMNode class for returning the list of an element node's attributes.
    - NotesDOMNode (LotusScript®)
      Represents a single node in the document tree.
    - NotesDOMNodeList (LotusScript®)
      Used by methods of the NotesDOMNode class for returning the list of an element node's child elements.
    - NotesDOMNotationNode (LotusScript®)
      Represents a notation declared in the DTD.
    - NotesDOMParser (LotusScript®)
      Processes input XML into a standard DOM (Document Object Model) tree structure.
    - NotesDOMProcessingInstructionNode (LotusScript®)
      Represents a processing instruction, used in XML as a way to keep processor-specific information in the text of the document.
    - NotesDOMTextNode (LotusScript®)
      Represents the textual content of an element or attribute.
    - NotesDOMXMLDeclNode (LotusScript®)
      The XML declaration which specifies the version of XML being used.
    - NotesDXLExporter (LotusScript®)
      Represents the conversion of Domino® data to DXL (Domino XML).
    - NotesDXLImporter (LotusScript®)
      Represents the conversion of DXL (Domino® XML) to Domino data.
    - NotesEmbeddedObject (LotusScript®)
      Represents any one of the following:
    - NotesForm (LotusScript®)
      Represents a form in a database.
    - NotesGPS (LotusScript)
      Provides access to user location for supported platforms. Supported for HCL Nomad on iOS and Android V1.0.4 and higher. Supported for HCL Nomad for web browsers V1.0.3 and higher.
    - NotesGPSPosition (LotusScript)
      Represents a position provided by the global positioning device on a platform. Currently supported for HCL Nomad beginning with Release 1.0.4.
    - NotesGPSCoordinates (LotusScript)
      Contains the current coordinates of the position of a device. Currently supported for HCL Nomad beginning with Release 1.0.4.
    - NotesHTTPRequest (LotusScript)
      LotusScript class used to make HTTP requests to web servers.
    - NotesIDVault (LotusScript®)
      The NotesIDVault class is a representation of the secure storage facility for UserIDs that may be configured for Domino by policy. IDs are stored there to allow for easier management by administrators and users. IDs from more than one server may be stored within an IDVault. The NotesIDVault class provides methods to access UserID files, UserID objects, query the presence of an ID in the vault, sycnronise copies of IDs, and reset passwords. The NotesIDVault class can be used to access UserID objects or files. These can be used to accomplish the encryption or decryption of Documents while running on the server .
    - NotesInternational (LotusScript®)
      Represents the international settings in the operating environment, for example, the Windows™ Control Panel international settings. When any of these settings is changed in the operating environment, Domino® recognizes the new settings immediately.
    - NotesItem (LotusScript®)
      Represents a specific piece of data in a document.
    - NotesJSONArray (LotusScript)
      Represents a JSON array.
    - NotesJSONElement (LotusScript)
      Represents a name, value pair in a JSON string.
    - NotesJSONNavigator (LotusScript)
      LotusScript class used to parse JSON data.
    - NotesJSONObject (LotusScript)
      Represents a JSON object.
    - NotesLog (LotusScript®)
      Enables you to record actions and errors that take place during a script's execution. You can record actions and errors in:
    - NotesMIMEEntity (LotusScript®)
      Represents the MIME (Multipurpose Internet Mail Extensions) content of a document.
    - NotesMIMEHeader (LotusScript®)
      Represents a header in a MIME (Multipurpose Internet Mail Extensions) document.
    - NotesName (LotusScript®)
      Represents a name.
    - NotesNewsletter (LotusScript®)
      A document or set of documents that contain information from, or links to, several other documents.
    - NotesNoteCollection (LotusScript®)
      Represents a collection of Domino® design and data elements in a database.
    - NotesOutline (LotusScript®)
      Represents an outline in a database.
    - NotesOutlineEntry (LotusScript®)
      Represents an entry within an outline. For a detailed explanation of outline and outline entry, see Application Development with Domino® Designer.
    - NotesProperty (LotusScript®)
      Represents a single property in the Composite Applications properties of a Domino® application. Properties are data transmitted to or from the Property Broker, which routes your application's communication with other components in a composite application. Properties are defined in a Wiring Properties design element.
    - NotesPropertyBroker (LotusScript®)
      Mediates communication between components of a composite application, allowing communication between multiple Notes® components, or between Notes and Java™ components.
    - NotesQueryResultsProcessor (LotusScript)
      Aggregates, computes, sorts, and formats collections of Documents.
    - NotesRegistration (LotusScript®)
      Represents the creation or administration of an ID file.
    - NotesReplication (LotusScript®)
      Represents the replication settings of a database.
    - NotesReplicationEntry (LotusScript®)
      Represents the replication settings for a pair of servers in a database.
    - NotesRichTextDocLink (LotusScript®)
      Represents a doclink in a rich text item.
    - NotesRichTextItem (LotusScript®)
      Represents an item of type rich text.
    - NotesRichTextNavigator (LotusScript®)
      Represents a means of navigation in a rich text item.
    - NotesRichTextParagraphStyle (LotusScript®)
      Represents rich text paragraph attributes.
    - NotesRichTextRange (LotusScript®)
      Represents a range of elements in a rich text item.
    - NotesRichTextSection (LotusScript®)
      Represents a collapsible section in a rich text item.
    - NotesRichTextStyle (LotusScript®)
      Represents rich text attributes.
    - NotesRichTextTab (LotusScript®)
      Represents rich text tab attributes.
    - NotesRichTextTable (LotusScript®)
      Represents a table in a rich text item.
    - NotesSAXAttributeList (LotusScript®)
    - NotesSAXException (LotusScript®)
    - NotesSAXParser (LotusScript®)
      Processes input XML as a series of events using a SAX (Simple API for XML) parser.
    - NotesSession (LotusScript®)
      Represents the environment of the current script, providing access to environment variables, Address Books, information about the current user, and information about the current Notes® platform and release number.
    - NotesStream (LotusScript®)
      Represents a stream of binary or character data.
    - NotesTimer (LotusScript®)
      Represents a mechanism for triggering an event every fixed number of seconds.
    - NotesUIDatabase (LotusScript®)
      Represents the database that's currently open in the Notes® workspace.
    - NotesUIDocument (LotusScript®)
      Represents the document that's currently open in the Notes® workspace.
      - Examples: NotesUIDocument class
        This script uses a NotesUIWorkspace to get the current document. It then uses the FieldGetText method to print the Subject field of the current document.
      - OnBlur (NotesUIDocument - LotusScript®)
        Occurs when the subwindow displaying the document receives a loss-of-focus notification.
      - OnFocus (NotesUIDocument - LotusScript®)
        Occurs when the subwindow displaying the document receives a focus notification.
      - OnHelp (NotesUIDocument - LotusScript®)
        Occurs after the user chooses Help or presses F1.
      - OnLoad (NotesUIDocument - LotusScript®)
        Occurs after the current document is opened, but before the user has input focus.
      - OnSize (NotesUIDocument - LotusScript®)
        Occurs when document window is resized.
      - OnSubmit (NotesUIDocument - LotusScript®)
        Occurs just before the current document is saved.
      - OnUnload (NotesUIDocument - LotusScript®)
        Occurs just before the current document is closed.
      - PostModeChange (NotesUIDocument - LotusScript®)
        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 - LotusScript®)
        Occurs after the current document is opened, but before the user has input focus.
      - PostRecalc (NotesUIDocument - LotusScript®)
        Occurs just after the current document is recalculated (after all the formulas on the document form have executed).
      - PostSave (NotesUIDocument - LotusScript®)
        Occurs just after the current document is saved.
      - PostSend (NotesUIDocument - LotusScript®)
        Occurs just after the current document is sent (mailed).
      - QueryClose (NotesUIDocument - LotusScript®)
        Occurs just before the current document is closed.
      - QueryModeChange (NotesUIDocument - LotusScript®)
        Occurs just before the current document changes modes (from Read to Edit mode, or from Edit to Read mode).
      - QueryOpen (NotesUIDocument - LotusScript®)
        Occurs just before the current document is opened.
      - QueryRecalc (NotesUIDocument - LotusScript®)
        Occurs just before the current document is recalculated (before all the formulas on the document execute).
      - QuerySave (NotesUIDocument - LotusScript®)
        Occurs just before the current document is saved.
      - QuerySend (NotesUIDocument - LotusScript®)
        Occurs just before the current document is sent (mailed).
      - AutoReload (NotesUIDocument - LotusScript®)
        Read-write. Indicates whether or not the current document should be refreshed whenever the corresponding back-end document changes. Refreshing the current document updates its representation in memory, and visually on the workspace, to reflect the changes that have been made to the back-end document.
      - CurrentField (NotesUIDocument - LotusScript®)
        Read-only. The name of the field where the cursor is.
      - DialogBoxCanceled (NotesUIDocument - LotusScript®)
        Read-only. Indicates whether a user cancels a dialog.
      - Document (NotesUIDocument - LotusScript®)
        Read-only. The back-end document that corresponds to the currently open document.
      - EditMode (NotesUIDocument - LotusScript®)
        Read-write. Indicates whether a document is in Edit mode.
      - FieldHelp (NotesUIDocument - LotusScript®)
        Read-write. Indicates whether field Help for a document is displayed.
        Examples: FieldHelp property
        This script turns field help on.
      - HiddenChars (NotesUIDocument - LotusScript®)
        Read-write. Indicates whether the hidden characters in a document (such as tabs and carriage returns) are displayed.
      - HorzScrollBar (NotesUIDocument - LotusScript®)
        Read-write. Indicates whether the horizontal scroll bar on a document is displayed.
      - InPreviewPane (NotesUIDocument - LotusScript®)
        Read-only. Indicates whether the document is being accessed from the preview pane.
      - IsNewDoc (NotesUIDocument - LotusScript®)
        Read-only. Indicates whether a document is new. A new document is one that hasn't been saved.
      - ModifiedSinceSaved (NotesUIDocument - LotusScript®)
        Read-only. Indicates whether a document contains unsaved changes.
      - PreviewDocLink (NotesUIDocument - LotusScript®)
        Read-write. Indicates whether the preview pane for a link is displayed.
      - PreviewParentDoc (NotesUIDocument - LotusScript®)
        Read-write. Indicates whether the parent document preview pane is displayed.
      - Ruler (NotesUIDocument - LotusScript®)
        Read-write. Indicates whether the ruler is displayed.
      - WindowTitle (NotesUIDocument - LotusScript®)
        Read-only. The window title of a document.
      - Categorize (NotesUIDocument - LotusScript®)
        Given the name of a category, places a document in the category.
      - Clear (NotesUIDocument - LotusScript®)
        Deletes the current selection from a document. The current selection can be anything in an editable field, such as text or graphics.
      - Close (NotesUIDocument - LotusScript®)
        Closes a document.
      - CollapseAllSections (NotesUIDocument - LotusScript®)
        Collapses all the sections in a document.
      - Copy (NotesUIDocument - LotusScript®)
        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 (NotesUIDocument - LotusScript®)
        In a document in Edit mode, creates an OLE object in the current rich-text field.
      - Cut (NotesUIDocument - LotusScript®)
        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 graphics.
      - DeleteDocument (NotesUIDocument - LotusScript®)
        Marks the current document for deletion and closes it. The NotesUIDocument object is no longer available once you call this method.
      - DeselectAll (NotesUIDocument - LotusScript®)
        Deselects any selections in a document.
      - ExpandAllSections (NotesUIDocument - LotusScript®)
        Expands all the sections in a document.
      - FieldAppendText (NotesUIDocument - LotusScript®)
        Appends a text value into a field in a document without removing the existing contents of the field.
      - FieldClear (NotesUIDocument - LotusScript®)
        Clears the contents of a field in a document.
      - FieldContains (NotesUIDocument - LotusScript®)
        In an open document, checks if a field contains a specific text value.
      - FieldGetText (NotesUIDocument - LotusScript®)
        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 are converted to a string.
      - FieldSetText (NotesUIDocument - LotusScript®)
        Sets the value of a field in a document. The existing contents of the field, if any, are written over.
      - FindFreeTimeDialog (NotesUIDocument - LotusScript®)
        Brings up a "Free Time" dialog box based on the current document.
      - FindFreeTimeDialogEx (NotesUIDocument - LotusScript®)
        Brings up a "Free Time" dialog box based on the current document.
      - FindString (NotesUIDocument - LotusScript®)
        Finds the text in any field in a given document.
      - Forward (NotesUIDocument - LotusScript®)
        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 (NotesUIDocument - LotusScript®)
        Given a name, returns a handle to the OLE object of that name.
      - GetSchedulerObject (NotesUIDocument - LotusScript®)
        Returns an embedded scheduler.
      - GetSelectedText (NotesUIDocument - LotusScript®)
        Gets the text that is highlighted in the UI.
      - GotoBottom (NotesUIDocument - LotusScript®)
        Places the cursor in the last editable field or the last button in a document.
      - GotoField (NotesUIDocument - LotusScript®)
        Given a field name, puts the cursor in the specified field in a document.
      - GotoNextField (NotesUIDocument - LotusScript®)
        Places the cursor in the next field in a document. The next field is the one below and following the current field.
      - GotoPrevField (NotesUIDocument - LotusScript®)
        Places the cursor in the previous field in a document.
      - GotoTop (NotesUIDocument - LotusScript®)
        Places the cursor in the first editable field or the first button in a document.
      - Import (NotesUIDocument - LotusScript®)
        Imports a file.
      - InsertText (NotesUIDocument - LotusScript®)
        Inserts a text value at the current cursor position on a document.
      - NavBarSetText (NotesUIDocument - LotusScript®)
        Sets the text for the address bar of the Notes® client if the browser setting is "Notes with Internet Explorer."
      - NavBarSpinnerStart (NotesUIDocument - LotusScript®)
        Starts the URL navigation bar spinner for an Internet Explorer browser.
      - NavBarSpinnerStop (NotesUIDocument - LotusScript®)
        Stops the navigation bar spinner for an Internet Explorer browser.
      - Paste (NotesUIDocument - LotusScript®)
        Pastes the contents of the Clipboard at the current cursor position on a document.
      - Print (NotesUIDocument - LotusScript®)
        Prints the current document:
      - Refresh (NotesUIDocument - LotusScript®)
        Refreshes a document. When you refresh a document, its computed fields are recalculated.
      - RefreshHideFormulas (NotesUIDocument - LotusScript®)
        Recalculates the hide-when formulas on the current document form.
      - Reload (NotesUIDocument - LotusScript®)
        Refreshes the current document with any changes made to the back-end document associated with the current editing session.
      - Save (NotesUIDocument - LotusScript®)
        Saves a document.
      - SaveNewVersion (NotesUIDocument - LotusScript®)
        Saves a copy of a document as a new version.
      - SelectAll (NotesUIDocument - LotusScript®)
        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 - LotusScript®)
        Mails a document.
      - SpellCheck (NotesUIDocument - LotusScript®)
        Checks the spelling of a UI document.
    - NotesUIScheduler (LotusScript®)
    - NotesUIView (LotusScript®)
      Represents the current view in the Notes® workspace.
    - NotesUIWorkspace (LotusScript®)
      Represents the current Notes® workspace window.
    - NotesUserID (LotusScript®)
      The NotesUserID class represents the Notes ID file or a Notes ID when it resides within the Domino IDVault. This object is primarily used to obtain the names of the private encryption keys which are available for use within the UserID object.
    - NotesView (LotusScript®)
      Represents a view or folder of a database and provides access to documents within it.
    - NotesViewColumn (LotusScript®)
      Represents a column in a view or folder.
    - NotesViewEntry (LotusScript®)
      Represents a view entry. A view entry represents a row in a view.
    - NotesViewEntryCollection class (LotusScript®)
      Represents a collection of view entries, selected according to specific criteria. This class provides you mainly with a collection of documents in a view-sorted order.
    - NotesViewNavigator (LotusScript®)
      Represents a view navigator. A view navigator provides access to all or a subset of the entries in a view.
    - NotesXMLProcessor (LotusScript®)
      A base class containing properties and methods common to all XML processing classes.
    - NotesXSLTransformer (LotusScript®)
      Represents the transformation of DXL (Domino® XML) data through XSLT.
  - LotusScript® Classes Tutorial
    Welcome to LotusScript® and Domino®. "LotusScript Classes Tutorial" consists of three lessons designed to introduce you to using the LotusScript language in Domino. Each lesson includes:
- Java/CORBA Classes
  This section documents the Java/CORBA classes.
- Connectors
  Connectors provide native access to a wide variety of DBMS products, ODBC, the platform File system, Enterprise Resource Planning systems, and Transaction Processing systems.
- Javadoc™ for Domino® Designer related APIs
  As part of providing additional Java™ reference documentation, Domino® Designer ships with a help plugin that contains Javadoc™ for additional Domino Designer related APIs.

Examples: FieldHelp property

This script turns field help on.

Sub Click(Source As Button)
  Dim workspace As New NotesUIWorkspace
  Dim uidoc As NotesUIDocument
  Set uidoc = workspace.CurrentDocument
  uidoc.FieldHelp = True
End Sub