GetFirstItem (NotesDocument - LotusScript)

文書中の指定された名前を持つ第 1 番目のアイテムを返します。

定義位置

NotesDocument

構文

Set notesItem = notesDocument .GetFirstItem( name$ )

パラメータ

name$

String 型。検索したいアイテムの名前です。

戻り値

notesItem

NotesItem または NotesRichTextItem。指定された名前の第 1 番目のアイテムを返します。指定された名前のアイテムが文書に含まれていない場合、Nothing を返します。

使用法

文書の複数アイテムが同じ名前の場合、プログラムでのアクセスは最初のアイテムに制限されます。残りのアイテムには無効なデータが生じます。この対策としては、最初のアイテムを取得し、これを処理して削除し、再び最初のアイテム、つまり 2 つ目のアイテムを取得します。このようにして、同じ名前のアイテムをすべて処理します。文書を保存しないと、アイテムは実際に削除されません。 しかし、推奨される方法は、同じ名前を持つ複数のアイテムの作成を避けることです。

フィールドの値が表示用に計算されるとき、値はアイテムとしては保存されません。オブジェクトが NotesUIDocument の Document プロパティとしてアクセスされない限り、値は NotesDocument オブジェクトからはアクセスできず、GetFirstItem は Nothing を返します。LotusScript® を使用すると、このようなフィールドの値にアクセスできることもあります。例えば、@Created 式を使用して値を表示する [DateComposed] フィールドが文書にあるときは、NotesDocument の Created プロパティを使用してアクセスできます。

このメソッドを使用してリッチテキストアイテムを取得する

この方法を使用して、NotesItem と同様 NotesRichTextItem として宣言された項目も取得できます。

注: 以前のリリースでは、NotesRichTextItem として宣言された項目は取得できませんでした。Variant として宣言する必要がありました。

編集モードで開いている文書からリッチテキストアイテムの内容を取得するには、追加のステップが必要です。リッチテキストアイテムは、ほかのアイテムの種類とは異なり、NotesUIDocument.Document を使用して取得した NotesDocument に NotesUIDocument から自動的にコピーされることはありません。新規文書でリッチテキストを検索すると、GetFirstItem は Nothing を返します。編集中の既存の文書では、現在の値ではなく文書が開かれたときの値が表示されます。フォーム上のデータからバックエンドリッチテキストを強制的に更新するには、NotesUIDocument.Refresh(True) を呼び出します。

関連項目

NotesUIDocument.Refresh

クロスリファレンス

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