文書中の特定のデータを表します。
ユーザーインターフェースでは文書のアイテムはフォームのフィールドを介して表示されます。フォームのフィールドと文書のアイテムの名前が同じとき、アイテムはフィールドに表示されます。例えば、Subject アイテムは [Subject] フィールドとして表示されます。
LotusScript® を使用すると、ユーザーインターフェースでどのようなフォームが文書の表示に使用されていても、文書のすべてのアイテムにアクセスできます。
NotesItem クラスを継承するクラスには NotesRichTextItem があります。
NotesItem オブジェクトを新規に作成する方法は 2 つあります。
New は指定された文書に指定された名前と値を持つアイテムを作成します。アイテムのデータ型はアイテムに与えられる値に応じて変わります。
変更した文書をディスクに保存するには、文書で Save を呼び出さなければなりません。文書の表示に使用されるフォーム上に新規アイテムと同じ名前のフィールドがない場合は、この新規アイテムはユーザーインターフェースには表示されません。
Dim variableName As New NotesItem( notesDocument , name$ , value [, specialType% ] )
または
Set notesItem = New NotesItem( notesDocument , name$ , value [, specialType% ] )
notesDocument
アイテムを作成する文書です。
name$
String 型。新規アイテムの名前です。
value
新規アイテムに割り当てる値です。value のデータ型によって、Notes が作成するアイテムの種類が決まります。
| value のデータ型 |
作成される Notes アイテム |
|
|---|---|---|
| String |
value を含むテキストアイテム (specialType% を使った場合、Names、Readers、Authors のいずれかになります) |
|
| String 型の配列 |
value の各要素を含むテキストアイテム (specialType% を使った場合、Names、Readers、Authors のいずれかになります) |
|
| Long 型、Integer 型、Double 型、Single 型、Currency 型 |
value を含む数値アイテム |
|
| Long 型、Integer 型、Double 型、Single 型、Currency 型の配列 |
value の各要素を含む数値アイテム |
|
| DATE 形式の Variant 型、または NotesDateTime 型 |
value を含む日時アイテム |
|
| DATE 形式の Variant 型の配列、または NotesDateTime 型の配列 |
value の各要素を含む日時アイテム |
|
| NotesItem |
データ型と値が NotesItem と一致するアイテム |
必要に応じて型変換が発生します。例えば、浮動小数点数値アイテムは倍精度であるため、Single 型の値は Double 型に変換されてから保存されます。
specialType%
オプション。Integer 型の定数。テキストアイテムの種類を Names、Readers、Authors のどれにするのかを指定します。定数は、NAMES、READERS、または AUTHORS のいずれかでなければなりません。specialType% を使用するには value パラメータに文字列か文字列の配列が指定されていなければなりません。
New で NotesItem を作成するとき、アイテムの IsSummary プロパティにはデフォルトで False が設定されます。そのため、アイテムの値はビューまたはフォルダに表示されません。
既存の NotesItem オブジェクトにアクセスするには次に示すいくつかの方法があります。
NotesDocument は、NotesItem オブジェクトを宣言せずにアイテムに直接アクセスできるメソッドを提供します。これに必要なものはアイテム名だけです。
さらに、アイテム名を NotesDocument オブジェクトのプロパティとして使用できます。例えば、次のスクリプト行は文書の Subject アイテムの値を「Hello」に設定します。
doc.Subject = "Hello"NotesRichTextItem は NotesItem のプロパティとメソッドを継承し、さらに、リッチテキストフィールドの操作に使用されるプロパティとメソッドを持ちます。
アイテムを作成または変更した後は、親文書の Save メソッドを呼び出して変更を保存しなければなりません。
Save を呼び出さないでスクリプトを終了したときは、NotesItem オブジェクトに加えたすべての変更が失われます。