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.
NotesDatabase (LotusScript®)
Represents a Notes® database.
FileFormat (NotesDatabase - LotusScript®)
Read-only. The ODS (on-disk structure) version of a database.

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.
      - Examples: NotesDatabase class
      - ACL (NotesDatabase - LotusScript®)
        Read-only. The access control list for a database.
      - ACLActivityLog (NotesDatabase - LotusScript®)
        Read-only. The log from the access control list for a database.
      - Agents (NotesDatabase - LotusScript®)
        Read-only. All of the agents in a database.
      - AllDocuments (NotesDatabase - LotusScript®)
        Read-only. All the documents in a database.
      - Categories (NotesDatabase - LotusScript®)
        Read-write. The categories under which a database appears in a database catalog.
      - Created (NotesDatabase - LotusScript®)
        Read-only. The date/time that a database was created.
      - CurrentAccessLevel (NotesDatabase - LotusScript®)
        Read-only. The current user's access level to a database.
      - DelayUpdates (NotesDatabase - LotusScript®)
        Read-write. Indicates whether updates to a server are delayed (batched) for better performance.
      - DesignTemplateName (NotesDatabase - LotusScript®)
        Read-only. The name of the design template from which a database inherits its design. If the database does not inherit its design from a design template, it returns an empty string ("").
      - EncryptionStrength (NotesDatabase - LotusScript)
        The encryption strength of a database.
      - FileFormat (NotesDatabase - LotusScript®)
        Read-only. The ODS (on-disk structure) version of a database.
        Examples: FileFormat property (NotesDatabase - LotusScript)
        This agent gets the ODS version of the databases in the local directory.
      - FileName (NotesDatabase - LotusScript®)
        Read-only. The full file name of a database, including the extension but excluding the path.
      - FilePath (NotesDatabase - LotusScript®)
        Read-only. The path and file name of a database. The file name includes the NSF extension.
      - FolderReferencesEnabled (NotesDatabase - LotusScript®)
        Read-write. Indicates whether this database maintains folder references for documents.
      - Forms (NotesDatabase - LotusScript®)
        Read-only. All the forms in a database.
      - FTIndexFrequency (NotesDatabase - LotusScript®)
        Read-write. Update frequency of a database's full-text index.
      - HttpURL (NotesDatabase - LotusScript®)
        Read-only. The Domino® URL of a database when HTTP protocols are in effect.
      - IsClusterReplication (NotesDatabase - LotusScript®)
        Read-write. Indicates whether cluster replication is in effect for a database on a server in a cluster.
      - IsConfigurationDirectory (NotesDatabase - LotusScript®)
        Read-only. Indicates whether a database is a Configuration Directory database.
      - IsCurrentAccessPublicReader (NotesDatabase - LotusScript®)
        Read-only. Indicates whether the current user has public reader access in a database.
      - IsCurrentAccessPublicWriter (NotesDatabase - LotusScript®)
        Read-only. Indicates whether the current user has public writer access in a database.
      - IsDesignLockingEnabled (NotesDatabase - LotusScript®)
        Read-write. Indicates whether design locking is enabled for a database.
      - IsDirectoryCatalog (NotesDatabase - LotusScript®)
        Read-only. Indicates whether a database is a Directory Catalog database, also known as the Light Weight NAB, or the Enterprise Address Book.
      - IsDocumentLockingEnabled (NotesDatabase - LotusScript®)
        Read-write. Indicates whether document locking is enabled for a database.
      - IsFTIndexed (NotesDatabase - LotusScript®)
        Read-only. Indicates whether or not a database has a full-text index.
      - IsInMultiDbIndexing (NotesDatabase - LotusScript®)
        Read-write. Indicates whether a database can be included in multi-database indexing.
      - IsInService (NotesDatabase - LotusScript®)
        Read-write. Indicates whether a database on a server in a cluster is accessible.
      - IsLink (NotesDatabase - LotusScript®)
        Read-only. Indicates whether a database is the target of a link.
      - IsLocallyEncrypted (NotesDatabase - LotusScript)
        Indicates whether a database is locally encrypted. Read-only.
      - IsMultiDbSearch (NotesDatabase - LotusScript®)
        Read-only. Indicates whether a database is of type "Multi DB Search."
      - IsOpen (NotesDatabase - LotusScript®)
        Read-only. Indicates whether a database is open.
      - IsPendingDelete (NotesDatabase - LotusScript®)
        Read-only. Indicates whether a database on a server in a cluster is marked for deletion.
      - IsPrivateAddressBook (NotesDatabase - LotusScript®)
        Read-only. Indicates whether a database is a Personal Address Book.
      - IsPublicAddressBook (NotesDatabase - LotusScript®)
        Read-only. Indicates whether a database is a Domino® Directory.
      - LastFixup (NotesDatabase - LotusScript®)
        Read-only. The date that a database was last checked by the Fixup task.
      - LastFTIndexed (NotesDatabase - LotusScript®)
        Read-only. The date that a database full-text index was last updated.
      - LastModified (NotesDatabase - LotusScript®)
        Read-only. The date/time that a database was last modified.
      - LimitRevisions (NotesDatabase - LotusScript®)
        Read-write. The maximum number of entries allowed in the $Revisions field.
      - LimitUpdatedBy (NotesDatabase - LotusScript®)
        Read-write. The maximum number of entries allowed in the $UpdatedBy field.
      - ListInDbCatalog (NotesDatabase - LotusScript®)
        Read-write. Indicates whether a database appears in database catalogs.
      - Managers (NotesDatabase - LotusScript®)
        Read-only. People, servers, and groups that have Manager access to a database.
      - MaxSize (NotesDatabase - LotusScript®)
        Read-only. Shows the maximum size assigned to the database when the database was created.
      - NotesURL (NotesDatabase - LotusScript®)
        Read-only. The Domino® URL of a database when Notes® protocols are in effect.
      - Parent (NotesDatabase - LotusScript®)
        Read-only. The Notes® session that contains a database.
      - PercentUsed (NotesDatabase - LotusScript®)
        Read-only. The percent of the total size of a database that is occupied by real data (and not empty space).
      - ReplicaID (NotesDatabase - LotusScript®)
        Read-only. A 16-character combination of letters and numbers that represents the replica ID of a Notes® database. Any databases with the same replica ID are replicas of one another.
      - ReplicationInfo (NotesDatabase - LotusScript®)
        Read-only. Provides access to a NotesReplication object. Each NotesDatabase instance contains one NotesReplication object.
      - Server (NotesDatabase - LotusScript®)
        Read-only. The name of the server where a database resides.
      - Size (NotesDatabase - LotusScript®)
        Read-only. The size of a database, in bytes.
      - SizeQuota (NotesDatabase - LotusScript®)
        Read-write. The size quota of a database, in kilobytes.
      - SizeWarning (NotesDatabase - LotusScript®)
        Read-write. The size warning threshold of a database, in kilobytes.
      - TemplateName (NotesDatabase - LotusScript®)
        Read-only. The template name of a database, if the database is a template. If the database is not a template, returns an empty string ("").
      - Title (NotesDatabase - LotusScript®)
        Read-write. The title of a database.
      - Type (NotesDatabase - LotusScript®)
        Read-only. Database type.
      - UndeleteExpireTime (NotesDatabase - LotusScript®)
        Read-write. The number of hours before soft deletions become hard deletions.
      - UnprocessedDocuments (NotesDatabase - LotusScript®)
        Read-only. The documents in a database that the current agent or view action considers to be "unprocessed." The type of agent determines which documents are considered unprocessed.
      - Views (NotesDatabase - LotusScript®)
        Read-only. The views and folders in a database.
      - Compact (NotesDatabase - LotusScript®)
        Compacts a local database.
      - CompactWithOptions (NotesDatabase - LotusScript®)
        Compacts a local database allowing the submission of options.
      - Create (NotesDatabase - LotusScript®)
        Creates a new database on disk, using the server and file name that you specify.
      - CreateCopy (NotesDatabase - LotusScript®)
        Creates an empty copy of the current database.
      - CreateDocument (NotesDatabase - LotusScript®)
        Creates a document in a database and returns a NotesDocument object that represents the new document. You must call Save if you want the new document to be saved to disk. When used with OLE automation, this method allows you to create a NotesDocument object without using New.
      - CreateDocumentCollection (NotesDatabase - LotusScript)
        Returns an empty document collection.
      - CreateDominoQuery (NotesDatabase - LotusScript)
        Gets an instance of the NotesDominoQuery class for use in running DQL queries.
      - CreateFromTemplate (NotesDatabase - LotusScript®)
        Creates a new database from an existing database.
      - CreateFTIndex (NotesDatabase - LotusScript®)
        Creates a full-text index for a database.
      - CreateNoteCollection (NotesDatabase - LotusScript®)
        Creates a note collection based on the current database and returns a NotesNoteCollection object that represents the note collection.
      - CreateOutline (NotesDatabase - LotusScript®)
        Creates a new outline within the current database and returns a NotesOutline object that represents the new outline. This method allows you to create a NotesOutline object without using New.
      - CreateReplica (NotesDatabase - LotusScript®)
        Creates a replica of the current database at a new location.
      - CreateView (NotesDatabase - LotusScript®)
        Creates a view.
      - Decrypt (NotesDatabase - LotusScript)
        Decrypts a database
      - EnableFolder (NotesDatabase - LotusScript®)
        Given a folder name, enables the folder.
      - Encrypt (NotesDatabase - LotusScript)
        Encrypts a database.
      - Fixup (NotesDatabase - LotusScript®)
        Runs the Fixup task on a database.
      - FTDomainSearch (NotesDatabase - LotusScript®)
        Conducts a Domain Search, that is, a full-text search of all databases configured in the Domain Catalog database and marked as included for multi-database indexing.
      - FTSearch (NotesDatabase - LotusScript®)
        Conducts a full-text search of all the documents in a database.
      - FTSearchRange (NotesDatabase - LotusScript®)
        Conducts a full-text search of all the documents in a database.
      - GetAgent (NotesDatabase - LotusScript®)
        Finds an agent in a database, given the agent name.
      - GetAllReadDocuments (NotesDatabase - LotusScript®)
        Creates a note collection of all read documents in the database.
      - GetAllUnreadDocuments (NotesDatabase - LotusScript®)
        Creates a note collection of all unread documents in the database.
      - GetDocumentByID (NotesDatabase - LotusScript®)
        Finds a document in a database, given the document's note ID.
      - GetDocumentByUNID (NotesDatabase - LotusScript®)
        Finds a document in a database, given the document universal ID (UNID).
      - GetDocumentByURL (NotesDatabase - LotusScript®)
        Instantiates a document in the database on which it is called and returns a NotesDocument object for it. This method is typically used for either the Server Web Navigator or Personal Web Navigator database, but can be called on any database object.
      - GetForm (NotesDatabase - LotusScript®)
        Finds a form in a database, given the form name.
      - GetModifiedDocuments (NotesDatabase - LotusScript®)
      - GetModifiedDocumentsWithOptions (NotesDatabase - LotusScript®)
        Lets you retrieve all modified documents meeting matches for specified options.
      - GetNamedDocument (NotesDatabase - LotusScript)
        Returns a named document.
      - GetNamedDocCollection (NotesDatabase - LotusScript)
        Returns a collection of named documents.
      - GetOption (NotesDatabase - LotusScript®)
        Gets the value of a database option.
      - GetOutline (NotesDatabase - LotusScript®)
        Retrieves an existing outline within the current database and returns a NotesOutline object that represents the outline.
      - GetProfileDocCollection (NotesDatabase - LotusScript®)
        Given a profile name, returns a collection of Profile documents that match the name, or if no name is given, a collection of all Profile documents.
      - GetProfileDocument (NotesDatabase - LotusScript®)
        Retrieves or creates a Profile document.
      - CreateQueryResultsProcessor (NotesDatabase - LotusScript)
        Gets an instance of the NotesQueryResultsProcessor class for use processing the document collections and output of DQL queries.
      - GetURLHeaderInfo (NotesDatabase - LotusScript®)
        Gets the specific Hypertext Transfer Protocol (HTTP) header information from the Uniform Resource Locator (URL). A URL is a text string used for identifying and addressing a Web resource.
      - GetView (NotesDatabase - LotusScript®)
        Finds a view or folder in a database, given the name or alias of the view or folder.
      - GrantAccess (NotesDatabase - LotusScript®)
        Modifies a database access control list to provide the specified level of access to a person, group, or server.
      - MarkForDelete (NotesDatabase - LotusScript®)
        Marks a database for deletion from a server in a cluster.
      - Open (NotesDatabase - LotusScript®)
      - OpenByReplicaID (NotesDatabase - LotusScript®)
        Given a server name and a replica ID, opens the specified database, if it exists.
      - OpenIfModified (NotesDatabase - LotusScript®)
        Given a date, opens the specified database if it has been modified since that date.
      - OpenMail (NotesDatabase - LotusScript®)
        Assigns a database to the current user's mail database and opens that database.
      - OpenURLDb (NotesDatabase - LotusScript®)
        Finds and opens the default Web Navigator database.
      - OpenWithFailover (NotesDatabase - LotusScript®)
        Opens a database on a server.
      - QueryAccess (NotesDatabase - LotusScript®)
        Returns the current access level of a person, group, or server to a database.
      - QueryAccessPrivileges (NotesDatabase - LotusScript®)
      - QueryAccessRoles (NotesDatabase - LotusScript®)
        Returns the roles of a person, group, or server in a database.
      - Remove (NotesDatabase - LotusScript®)
        Permanently deletes a database from disk.
      - RemoveAllQueryNamedResults (Database - LotusScript)
        Deletes all named results sets saved in a database by the Notes DominoQuery execute method.
      - RemoveFTIndex (NotesDatabase - LotusScript®)
        Removes a full-text index from a database.
      - Replicate (NotesDatabase - LotusScript®)
        Replicates a database with its replica(s) on a given server.
      - RevokeAccess (NotesDatabase - LotusScript®)
        Removes a person, group, or server from a database access control list. This resets the access level for that person, group, or server to the Default setting for the database.
      - Search (NotesDatabase - LotusScript®)
        Given selection criteria for a document, returns all documents in a database that meet the criteria.
      - SetUserIDForDecrypt (NotesDatabase - LotusScript®)
        After calling this method on a database, any document that is opened within the database is decrypted using the encryption keys within the userID object, as specified in the document SecretEncryptionKeys field.
      - SetOption (NotesDatabase - LotusScript®)
        Sets the value of a database option.
      - Sign (NotesDatabase - LotusScript®)
        Signs elements in a database with the signature of the current user. This method programmatically mimics the use of the Sign Database dialog in the Notes® Domino® Admin client.
      - TransactionBegin (NotesDatabase - LotusScript)
        Begins recording changes to a database on a Domino server.
      - TransactionCommit (NoteDatabase - LotusScript)
        Makes changes to a database in a batch after a TransactionBegin call.
      - TransactionRollback (NotesDatabase - LotusScript)
        Discards database changes recorded by TransactionBegin.
      - UnprocessedFTSearch (NotesDatabase - LotusScript®)
        Conducts a full-text search of the documents in a database that the current agent considers to be unprocessed.
      - UnprocessedFTSearchRange (NotesDatabase - LotusScript®)
        Conducts a full-text search of the documents in a database that the current agent considers to be unprocessed.
      - UnprocessedSearch (NotesDatabase - LotusScript®)
        Given selection criteria for a document, returns documents in a database that:
      - UpdateFTIndex (NotesDatabase - LotusScript®)
        Updates the database full-text index.
    - 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.
    - 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.

FileFormat (NotesDatabase - LotusScript®)

Read-only. The ODS (on-disk structure) version of a database.

Note: This property is new with Release 6.

Defined in

NotesDatabase

Data type

Integer

Syntax

To get: fileFormat% = notesDatabase .FileFormat

Usage

The ODS version increments with newer versions of Domino®:

Notes® Domino® 6 is 43
Notes/Domino 5 is 41

The database must be open to use this property.

Example