AppendItemValue (NotesDocument - LotusScript®)

文書に新規のアイテムを作成してアイテムの値を設定します。

注: 一般に、appendItemValue よりも replaceItemValue のほうがよく使用されます。文書内に同名のアイテムがある場合、appendItemValue では同じ名前の 2 番目のアイテムが作成されますが、回避策を使用しないかぎり重複アイテムにアクセスできません。新規文書を作成する場合は、AppendItemValue が安全です。

定義位置

NotesDocument

構文

Set notesItem = notesDocument .AppendItemValue( itemName$ , value )

パラメータ

itemName$

String 型。新規アイテムの名前です。

value

新規アイテムの値です。新規アイテムのデータ型は、アイテムに設定する値のデータ型に応じて変わります。

 

value のデータ型

作成される IBM Notes アイテム
 

String

value を含むテキストアイテム
 

String 型の配列

配列の各要素に対応する値を持つ多値テキストアイテム
 

Long 型、Integer 型、Double 型、Single 型、Currency 型

value を含む数値アイテム
 

Long 型、Integer 型、Double 型、Single 型、Currency 型の配列

配列の各要素に対応する値を持つ多値数値アイテム
 

DATE 形式の Variant 型、または NotesDateTime 型

value を含む日時アイテム
 

DATE 形式の Variant 型の配列、または NotesDateTime 型の配列

配列の各要素に対応する値を持つ多値日時アイテム
 

NotesItem

データ型と値が NotesItem と一致するアイテム

必要に応じて型変換が発生します。例えば、浮動小数点数値アイテムは倍精度であるため、Single 型の値は Double 型に変換されてから保存されます。

戻り値

notesItem

NotesItem。新規アイテムを返します。

使用法

新規アイテムを文書に保存するには、AppendItemValue を呼び出した後に Save メソッドを呼び出す必要があります。

文書に itemName$ というアイテムが既にあるとき、AppendItemValue は既存のアイテムを新規アイテムに置換しません。代わりにそれは、同じ名前のアイテムを作成し、指定された値を与えます。

新規アイテムの IsSummary プロパティはデフォルトで True が設定されます。つまり、アイテムの値はビューかフォルダで表示できます。

「拡張クラス」構文

NotesDocument「拡張クラス」構文を使用しても文書にアイテムを作成できます。NotesDocument「拡張クラス」構文を使用すると、AppendItemValue を使用する必要がありません。例えば次のようなスクリプトがあるとします。

Dim item As NotesItem
Set item = doc.AppendItemValue _
( "Subject", "Update on stock options" )
Call doc.Save( False, True )

次のスクリプトを実行すると上記のスクリプトと同じ結果になります。

doc.Subject = "Update on stock options"
Call doc.Save( False, True )

この構文ではアイテム名を NotesDocument のプロパティとして使用することにより、NotesDocument を「拡張クラス」として扱えます。前の例では、「Subject」は NotesDocument クラスのプロパティであるかのように扱われています。実行結果は AppendItemValue の場合と同じです。ただし、動作に次の違いがあることに注意してください。

  • 指定された名前のアイテムが既にあるときには、AppendItemValue は同じ名前のアイテムを新規に作成します。それに対し、拡張クラス構文は、ReplaceItemValue メソッドと同様に動作し、新しい値を含むアイテムによって既存のすべてのアイテムを置換します。
  • AppendItemValue は作成したアイテムを表す NotesItem オブジェクトを返します。

1 回限りのスクリプトでこの構文を使用する場合、

次の理由により appendItemValue を使用します。

  • 作成したコードを他の人が読む場合、拡張構文は NotesDocument のメソッドまたはプロパティと混同されやすい
  • 将来のリリースでアイテム名が競合するメソッドまたはプロパティが追加された場合に、作成したコードが正しく機能しなくなる場合がある
  • AppendItemValue のほうがやや効率的

クロスリファレンス

Java Document クラスの appendItemValue メソッド

例