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.
NotesDocument (LotusScript®)
Represents a document in a database.
IsNewNote (NotesDocument - LotusScript®)
Read-only. Indicates whether a document is new. A document is new if it hasn't been saved.
Examples: IsNewNote property (NotesDocument - LotusScript®)
This script prints a message.

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 HCL 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.
      - Examples: NotesDocument class
      - Authors (NotesDocument - LotusScript®)
        Read-only. The names of the people who have saved a document.
      - ColumnValues (NotesDocument - LotusScript®)
        Read-only. An array of values, each element of which corresponds to a column value in the document's parent view. The first value in the array is the value that appears in the view's first column for the document, the second value is the one that appears in the second column, and so on. The value of each element of the array is the result of the corresponding column's formula and the items on the current document. Some elements in the array might have no value.
      - Created (NotesDocument - LotusScript®)
        Read-only. The date/time a document was created.
      - EmbeddedObjects (NotesDocument - LotusScript®)
        Read-only. The OLE/2 and OLE/1 embedded objects in a document.
      - EncryptionKeys (NotesDocument - LotusScript®)
        Read-write. The key(s) used to encrypt a document. The Encrypt method uses these keys when it encrypts the document.
      - EncryptOnSend (NotesDocument - LotusScript®)
        Read-write. Indicates whether a document is encrypted when mailed.
      - FolderReferences (NotesDocument - LotusScript®)
        Read-only. The names of the folders containing a document.
      - FTSearchScore (NotesDocument - LotusScript®)
        Read-only. The full-text search score of a document, if it was retrieved as part of a full-text search.
      - HasEmbedded (NotesDocument - LotusScript®)
        Read-only. Indicates whether a document contains one or more embedded objects, object links, or file attachments.
      - HttpURL (NotesDocument - LotusScript®)
        Read-only. The Domino® URL of a document when HTTP protocols are in effect.
      - IsDeleted (NotesDocument - LotusScript®)
        Read-only. Indicates whether a Document object represents an existing document (not a deletion stub) on an ongoing basis.
      - IsEncrypted (NotesDocument - LotusScript®)
        Read-only. Indicates whether a document is encrypted.
      - IsNamedDoc (NotesDocument - LotusScript)
        Indicates whether a document is a named document.
      - IsNewNote (NotesDocument - LotusScript®)
        Read-only. Indicates whether a document is new. A document is new if it hasn't been saved.
        Examples: IsNewNote property (NotesDocument - LotusScript®)
        This script prints a message.
      - IsProfile (NotesDocument - LotusScript®)
        Read-only. Indicates whether a NotesDocument object is a Profile document.
      - IsResponse (NotesDocument - LotusScript®)
        Read-only. Indicates whether a document is a response to another document.
      - IsSigned (NotesDocument - LotusScript®)
        Read-only. Indicates whether a document contains a signature.
      - IsUIDocOpen (NotesDocument - LotusScript®)
        Read-only. Indicates whether a NotesDocument object (back-end document) is accessed through a NotesUIDocument object (front-end document).
      - IsValid (NotesDocument - LotusScript®)
        Read-only. Indicates whether a Document object represents an existing document (not a deletion stub) initially.
      - Items (NotesDocument - LotusScript®)
        Read-only. All the items in a document. An item is any piece of data stored in a document.
      - Key (NotesDocument - LotusScript®)
        Read-only. If a Profile document, the user name (key) of the profile.
      - LastAccessed (NotesDocument - LotusScript®)
        Read-only. The date/time a document was last modified or read.
      - LastModified (NotesDocument - LotusScript®)
        Read-only. The date/time a document was last modified.
      - LockHolders (NotesDocument - LotusScript®)
        Read-only. The names of the holders of a lock.
      - NameOfDoc (NotesDocument - LotusScript)
        Returns the name of a named document.
      - NameOfProfile (NotesDocument - LotusScript®)
        Read-only. If a Profile document, the name of the profile.
      - NoteID (NotesDocument - LotusScript®)
        Read-only. The note ID of a document, which is an 8-character combination of letters and numbers that uniquely identifies a document within a particular database.
      - NotesURL (NotesDocument - LotusScript®)
        Read-only. The Domino® URL of a document when Notes® protocols are in effect.
      - ParentDatabase (NotesDocument - LotusScript®)
        Read-only. The database that contains a document.
      - ParentDocumentUNID (NotesDocument - LotusScript®)
        Read-only. The universal ID of a document's parent, if the document is a response. Returns an empty string ("") if a document doesn't have a parent.
      - ParentView (NotesDocument - LotusScript®)
        Read-only. The view from which a document was retrieved, if any.
      - Responses (NotesDocument - LotusScript®)
        Read-only. The immediate responses to a document.
      - SaveMessageOnSend (NotesDocument - LotusScript®)
        Read-write. Indicates whether a document is saved to a database when mailed. Only applies to new documents that have not yet been saved.
      - SentByAgent (NotesDocument - LotusScript®)
        Read-only. Indicates whether a document was mailed by a script.
      - Signer (NotesDocument - LotusScript®)
        Read-only. The name of the person who created the signature, if a document is signed.
      - SignOnSend (NotesDocument - LotusScript®)
        Read-write. Indicates whether a document is signed when mailed.
      - Size (NotesDocument - LotusScript®)
        Read-only. The size of a document in bytes, which includes the size of any file attachments on the document.
      - UserNameOfDoc (NotesDocument - LotusScript)
        Returns a user name associated with a named document.
      - UniversalID (NotesDocument - LotusScript®)
        Read-write. The universal ID, which uniquely identifies a document across all replicas of a database. In character format, the universal ID is a 32-character combination of hexadecimal digits (0-9, A-F).
      - Verifier (NotesDocument - LotusScript®)
        Read-only. The name of the certificate that verified a signature, if a document is signed.
      - AppendItemValue (NotesDocument - LotusScript®)
        Creates a new item in a document and sets the item value.
      - AttachVCard (NotesDocument - LotusScript®)
        Attaches one or more documents in vCard format.
      - CloseMIMEEntities (NotesDocument - LotusScript®)
        Closes MIME processing associated with items of a specified name.
      - ComputeWithForm (NotesDocument - LotusScript®)
        Validates a document by executing the default value, translation, and validation formulas, if any are defined in the document form.
      - ConvertToMIME (NotesDocument - LotusScript®)
        Converts a document in Notes® format to MIME format similar to a mail router.
      - CopyAllItems (NotesDocument - LotusScript®)
        Given a destination document, copies all of the items in the current document into the destination document. The item names are unchanged.
      - CopyItem (NotesDocument - LotusScript®)
        Given an item, copies it into the current document and optionally assigns the copied item a new name.
      - CopyToDatabase (NotesDocument - LotusScript®)
        Copies a document into the specified database.
      - CreateMIMEEntity (NotesDocument - LotusScript®)
        Creates an uninitialized top-level MIME entity in a document.
      - CreateReplyMessage (NotesDocument - LotusScript®)
        Creates a new document that is formatted as a reply to the current document.
      - CreateRichTextItem (NotesDocument - LotusScript®)
        Creates a new rich text item in a document, using a name you specify, and returns the corresponding NotesRichTextItem object. When used with OLE automation, this method allows you to create a new rich text item and NotesRichTextItem object without using New.
      - Encrypt (NotesDocument - LotusScript®)
        Encrypts a document in a database.
      - GetAttachment (NotesDocument - LotusScript®)
        Given the name of a file attachment, returns a NotesEmbeddedObject representing the attachment. You can use this method to find file attachments which are not contained in a rich text item (such as an attachment in a Release 2 database), as well as file attachments that are contained in a rich text item.
      - GetFirstItem (NotesDocument - LotusScript®)
        Given a name, returns the first item of the specified name belonging to the document.
      - GetItemValue (NotesDocument - LotusScript®)
        Given the name of an item, returns the value of that item in a document.
      - GetItemValueCustomDataBytes (NotesDocument - LotusScript®)
      - GetItemValueDateTimeArray (NotesDocument - LotusScript®)
        Returns the value of a date-time item in a document.
      - GetMIMEEntity (NotesDocument - LotusScript®)
        Gets a top-level MIME entity.
      - GetRead (NotesDocument - LotusScript®)
        Returns true if the current document has been read, otherwise false.
      - GetReceivedItemText (NotesDocument - LotusScript®)
        Gets the text values of the Received items in a mail document.
      - HasItem (NotesDocument - LotusScript®)
        Given the name of an item, indicates whether that item exists on the document.
      - Lock (NotesDocument - LotusScript®)
        Locks a document.
      - LockProvisional (NotesDocument - LotusScript®)
        Locks a document provisionally.
      - MakeResponse (NotesDocument - LotusScript®)
        Makes one document a response to another document. The two documents must be in the same database.
      - MarkRead (NotesDocument - LotusScript®)
        Marks the document as read.
      - MarkUnread (NotesDocument - LotusScript®)
        Marks the document as unread.
      - PutInFolder (NotesDocument - LotusScript®)
        Adds a document to the specified folder. If the folder does not exist in the document's database, it is created.
      - Remove (NotesDocument - LotusScript®)
        Permanently deletes a document from a database, but does a soft deletion if soft deletions are enabled.
      - RemoveFromFolder (NotesDocument - LotusScript®)
        Removes a document from the specified folder.
      - RemoveItem (NotesDocument - LotusScript®)
        Given the name of an item, deletes the item from a document.
      - RemovePermanently (NotesDocument - LotusScript®)
        Permanently deletes a document from a database, doing a hard deletion even if soft deletions are enabled.
      - RenderToRTItem (NotesDocument - LotusScript®)
        Creates a picture of a document and places it into a rich text item you specify. The picture is created using both the document and its form. Therefore, the form's input translation and validation formulas are executed.
      - ReplaceItemValue (NotesDocument - LotusScript®)
        Replaces all items of the specified name with one new item, which is assigned the specified value. If the document does not contain an item with the specified name, the method creates a new item and adds it to the document.
      - ReplaceItemValueCustomDataBytes (NotesDocument - LotusScript®)
      - Save (NotesDocument - LotusScript®)
        Saves any changes you have made to a document.
      - Send (NotesDocument - LotusScript®)
        Mails a document.
      - Sign (NotesDocument - LotusScript®)
        Signs a document.
      - UnLock (NotesDocument - LotusScript®)
        Unlocks a document.
    - 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. Currently supported for HCL Nomad beginning with Release 1.0.4.
    - 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.
    - 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: IsNewNote property (NotesDocument - LotusScript®)

This script prints a message.

Dim doc As NotesDocument
'...set value of doc...
If doc.IsNewNote Then
  Messagebox( "This document has not been saved. It's new." )
Else
  Messagebox( "This document has been saved. It's not new." )
End If

Have feedback?
Google Analytics is used to store comments and ratings. To provide a comment or rating for a topic, click Accept All Cookies or Allow All in Cookie Preferences in the footer of this page.