18.01.2013 Views

LotusScript for Visual Basic Programmers - IBM Redbooks

LotusScript for Visual Basic Programmers - IBM Redbooks

LotusScript for Visual Basic Programmers - IBM Redbooks

SHOW MORE
SHOW LESS

Create successful ePaper yourself

Turn your PDF publications into a flip-book with our unique Google optimized e-Paper software.

NotesItem<br />

In the user interface, Notes displays items in a document through fields on<br />

a <strong>for</strong>m. When a field on a <strong>for</strong>m and an item in a document have the same<br />

name, the field displays the item (<strong>for</strong> example, the Subject field displays the<br />

Subject item). All of the items in a document are accessible through<br />

<strong>LotusScript</strong>, regardless of what <strong>for</strong>m is used to display the document in the<br />

user interface.<br />

The NotesItem class is contained by NotesDocument. You can create<br />

a new NotesItem object from one that already exists using the<br />

CopyItemToDocument method of NotesItem or using the CopyItem or<br />

ReplaceItemValue methods of NotesDocument. You can also create one<br />

from scratch using the New method of NotesItem or using the<br />

AppendItemValue or ReplaceItemValue methods of NotesDocument.<br />

You must call Save on the document if you want the modified document to<br />

be saved to disk. The document will not display the new item in the user<br />

interface unless there is a field of the same name on the <strong>for</strong>m used to<br />

display the document.<br />

Method Description<br />

New Creates a new NotesItem object.<br />

Abstract Abbreviates the contents of a text item.<br />

AppendToTextList For an item that’s a text list, adds a new value to the<br />

item without erasing any existing values.<br />

Contains Given a value, checks if the value matches at least<br />

one of the item’s values exactly.<br />

CopyItemToDocument Copies an item to a specified document.<br />

Remove Permanently deletes an item from a document.<br />

Property Description<br />

DateTimeValue Read-Write. For a date-time item, returns a<br />

NotesDateTime object representing the value of the<br />

item. For items of other types, returns Nothing.<br />

IsAuthors Read-only. Indicates whether or not an item is of<br />

type Authors. An Authors item contains a list of<br />

Notes user names, indicating people who have<br />

Author access to a particular document.<br />

IsEncrypted Read-Write. Indicates if an item is encrypted.<br />

Continued<br />

Chapter 3: <strong>LotusScript</strong> Notes Classes 67

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!