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 Coding Guidelines
The following topics cover some general guidelines for writing LotusScript® code using Domino® objects:
Using LotusScript® features in Domino®
All LotusScript® features work in Domino® exactly as specified in generic LotusScript, with the following exceptions and clarifications:
Using Bind, Command, Execute, InputBox, MessageBox, Print, SendKeys, Use, and UseLSX

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:
    - 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:
      - Using %Include and %If
      - Getting a returned array
        Arrays returned by Domino® properties and methods must be defined as Variant. You cannot define the return variable as a dynamic array. For example, you can do:
      - Closing a file
      - Using the Evaluate statement
      - Using an object
        This section shows you how to create an object, assign an object reference, and delete an object.
      - Using Bind, Command, Execute, InputBox, MessageBox, Print, SendKeys, Use, and UseLSX
      - Calling a function or subroutine
      - Using parentheses to pass by value
        You can pass an argument by value by enclosing it in parentheses. For example:
    - 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
    - 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.

Using Bind, Command, Execute, InputBox, MessageBox, Print, SendKeys, Use, and UseLSX

Bind

Domino® Designer implicitly binds its supported objects. Do not use Set...Bind to associate a Domino® object with a variable.

Command

The Command function always returns an empty string.

Execute

If you modify a global variable in an Execute statement, the variable must be defined in the (Declarations) event for (Global), not the (Declarations) event for the object containing the script.

InputBox and MessageBox

The Inputbox and MessageBox functions write to the following:

A dialog box when executing on a Domino® client. The user clicks OK, Cancel, Abort, Retry, Yes, or No to continue.
log.nsf when executing on a Domino® server.

Print

The Print statement writes to the following:

The status bar when executing on a Domino® client in non-debug mode.
The status bar and output window when executing on a Domino® client in debug mode.
NOTES.LOG when executing on a Domino® server.

SendKeys

The LotusScript® SendKeys statement is not currently supported in Domino® Designer.

Use and UseLSX

The Use statement is supported in Domino® Designer. This statement loads an LSS file containing public definitions, and also loads a script library.

The UseLSX statement is supported. This statement loads a shared library of class definitions. Once the LSX file has been loaded, you can view its classes in the Notes® class browser. These class definitions are then available to scripts.

The Domino® platform has a registry of LSX. If the file-specification string in the UseLSX statement begins with an asterisk (*), then Domino® Designer looks in the registry for the name consisting of the rest of the string. The registry entry for that name specifies the file location in the platform file system.

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.