バージョン 6.3.3
 —  プラグインによる Natural スタジオの拡張  —

INatAutoObjectLists

このドキュメントでは、次のトピックについて説明します。


機能

現在開かれているリストビュードキュメントウィンドウのコレクション。

Top of page

プロパティ

次のプロパティを使用できます。

Parent

このインターフェイスの親インターフェイスに移動するために使用します。

Natural データフォーマット 変形タイプ 注釈
HANDLE OF OBJECT DISPATCH(INatAutoObjects 取得のみ

Studio

ルートインターフェイスに移動するために使用します。

Natural データフォーマット 変形タイプ 注釈
HANDLE OF OBJECT VT_DISPATCH(INatAutoStudio 取得のみ

Count

現在開かれているリストビュードキュメントウィンドウの数。

Natural データフォーマット 変形タイプ 注釈
I4 VT_I4 取得のみ

Top of page

メソッド

次のメソッドを使用できます。

Item

コレクションから特定のリストビュードキュメントウィンドウを返します。

パラメータ

名前 Natural データフォーマット 変形タイプ 注釈
戻り値 HANDLE OF OBJECT VT_DISPATCH(INatAutoObjectList  
Index I4 VT_I4  
戻り値

Index で指定された値によって識別されるリストビュードキュメントウィンドウ。

Index

コレクション内の特定のリストビュードキュメントウィンドウを識別します。 これは 1 からカウントまでの値です。

Open

新規リストビュードキュメントウィンドウを開きます。

パラメータ

名前 Natural データフォーマット 変形タイプ 注釈
戻り値 HANDLE OF OBJECT VT_DISPATCH(INatAutoObjectList  
Type I4 VT_I4  
Key A VT_BSTR  
Caption A VT_BSTR  
Template I4 VT_I4 オプション
PlugInID A VT_BSTR オプション
Info A VT_BSTR オプション
DisplayName A VT_BSTR オプション
Children A VT_BSTR オプション
NaturalType I4 VT_I4 オプション
NaturalKey A VT_BSTR オプション
戻り値

新しく開かれたリストビュードキュメント。

Type

ルートオブジェクトのノードタイプです。 これは、定義済み Natural スタジオタイプに対応する可能性があるプラグイン定義タイプである必要があります。

Key

オブジェクトタイプ内のオブジェクトを識別するキーです。

Caption

ドキュメントウィンドウのキャプションを決定します。

Natural スタジオのドキュメントウィンドウで使用されるキャプションフォーマットに一致するキャプションを生成するために、このパラメータに渡される文字列にはフォーマット指定子 %std を含めることができます。 このフォーマット指定子は、次のような方法で、ルートオブジェクトの ID によってダイナミックに置換されます。その方法とは、ルートノードが定義済み Natural スタジオオブジェクトに対応する場合は、フォーマット指定子 %std は "name [library] -" で置換されます。 そうでない場合は、ID が "node-type-caption display-name -" の形式で作成されます。node-type-caption はノードタイプの作成時に渡されたキャプションで、display-name は DisplayName に渡された文字列です。

Template

ここで指定した値はプラグインに戻すことができます。そのタイミングは、ビューを満たすデータを取得するために Natural スタジオがインターフェイス INaturalStudioPlugInTree を使用してプラグインを後で呼び出したときです。 これにより、プラグインは同一のルートオブジェクトにさまざまなデータを提供できます。

PlugInID

タイプを定義したプラグインの ID です。

Info

プラグインからルートオブジェクトに割り当てる必要がある追加情報です。 Natural スタジオはこの情報を解釈しません。 ビューを満たすデータを取得するためにインターフェイス INaturalStudioPlugInTree を使用してプラグインを後で呼び出したときにプラグインに戻すだけです。

DisplayName

ルートノードに表示されるテキストです。

Children

プラグインがすでにルートノードの子ノードを認識している場合、このパラメータでそれらを渡すことができます。 その場合、パラメータは子ノードが記述された XML ドキュメントを保持する必要があります。 XML ドキュメントは、INaturalStudioPlugInTree::GetChildren で定義された DTD に従って構造化されています。 このパラメータを指定した場合は、Natural スタジオはルートノードに子ノードがあると暗黙的にみなし、ルートノードに子ノードがあるかどうかを確認するためのインターフェイス INaturalStudioPlugInTree による呼び出しを実行しません。

NaturalType

ルートノードが定義済み Natural スタジオオブジェクトに対応する場合は、このプロパティには対応する定義済みオブジェクトのタイプが含まれます。

NaturalKey

ルートノードが定義済み Natural スタジオオブジェクトに対応する場合は、このプロパティには対応する定義済みオブジェクトのキーが含まれます。

Top of page