Home
IBM Domino Designer Basic User Guide and Reference
Basic product usage information 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 the Domino® Objects through COM
Requirements
The COM interface is available on a computer containing any of the following:

IBM Domino Designer Basic User Guide and Reference
Basic product usage information and programming language reference information.
- 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 in Domino core allowing for a terse shorthand syntax for finding documents according to a wide variety of complexity of terms. It leverages existing design elements without the need to write detailed code to access them.
- 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 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
      - Examples: Accessing the Domino® Objects through COM
      - Requirements
        The COM interface is available on a computer containing any of the following:
      - Creating a session object
        To access the Domino® Objects, create an object based on the registered Lotus®.NotesSession class.
      - Initializing a session
        You must explicitly initialize a COM session with one of the following NotesSession methods. These methods do not apply to LotusScript® applications.
      - General exceptions to LotusScript® specifications
        The following are the general differences between accessing Domino® Objects through either LotusScript® or COM:
      - Language differences between LotusScript® and Visual Basic
        Note the following language differences between LotusScript® and Visual Basic:
      - Specific exceptions to LotusScript® specifications
        The following are specific differences between accessing Domino® Objects through either LotusScript® or COM.
      - COM-only properties and methods
        Following are the specifications for the COM-only properties and methods:
      - Constants
        The table that follows specifies the values of the non-error constants used by the Domino® classes. You can also see the constant values by examining domobj.tlb in the Notes® or Domino program directory with a product such as Visual InterDev (VID).
    - 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.
- Lotus® Connectors
  Lotus® 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.

Requirements

The COM interface is available on a computer containing any of the following:

Domino® Designer Release 5.0.2b or later
Domino® Server Release 5.0.2b or later
Notes® Client Release 5.0.2b or later

The Domino® or Notes® software must be installed but need not be running.

Installation of the Domino® or Notes® software makes a type library available and registers the following classes:

Lotus®.NotesSession
Lotus®.NotesSession.1

Do not confuse these with the OLE automation objects Notes®.NotesSession and Notes®.NotesUIWorkspace.

The Domino® COM objects must be able to locate a valid notes.ini file, looking first in the Domino® or Notes® program directory and then at the PATH system variable. The KeyFileName setting in the notes.ini file specifies the user ID that COM uses.