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:
Accessing supporting Domino® objects
Representing a color

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:
    - 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
      - Converting between Domino® Designer and LotusScript® time
        The formats of a Domino® Designer date-time item and a LotusScript® date variant differ. For example, you cannot put a LotusScript date variant in a Domino Designer date-time item or manipulate a Domino Designer time-date item with LotusScript date functions.
      - Making a Domino® log
      - Making a Domino® newsletter
        A newsletter is a summary document containing information from and/or links to other documents. The essential steps for creating a newsletter are:
      - Setting up a timer
        A timer allows you to call an event handler every specified number of seconds. The essential steps for creating a timer are:
      - Representing a name
      - Representing a color
      - Working with streams of data
      - Building a note collection (LotusScript®)
    - 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.

Representing a color

The NotesColorObject class allows you to represent a Domino® color so that you can access its Domino® value, RGB (red, green, blue) value, and HSL (hue, saturation, luminance) value as properties. Use the CreateColorObject method of NotesSession to establish the object.

The following table lists the NotesColorObject properties.


Property	Data type	Description
Blue	Integer	(Read-only) Blue RGB value 0-255.
Green	Integer	(Read-only) Green RGB value 0-255.
Hue	Integer	(Read-only) Hue HSL value 0-240.
Luminance	Integer	(Read-only) Luminance HSL value 0-240.
NotesColor	Integer	Domino® color value.
Red	Integer	(Read-only) Red RGB value 0-255.
Saturation	Integer	(Read-only) Saturation HSL value 0-240.

Domino® color values are in the range 0-240. Setting NotesColor sets the RGB and HSL properties to values that correspond to the Domino® color value. You can base the color properties on HSL and RGB values through the methods SetHSL and SetRGB.

The following properties and methods use Domino® color values:

NotesRichTextSection: BarColor, SetBarColor
NotesRichTextStyle: NotesColor
NotesRichTextTable: AlternateColor, Color, SetAlternateColor, and SetColor