DocumentContext (NotesSession - LotusScript)

読み込み専用。 エージェントが実行されたときにメモリ内にある文書です。

注: このプロパティは COM に実装されていません。

定義位置

NotesSession

データ型

NotesDocument

構文

取得する場合: Set notesDocument = notesSession .DocumentContext

使用法

Notes クライアント UI を介してビュー内でアクティブになったエージェントの場合、メモリ内の文書は、ビュー内でハイライト表示されている文書です。

「新規メールの受信前」にアクティブになったエージェントの場合、メモリ内の文書は、配信する予定のメールです。エージェントは、各メールがメールデータベースに保存されようとすると瞬時にアクティブになるため、エージェントを実行するたびに未保存文書を 1 つ処理することになります。NotesDatabase.UnprocessedDocuments プロパティは、このエージェントタイプの文書を返しません。

OpenAgent URL コマンドを使用してブラウザから実行したエージェントの場合、メモリ内の文書は、Domino® によりサポートされている CGI (コモンゲートウェイインターフェース) 変数ごとにアイテムがある新規文書です。各アイテムには、サポートされている CGI 変数の名前と現在の値があります。 (デザインの変更をする必要はありません。CGI 変数は自動的に有効になります。)

@Command([RunAgent]) または @Command[ToolsRunMacro] を使用してブラウザから実行したエージェントの場合、メモリ内の文書は現在の文書です。 WebQueryOpen の場合は、Domino によって HTML に変換され、ブラウザに送られる前の文書です。WebQuerySave の場合は、Domino によって保存される前の文書です。文書の基本となっているフォームに、Domino によってサポートされている CGI 変数と同じ名前のフィールドがある場合は、メモリ内の文書にもその変数の値が含まれます。 (CGI 変数は、非表示フィールドのように、フォームで明示的に設計しなければなりません。)

Domino でサポートされる CGI 変数のリストについては、『アプリケーション開発者ガイド 』の「CGI 変数名の一覧」を参照してください。

スケジュールされたエージェント、メール受信前、メール到着後、Domino サーバーで実行されていて Web ブラウザから呼び出されないエージェントの場合、現在の文書はないため、このプロパティは何も返しません。 このようなエージェントには、代わりに UnprocessedDocuments を使用します。

外部プログラムは、C API または C++ API を介してメモリ内の文書を作成し、その後エージェントを実行できます。 エージェントは、このプロパティを使用してメモリ内の文書にアクセスできます。

Save メソッドは、DocumentContext が返した NotesDocument オブジェクトによって示される文書を即座に更新します。Notes クライアントで選択した文書を処理するエージェントの場合、変更内容を保持するためには、終了前に保存する必要があります。ブラウザから呼び出されたエージェントの場合は、エージェントが終了すると、すべての変更内容がブラウザに戻ります。多くの場合、終了前の保存は望ましくありませんが、ブラウザが変更内容を処理するようにします。

DocumentContext で返された NotesDocument ブジェクトに対し、暗号または削除のメソッドを使用できません。また、DocumentContext で返された NotesDocument オブジェクトを含む NotesDatabase ベースオブジェクトに対し、圧縮のメソッドを使用できません。

クロスリファレンス

Java™ AgentContext クラスの DocumentContext プロパティ