Home
HCL Domino Designer Basic 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.
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.
NotesBuildVersion (NotesSession - LotusScript®)
Read-only. The Notes® build version in which a selected document resides.

HCL Domino Designer Basic User Guide and Reference
This guide provides information on using HCL Domino Designer and programming language reference information.
- What's new in Domino Designer 12?
  The following features are new for developers in HCL Domino® Designer 12.
- 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.
      - Examples: NotesSession class
        This script creates a new NotesSession and uses it to access the current database (the database in which the script is running). This technique avoids hard-coding the file names of databases into scripts.
      - AddressBooks (NotesSession - LotusScript®)
        Read-only. The Domino® Directories and Personal Address Books, including directory catalogs, known to the current session.
      - CommonUserName (NotesSession - LotusScript®)
        Read-only. The common name portion of the current user's name.
      - ConvertMIME (NotesSession - LotusScript®)
        Read-write. Indicates whether items of type MIME_PART are converted to rich text upon NotesDocument instantiation.
      - CurrentAgent (NotesSession - LotusScript®)
        Read-only. The agent that's currently running.
      - CurrentDatabase (NotesSession - LotusScript®)
        Read-only. The database in which the current script resides. This database may or may not be open.
      - DocumentContext (NotesSession - LotusScript®)
        Read-only. The in-memory document when an agent starts.
      - EffectiveUserName (NotesSession - LotusScript®)
      - HttpURL (NotesSession - LotusScript®)
        Read-only. The Domino® URL of a session when HTTP protocols are in effect.
      - International (NotesSession - LotusScript®)
        Read-only. The international (regional) settings for your operating environment.
      - IsOnServer (NotesSession - LotusScript®)
        Read-only. Indicates whether a script is running on a server.
      - LastExitStatus (NotesSession - LotusScript®)
        Read-only. The exit status code returned by the Agent Manager the last time the current agent ran.
      - LastRun (NotesSession - LotusScript®)
        Read-only. The date when the current agent was last executed.
      - NotesBuildVersion (NotesSession - LotusScript®)
        Read-only. The Notes® build version in which a selected document resides.
        Examples: NotesBuildVersion property
        This script displays the Notes® build version in which a selected document resides.
      - NotesURL (NotesSession - LotusScript®)
        Read-only. The Domino® URL of a session when Notes® protocols are in effect.
      - NotesVersion (NotesSession - LotusScript®)
        Read-only. The release of Notes® in which the current script is running.
      - OrgDirectoryPath (NotesSession - LotusScript®)
        Read-only. The default directory of the current user in a hosted organization.
      - Platform (NotesSession - LotusScript®)
        Read-only. The name of the platform on which the session is running.
      - SavedData (NotesSession - LotusScript®)
        Read-only. A document that an agent script uses to store information in between invocations. The script can use the information in this document the next time the script runs.
      - ServerName (NotesSession - LotusScript®)
        Read-only. The full name of the server that the session is running on.
      - URLDatabase (NotesSession - LotusScript®)
        Read-only. A database object representing the default Web Navigator database.
      - UserGroupNameList (NotesSession - LotusScript®)
        Read-only. The groups to which the current user belongs.
      - UserName (NotesSession - LotusScript®)
        Read-only. The current user's name.
      - UserNameList (NotesSession - LotusScript®)
        Read-only. The name of the user or server that created the session, and the alternate name if it exists.
      - UserNameObject (NotesSession - LotusScript®)
        Read-only. The name, in the form of a NotesName object, of the user or server that created the session.
      - CreateAdministrationProcess (NotesSession - LotusScript®)
        Creates a new NotesAdministrationProcess object.
      - CreateColorObject (NotesSession - LotusScript®)
        Creates a new NotesColorObject object.
      - CreateDateRange (NotesSession - LotusScript®)
        Creates a new NotesDateRange object.
      - CreateDateTime (NotesSession - LotusScript®)
        Given a string that represents the date and time you want, creates a new NotesDateTime object that represents that date and time. When used with OLE automation, this method allows you to create a NotesDateTime object without using New.
      - CreateDOMParser (NotesSession - LotusScript®)
        Creates a NotesDOMParser object.
      - CreateDXLExporter (NotesSession - LotusScript®)
        Creates a NotesDXLExporter object.
      - CreateDXLImporter (NotesSession - LotusScript®)
        Creates a NotesDXLImporter object.
      - CreateLog (NotesSession - LotusScript®)
        Creates a new NotesLog object with the name you specify. When used with OLE automation, this method allows you to create a NotesLog object without using New.
      - CreateName (NotesSession - LotusScript®)
        Creates a new NotesName object. When used with OLE automation, this method allows you to create a NotesName object without using the New method of NotesName.
      - CreateNewsletter (NotesSession - LotusScript®)
        Given a NotesDocumentCollection containing the documents you want, creates a new NotesNewsletter. When used with OLE automation, this method allows you to create a NotesNewsletter object without using New.
      - CreateRegistration (NotesSession - LotusScript®)
        Creates a new NotesRegistration object.
      - CreateRichTextParagraphStyle (NotesSession - LotusScript®)
        Creates a new NotesRichTextParagraphStyle object.
      - CreateRichTextStyle (NotesSession - LotusScript®)
        Creates a NotesRichTextStyle object.
      - CreateSAXParser (NotesSession - LotusScript®)
        Creates a NotesSAXParser object.
      - CreateStream (NotesSession - LotusScript®)
        Creates a NotesStream object.
      - CreateTimer (NotesSession - LotusScript®)
        Creates a NotesTimer object.
      - CreateXSLTransformer (NotesSession - LotusScript®)
        Creates a NotesXSLTransformer object.
      - Evaluate (NotesSession - LotusScript®)
        Evaluates a Domino® formula.
      - FreeResourceSearch (NotesSession - LotusScript®)
        Searches for free resource slots for calendaring and scheduling.
      - FreeTimeSearch (NotesSession - LotusScript®)
        Searches for free time slots for calendaring and scheduling.
      - GetCalendar (NotesSession - LotusScript™)
        Creates a new NotesCalendar object.
      - GetDatabase (NotesSession - LotusScript®)
        Creates a NotesDatabase object that represents the database located at the server and file name you specify, and opens the database, if possible.
      - GetDbDirectory (NotesSession - LotusScript®)
        Creates a new NotesDbDirectory object using the name of the server you want to access. When used with OLE automation, this method allows you to create a NotesDbDirectory object without using New.
      - GetDirectory (NotesSession - LotusScript®)
        Creates a new NotesDirectory object using the name of the server you want to access.
      - GetEnvironmentString (NotesSession - LotusScript®)
        Given the name of a string environment variable, retrieves its value.
      - GetEnvironmentValue (NotesSession - LotusScript®)
        Given the name of a numeric environment variable, retrieves its value.
      - GetPropertyBroker (NotesSession - LotusScript®)
        Retrieves the property broker for this session.
      - GetUserPolicySettings (NotesSession - LotusScript®)
        Gets a policy document.
      - HashPassword (NotesSession - LotusScript®)
        Hashes a string value so that it is not recognizable.
      - Initialize (NotesSession - LotusScript®)
        Initializes a COM session with the current user ID.
      - InitializeUsingNotesUserName (NotesSession - LotusScript®)
        Initializes a COM session with a specified user name.
      - ResetUserPassword (NotesSession - LotusScript®)
        Use an agent to change the password of a user ID stored in the ID vault and/or specify the number of times a user ID can be downloaded from the vault after a password reset or ID recovery.
      - Resolve (NotesSession - LotusScript®)
        Returns the Domino® object that a URL addresses.
      - SendConsoleCommand (NotesSession - LotusScript®)
        Sends a console command to a Domino® server.
      - SetEnvironmentVar (NotesSession - LotusScript®)
        Sets the value of a string or numeric environment variable.
      - UpdateProcessedDoc (NotesSession - LotusScript®)
        Marks a document as processed by an agent.
      - UseDoubleAsPointer (NotesSession - LotusScript )
        Allows you to use a Double to handle a 64-bit pointer argument for a C API call.
      - VerifyPassword (NotesSession - LotusScript®)
        Verifies a plain string value against a hashed value.
    - 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.
    - 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.

NotesBuildVersion (NotesSession - LotusScript®)

Read-only. The Notes® build version in which a selected document resides.

Note: This method is new with Release 5.

Defined in

NotesSession

Data type

Long

Syntax

To get: long = notesSession .NotesBuildVersion

Usage

If the script runs on a workstation, this property returns the workstation's release number. If the script runs on a server, it returns the server's release number.

This property is the build number as listed in @Version. See NotesVersion for the release name.

Example