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

INatAutoProgram

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


機能

プログラムエディタウィンドウで現在開かれている開発オブジェクト。 これに含まれる開発オブジェクトタイプは、プログラム、サブプログラム、サブルーチン、ファンクション、ヘルプルーチン、コピーコード、テキスト、およびクラスです。 タイプは数値 ID で識別されます。 定義済みタイプの ID は「定義済みノードタイプ」セクションに記載されています。

Top of page

プロパティ

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

Parent

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

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

Studio

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

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

Source

開発オブジェクトのソースコード。

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

Visible

エディタウィンドウの表示/非表示を切り替えます。

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

Type

開発オブジェクトタイプです。 タイプは数値 ID によって識別されます。 定義済みタイプの ID は「定義済みノードタイプ」セクションに記載されています。

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

LineCount

ソースコードの行数です。

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

Top of page

メソッド

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

Catalog

オブジェクトをカタログします。 プログラム、サブプログラム、サブルーチン、関数、ヘルプルーチン、およびクラスに適用可能です。

パラメータ

名前 Natural データフォーマット 変形タイプ 注釈
Quiet L VT_BOOL オプション
Quiet

TRUE に設定されている場合は、メソッドはユーザーが操作しなくても実行されます。 デフォルトは FALSE です。

Check

オブジェクトをチェックします。 プログラム、サブプログラム、サブルーチン、関数、ヘルプルーチン、およびクラスに適用可能です。

パラメータ

名前 Natural データフォーマット 変形タイプ 注釈
Quiet L VT_BOOL オプション
Quiet

TRUE に設定されている場合は、メソッドはユーザーが操作しなくても実行されます。 デフォルトは FALSE です。

Clear

エディタの内容をクリアします。

パラメータ

名前 Natural データフォーマット 変形タイプ 注釈
Quiet L VT_BOOL オプション
Quiet

TRUE に設定されている場合は、メソッドはユーザーが操作しなくても実行されます。 デフォルトは FALSE です。

Close

エディタを閉じて、コレクションからオブジェクトを削除します。

パラメータ

名前 Natural データフォーマット 変形タイプ 注釈
Quiet L VT_BOOL オプション
Quiet

TRUE に設定されている場合は、メソッドはユーザーが操作しなくても実行されます。 デフォルトは FALSE です。

Execute

オブジェクトを実行します。 プログラムに適用可能です。

Format

ソースコードをフォーマットします。

Mode

オブジェクトの複数のモードを設定します。

パラメータ

名前 Natural データフォーマット 変形タイプ 注釈
Structured L VT_BOOL オプション
Uppercase L VT_BOOL オプション
IgnoreTextConstants L VT_BOOL オプション
Structured

ストラクチャードモードを設定します。 デフォルトは Natural パラメータ設定によって決まります。

Uppercase

大文字モードを設定します。 ソースコードは保存中に大文字に変換されます。 デフォルトは FALSE です。

IgnoreTextConstants

大文字変換時にテキスト定数はそのままにしておきます。 デフォルトは FALSE です。

Renumber

ソースコードの番号を再設定します。

Search

指定文字列の最初の一致を検索します。

パラメータ

名前 Natural データフォーマット 変形タイプ 注釈
戻り値 BOOL VT_BOOL  
SearchString A VT_BSTR  
Line I4 VT_I4 参照
Column I4 VT_I4 参照
CaseSensitive L VT_BOOL オプション
WholeWords L VT_BOOL オプション
Up L VT_BOOL オプション
戻り値

一致が検出された場合は TRUE です。

SearchString

検索対象の文字列です。

Line

入力する検索の開始行が含まれています。 返された最初の一致の行が含まれています。

Column

入力する検索の開始列が含まれています。 返された最初の一致の列が含まれています。

CaseSensitive

大文字/小文字を区別して検索します。 デフォルトは FALSE です。

WholeWords

検索文字列に完全に一致する単語のみ検索します。 デフォルトは FALSE です。

Up

上方向に検索します。 デフォルトは FALSE です。

Replace

指定文字列の最初の一致を別の文字列に置換します。

パラメータ

名前 Natural データフォーマット 変形タイプ 注釈
戻り値 BOOL VT_BOOL  
SearchString A VT_BSTR  
ReplaceString A VT_BSTR  
Line I4 VT_I4 参照
Column I4 VT_I4 参照
CaseSensitive L VT_BOOL オプション
WholeWords L VT_BOOL オプション
Up L VT_BOOL オプション
戻り値

一致が検出された場合は TRUE です。

SearchString

検索対象の文字列です。

ReplaceString

検索文字列を置き換える文字列です。

Line

入力する検索の開始行が含まれています。 返された最初の一致の行が含まれています。

Column

入力する検索の開始列が含まれています。 返された最初の一致の列が含まれています。

CaseSensitive

大文字/小文字を区別して検索します。 デフォルトは FALSE です。

WholeWords

検索文字列に完全に一致する単語のみ検索します。 デフォルトは FALSE です。

Up

上方向に検索します。 デフォルトは FALSE です。

Run

オブジェクトを実行します。 プログラムに適用可能です。

パラメータ

名前 Natural データフォーマット 変形タイプ 注釈
Quiet L VT_BOOL オプション
Quiet

TRUE に設定されている場合は、メソッドはユーザーが操作しなくても実行されます。 デフォルトは FALSE です。

Save

オブジェクトを保存します。

パラメータ

名前 Natural データフォーマット 変形タイプ 注釈
Name A VT_BSTR オプション
Library A VT_BSTR オプション
Type I4 VT_I4 オプション
Quiet L VT_BOOL オプション
Name

指定した名前でオブジェクトを保存します。

Library

指定したライブラリにオブジェクトを保存します。

Type

指定したタイプでオブジェクトを保存します。

Quiet

TRUE に設定されている場合は、メソッドはユーザーが操作しなくても実行されます。 デフォルトは FALSE です。

Stow

オブジェクトを格納します。 プログラム、サブプログラム、サブルーチン、関数、ヘルプルーチン、およびクラスに適用可能です。

パラメータ

名前 Natural データフォーマット 変形タイプ 注釈
Name A VT_BSTR オプション
Library A VT_BSTR オプション
Type I4 VT_I4 オプション
Quiet L VT_BOOL オプション
Name

指定した名前でオブジェクトを格納します。

Library

指定したライブラリにオブジェクトを格納します。

Type

指定したタイプでオブジェクトを格納します。

Quiet

TRUE に設定されている場合は、メソッドはユーザーが操作しなくても実行されます。 デフォルトは FALSE です。

Title

無題のオブジェクトにタイトルを付けます。

パラメータ

名前 Natural データフォーマット 変形タイプ 注釈
Name A VT_BSTR オプション
Library A VT_BSTR オプション
Name

オブジェクトに名前を割り当てます。

Library

オブジェクトにライブラリを割り当てます。

GetInfo

開いているオブジェクトに関する情報を返します。

パラメータ

名前 Natural データフォーマット 変形タイプ 注釈
Type I4 VT_I4 参照
Name A VT_BSTR 参照
Library A VT_BSTR 参照
Fnr I4 VT_I4 参照
DBnr I4 VT_I4 参照
Type

オブジェクトのタイプです。

Name

オブジェクトの名前です。

Library

オブジェクトのライブラリです。

Fnr

オブジェクトについてのシステムファイルのファイル番号です。

DBnr

オブジェクトについてのシステムファイルのデータベース番号です。

DeleteLines

ソースコードから行ブロックを削除します。

パラメータ

名前 Natural データフォーマット 変形タイプ 注釈
StartLine I4 VT_I4  
LineCount I4 VT_I4 オプション
StartLine

削除するブロックの開始行です。

LineCount

削除する行数です。 デフォルトは 1 です。

GetLines

ソースコードから行ブロックを取得します。

パラメータ

名前 Natural データフォーマット 変形タイプ 注釈
戻り値 A VT_BSTR  
StartLine I4 VT_I4  
LineCount I4 VT_I4 オプション
戻り値

ソースコード行のブロックです。 行は改行文字で区切られています。

StartLine

返すブロックの開始行です。

LineCount

返す行数です。 デフォルトは 1 です。

InsertLines

ソースコードから行ブロックを挿入します。

パラメータ

名前 Natural データフォーマット 変形タイプ 注釈
戻り値 I4 VT_I4  
Code A VT_BSTR  
InsertAfterLine I4 VT_I4 オプション
戻り値

InsertAfterLine に渡される行番号です。挿入された行数だけ増えます。

Code

挿入するソースコード行のブロックです。 行は改行文字で区切られている必要があります。

InsertAfterLine

コードがこの行の後に挿入されます。 デフォルトは 0 です。

ReplaceLines

ソースコードから行ブロックを置換します。

パラメータ

名前 Natural データフォーマット 変形タイプ 注釈
戻り値 I4 VT_I4  
Code A VT_BSTR  
ReplaceLine I4 VT_I4 オプション
LineCount I4 VT_I4 オプション
戻り値

ReplaceLine に渡される行番号です。挿入された行数だけ増えます。

Code

ReplaceLine および LineCount で定義されたブロックを置換するソースコード行のブロックです。 行は改行文字で区切られている必要があります。

ReplaceLine

置換されるブロックの開始行です。 デフォルトは 1 です。

LineCount

指定したブロックで置換される行数です。 デフォルトは 1 です。

Top of page