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 Coding Guidelines
The following topics cover some general guidelines for writing LotusScript® code using Domino® objects:
Accessing Domino® databases
Locating a database on a server and local disk

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.5?
  The following features are new for developers in HCL Domino® Designer 14.5.
- 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:
    - Using the Domino® classes
      Domino® Designer defines LotusScript® classes that allow you to access Domino structures on two levels:
    - Using LotusScript® features in Domino®
      All LotusScript® features work in Domino® exactly as specified in generic LotusScript, with the following exceptions and clarifications:
    - Accessing Domino® databases
      - Accessing database properties
        The following table lists the NotesDatabase properties:
      - Locating a database on a server and local disk
        Example: Locating a database on a server and local disk
        This example prints the names of all the NSF files in the local Domino® data directory. To find different types of files, you can alternatively specify DATABASE, TEMPLATE, REPLICA_CANDIDATE, or TEMPLATE_CANDIDATE as the argument to the GetFirstDatabase method.
      - Opening a database
        The New method for the NotesDatabase class opens an existing database if you specify the file name as the second argument. The New method does not create a database. The first argument specifies the server and defaults (empty string) to the local Domino® directory.
      - Creating and deleting a database
        Use one of the following methods to create a database. The New method does not create a database.
      - Accessing an outline
      - Examining and adjusting an access control list
        You examine and adjust the access control list (ACL) of a database through objects of the following classes:
      - Examining and adjusting database replication settings
      - Accessing a document in LotusScript®
      - Accessing a form
        You can access existing forms in a database as follows:
    - Accessing views and folders
    - Accessing documents in LotusScript® classes
    - Accessing items in LotusScript® classes
    - Accessing rich text items in LotusScript® classes
    - Accessing sessions
    - Accessing supporting Domino® objects
    - Handling run-time errors
    - Accessing the Domino® Objects through COM
    - Using OLE
      The Notes® client is an OLE automation controller and server.
    - Using OLE custom controls
      You can embed OLE custom controls in Domino® Designer forms and write scripts for them just as you can for a native object. When a control is active (has focus), the menu is a combination of Domino Designer (File, Applet, and Window) and control items. The control menu items may include one for itself (for example, "Spreadsheet" for a spreadsheet control) and Help--the control help is substituted for Domino Designer help.
  - 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.
  - 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.

Locating a database on a server and local disk

The NotesDbDirectory class provides a means to locate databases on servers and the user's local disk. To access a particular server, specify its name as the argument to the New method for NotesDbDirectory. The GetFirstDatabase and GetNextDatabase methods return handles to NotesDatabase objects. The Name property contains the name of the server or workstation.

The Parent property, supported in COM only, returns the session that contains the DbDirectory object. In COM, you can access NotesDatabase objects through the following methods in the NotesDbDirectory class:


Methods	Description
CreateDatabase	Creates a new database. For COM only.
OpenDatabase	Opens a database. For COM only.
OpenDatabaseByReplicaID	Opens a database with a specified replica ID. For COM only.
OpenDatabaseIfModified	Opens a database if modified since a specified date. For COM only.
OpenMailDatabase	Opens current user's mail database. For COM only.