ReplaceItemValue (NotesDocument - LotusScript®)

指定された名前のすべてのアイテムを 1 つの新規アイテムに置き換えます。新規アイテムには指定された値が割り当てられます。文書に指定された名前のアイテムがないとき、このメソッドはアイテムを新規に作成して文書に追加します。

定義位置

NotesDocument

構文

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

パラメータ

itemName$

String 型。置換したいアイテムの名前です。

value

新規アイテムの値です。新規アイテムのデータ型は値のデータ型に応じて変わります。置換前のアイテムのデータ型と一致する必要はありません。

注: ReplaceItemValue メソッドは NotesDateTime オブジェクトを入力として直接使用します。

value のデータ型	作成される Notes アイテム
String	value を含むテキストアイテム
String 型の配列	value の各要素を含むテキストアイテム
Long 型、Integer 型、Double 型、Single 型、Currency 型	value を含む数値アイテム
Long 型、Integer 型、Double 型、Single 型、Currency 型の配列	value の各要素を含む数値アイテム
DATE 形式の Variant 型、NotesDateTime 型、NotesDateRange 型	value を含む日時アイテム
DATE 形式の Variant 型の配列、NotesDateTime 型の配列、NotesDateRange 型の配列	value の各要素を含む日時アイテム
NotesItem	データ型と値が NotesItem と一致するアイテム

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

戻り値

notesItem

NotesItem. 新規アイテムを返します。指定した名前のアイテムはすべてこのアイテムによって置き換えられます。新規アイテムは新しい value を持ちます。新しい値のデータ型は以前の値のデータ型と違う場合があります。

使用法

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

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

リッチテキストアイテム (または MIME エンティティ) の値を置換するためにこのメソッドを使用しないでください。ただし、それをテキストアイテムに変更したい場合を除きます。リッチテキストアイテムの内容を置き換える場合には、NotesDocument.RemoveItem または NotesRichTextItem.Remove を使用して古いアイテムを削除し、NotesDocument.CreateRichTextItem を使用して同じ名前で新しいアイテムを作成し、NotesRichTextItem.AppendText とその他のメソッドを使用して新しい内容を追加します。

「拡張クラス」構文

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

Dim item As NotesItem
Set item = doc.ReplaceItemValue _
( "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 クラスのプロパティであるかのように扱われています。拡張クラス構文の実行結果は ReplaceItemValue の場合と同じです。ただし、ReplaceItemValue は作成されたアイテムを表す NotesItem オブジェクトを返すことと、IsSummary プロパティはデフォルトで True が設定されることが、ReplaceItemValue と異なっています。

1 回限りのスクリプトでこの構文が使用できる場合、次の理由により ReplaceItemValue を優先的に使用します。

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

クロスリファレンス

Java™ Document クラスの replaceItemValue メソッド

式言語の @SetField 関数

式言語の @SetDocField 関数

式言語の FIELD キーワード

例