
	バージョン 6.3.3	検索索引目次 \| PDF BOOKS \| ホーム上へ戻る次へ

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

INatAutoPlugIn

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

機能
プロパティ
メソッド

機能

インストールされたプラグイン。

プロパティ

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

Parent
Studio
ID
Type
Name
CLSID
ProgID
Active
Automatic
OptionValues

Parent

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

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

Studio

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

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

ID

Natural スタジオでプラグインを識別するグローバルユニーク ID。プラグインを実装している ActiveX コンポーネントの ID と同じです。

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

Type

プラグインのタイプ。

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

有効な値は以下のとおりです。

値	意味
単一サーバー	プラグインは、Natural で作成した他のプラグインとは異なり、独自の Natural サーバープロセスで実行されます。
共有サーバー	プラグインは、プラグインマネージャと同じ Natural サーバープロセスで実行されます。

Name

プラグインマネージャに表示されるプラグインの記述名。

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

CLSID

プラグインを実装している ActiveX コンポーネントの CLSID。 Natural で作成したプラグインの場合は、これは DEFINE CLASS ステートメントで定義された ID です。

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

ProgID

プラグインを実装している ActiveX コンポーネントの ProgID。 Natural で作成したプラグインの場合は、これは DEFINE CLASS ステートメントで定義されたクラス名です。

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

Active

プラグインが現在有効かどうかを示します。このプロパティを変更して、プラグインの有効／無効を切り替えます。

Natural データフォーマット	変形タイプ	注釈
L	VT_BOOL

Automatic

Natural スタジオの開始時に、プラグインが自動的に有効になるか、またはプラグインマネージャを使用して手動で有効にする必要があるかを示します。このプロパティを変更して、アクティベーションモードを変更します。

Natural データフォーマット	変形タイプ	注釈
L	VT_BOOL

OptionValues

このプラグインの現在のオプション値設定を記述する XML ドキュメントを含む文字列。

Natural データフォーマット	変形タイプ	注釈
A	VT_BSTR

XML ドキュメントは次の DTD に従ってフォーマットされています。

<?xml version="1.0" encoding="UTF-8"?>
<!ELEMENT optvals (optval*)>
<!ELEMENT optval (name, value)>
<!ELEMENT name (#PCDATA)>
<!ELEMENT value (#PCDATA)>

エレメント意味

name オプションの名前です。 DefineOptions メソッドで定義された名前にこの名前が対応していない場合は、これは非表示のオプションです。このようなオプションは、ユーザーが［オプション］ダイアログボックスで値を参照したり変更したりすることはできません。対応している場合は、オプションはメソッド DefineOptions で指定されたとおりに［オプション］ダイアログボックスのプロパティページに表示されます。

value オプション値。

エレメント	意味
name	オプションの名前です。 `DefineOptions` メソッドで定義された名前にこの名前が対応していない場合は、これは非表示のオプションです。このようなオプションは、ユーザーが［オプション］ダイアログボックスで値を参照したり変更したりすることはできません。対応している場合は、オプションはメソッド `DefineOptions` で指定されたとおりに［オプション］ダイアログボックスのプロパティページに表示されます。
value	オプション値。

メソッド

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

DefineOptions
GetCustomInterface
OnCommand
OnCommandStatus

DefineOptions

［オプション］ダイアログボックスのプロパティページに表示するこのプラグインのオプションおよびそのレイアウトを定義します。

パラメータ

名前	Natural データフォーマット	変形タイプ	注釈
OptionDefinition	A	VT_BSTR

OptionDefinition

［オプション］ダイアログボックスのプロパティページに表示するプラグインのオプションおよびそのレイアウトを記述する XML ドキュメントを含む文字列。 XML ドキュメントは次の DTD に従ってフォーマットされています。

<?xml version="1.0" encoding="UTF-8"?>
<!ELEMENT optdef (caption, helpfile?, helptopic?, option*, groupbox*, statictext*)>
<!ELEMENT option (name, (checkbox | edittext | radiobuttons | spinbutton))>
<!ELEMENT checkbox (left, top, title, default)>
<!ELEMENT edittext (left, top, width, height, default)>
<!ELEMENT radiobuttons (radiobutton+, default)>
<!ELEMENT radiobutton (left, top, title, value)>
<!ELEMENT spinbutton (left, top, width, height, min, max, default)>
<!ELEMENT groupbox (title, left, top, width, height)>
<!ELEMENT statictext (title, left, top, width, height)>
<!ELEMENT caption (#PCDATA)>
<!ELEMENT helpfile (#PCDATA)>
<!ELEMENT helptopic (#PCDATA)>
<!ELEMENT name (#PCDATA)>
<!ELEMENT title (#PCDATA)>
<!ELEMENT value (#PCDATA)>
<!ELEMENT default (#PCDATA)>
<!ELEMENT left (#PCDATA)>
<!ELEMENT top (#PCDATA)>
<!ELEMENT width (#PCDATA)>
<!ELEMENT height (#PCDATA)>
<!ELEMENT min (#PCDATA)>
<!ELEMENT max (#PCDATA)>

エレメント	意味
caption	プロパティページに表示されるキャプション。
helpfile	オプションに関するヘルプ情報を含むヘルプファイルへの完全パス名。
helptopic	ユーザーがプロパティページで［ヘルプ］ボタンを選択したときに表示されるヘルプトピック。
name	オプションの名前です。この名前は OptionValues DTD のオプションの参照のみを目的として内部的に使用されます。
value	ラジオボタンに割り当てられる値。
default	オプションのデフォルト値。
term	ダイアログコントロールで表示される用語。
left、top、width、height	ダイアログコントロールの位置とサイズ。
min、max	スピンボタンコントロールに表示される最小値と最大値。

GetCustomInterface

このプラグインのカスタムインターフェイスを返します。プラグインにカスタムインターフェイスがない場合は、NULL-HANDLE を返します。

プラグインでは、Natural スタジオ自体とは別に、クライアントにサービスを提供するためにカスタムインターフェイスを利用できます。このクライアントは、Natural スタジオ内外で実行されている他のプラグインやプログラムなどです。カスタムインターフェイスを指定するには、プラグインで 2 つの定義済みインターフェイス INaturalStudioPlugIn および INaturalStudioPlugInTree 以外に追加のインターフェイスを実装し、そのインターフェイスをデフォルトのディスパッチインターフェイスにする必要があります。 Natural に実装されているプラグインでは、DEFINE CLASS ステートメントの最初の位置にこのインターフェイスを配置します。

パラメータ

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

戻り値: このプラグインのカスタムインターフェイス。

OnCommand

プラグインに特定のコマンドを送信します。

パラメータ

名前	Natural データフォーマット	変形タイプ	注釈
CommandID	I4	VT_I4

CommandID: インターフェイス INatAutoCommands のメソッド Add を使用してプラグインがコマンドを定義したときに選択したコマンド ID が含まれています。

OnCommandStatus

プラグインの特定のコマンドが現在有効かどうか、またはチェックされているかどうかを確認します。

パラメータ

名前	Natural データフォーマット	変形タイプ	注釈
CommandID	I4	VT_I4
Enabled	L	VT_BOOL	参照
Checked	L	VT_BOOL	参照

CommandID: インターフェイス INatAutoCommands のメソッド Add を使用してプラグインがコマンドを定義したときに選択したコマンド ID が含まれています。
Enabled: コマンドが現在有効な場合は、メソッドはこのパラメータで TRUE を返します。
Checked: コマンドに現在チェックマークが付いている場合は、メソッドはこのパラメータで TRUE を返します。

検索索引目次 | PDF BOOKS | ホーム上へ戻る次へ