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 items in LotusScript® classes
Accessing item properties in LotusScript® classes

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 item properties in LotusScript® classes
        Examples: Accessing item properties
        This example displays properties for a NotesItem object.
      - Getting an item and its values in LotusScript® classes
      - Creating an item and assigning values in LotusScript® classes
      - Copying an item in LotusScript® classes
      - Removing an item in LotusScript® classes
      - Working with a MIME entity in LotusScript® classes
      - Working with custom data
        You can store data of your own format in items. Use the following methods in the Document and Item 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.
- 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.

Accessing item properties in LotusScript® classes


Property	Data type	Description
DateTimeValue	NotesDateTime	(Read-write) Date/time value of an item of type Date/time.
IsAuthors	Boolean	(Read-write) True if the item is of type Authors.
IsEncrypted	Boolean	(Read-write) True if the item is encrypted.
IsNames	Boolean	(Read-write) True if the item is of type Names.
IsProtected	Boolean	(Read-write) True if Editor access is required to modify.
IsReaders	Boolean	(Read-write) True if the item is of type Reader Names.
IsSigned	Boolean	(Read-write) True if the item is signed.
IsSummary	Boolean	(Read-write) True if the item contains summary data. Summary data can be displayed in a view or folder.
LastModified	Date/Time	(Read-only) Date and time the item was last modified.
Name	String	(Read-only) Name of the item.
Parent	NotesDocument	(Read-only) The document that contains the item.
SaveToDisk	Boolean	(Read-write) True if the item is saved to disk when the document is saved.
Text	String	(Read-only) Plain text representation of the item's value.
Type	Integer constant	(Read-only) The data type of an item.
ValueLength	Integer	(Read-only) Size in bytes of an item's values in bytes.
Values	String or double array, or string	(Read-write) Values that an item holds.

The Values property is a string for rich text items, an array of doubles for number and time-date items, and an array of strings for all other data types including plain text. For a single value in a non-rich text item, access element 0. If the item contains multiple values, access each array element, for example, in a Forall loop. Access a rich text item as a simple value, not an array.

The Text property of NotesItem displays the complete Values array with the display separator, typically the semicolon, between elements. This property converts non-text data types to text.