「マクロリファレンス:3:Editor オブジェクト」の版間の差分
編集の要約なし |
編集の要約なし |
||
| 1行目: | 1行目: | ||
=メソッド= | = メソッド = | ||
==CloseAll メソッド== | == CloseAll メソッド == | ||
すべての文書を閉じます。 | すべての文書を閉じます。 | ||
| 8行目: | 8行目: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==ExecuteCommandByID メソッド== | == ExecuteCommandByID メソッド == | ||
指定した ID のコマンドを実行します。ExecuteCommandByID メソッドはサポート対象外で、すべてのコマンドが使用できるとは限りません。 | 指定した ID のコマンドを実行します。ExecuteCommandByID メソッドはサポート対象外で、すべてのコマンドが使用できるとは限りません。 | ||
| 20行目: | 20行目: | ||
:実行するコマンドの ID を数値で指定します。ID は[https://github.com/haijinboys/mery-plugin-sdk/blob/master/Delphi/Basic/mPlugin.pas プラグインソフトウェア開発キット]の MEID_ から始まる定数を参照してください。 | :実行するコマンドの ID を数値で指定します。ID は[https://github.com/haijinboys/mery-plugin-sdk/blob/master/Delphi/Basic/mPlugin.pas プラグインソフトウェア開発キット]の MEID_ から始まる定数を参照してください。 | ||
==FindInFiles メソッド== | == FindInFiles メソッド == | ||
指定された文字列をファイルから検索します。 | 指定された文字列をファイルから検索します。 | ||
| 54行目: | 54行目: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==NewFile メソッド== | == NewFile メソッド == | ||
文書を新規作成します。 | 文書を新規作成します。 | ||
| 62行目: | 62行目: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==OpenFile メソッド== | == OpenFile メソッド == | ||
文書を開きます。 | 文書を開きます。 | ||
| 136行目: | 136行目: | ||
|} | |} | ||
==QueryStatusByID メソッド== | == QueryStatusByID メソッド == | ||
指定した ID のコマンドが有効かどうかを取得します。QueryStatusByID メソッドはサポート対象外で、すべてのコマンドが使用できるとは限りません。 | 指定した ID のコマンドが有効かどうかを取得します。QueryStatusByID メソッドはサポート対象外で、すべてのコマンドが使用できるとは限りません。 | ||
| 157行目: | 157行目: | ||
|} | |} | ||
==ReadSettingInteger メソッド== | == ReadSettingInteger メソッド == | ||
INI ファイルから指定された項目の値を数値として読み込みます。 | INI ファイルから指定された項目の値を数値として読み込みます。 | ||
| 173行目: | 173行目: | ||
:セクションまたは項目が存在しないか、値が空の場合の既定値を指定します。 | :セクションまたは項目が存在しないか、値が空の場合の既定値を指定します。 | ||
==ReadSettings メソッド== | == ReadSettings メソッド == | ||
INI ファイルから設定を読み込み、エディターウィンドウの設定を更新します。WriteSettingInteger、WriteSettingString で書き込んだ設定をエディターウィンドウに反映させたい場合などに使用します。(すべての設定が反映されるわけではありません) | INI ファイルから設定を読み込み、エディターウィンドウの設定を更新します。WriteSettingInteger、WriteSettingString で書き込んだ設定をエディターウィンドウに反映させたい場合などに使用します。(すべての設定が反映されるわけではありません) | ||
| 181行目: | 181行目: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==ReadSettingString メソッド== | == ReadSettingString メソッド == | ||
INI ファイルから指定された項目の値を文字列として読み込みます。 | INI ファイルから指定された項目の値を文字列として読み込みます。 | ||
| 197行目: | 197行目: | ||
:セクションまたは項目が存在しないか、値が空の場合の既定値を指定します。 | :セクションまたは項目が存在しないか、値が空の場合の既定値を指定します。 | ||
==ReplaceInFiles メソッド== | == ReplaceInFiles メソッド == | ||
指定された文字列をファイルから置換します。 | 指定された文字列をファイルから置換します。 | ||
| 233行目: | 233行目: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==SaveAll メソッド== | == SaveAll メソッド == | ||
すべての文書を保存します。 | すべての文書を保存します。 | ||
| 241行目: | 241行目: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==SaveCloseAll メソッド== | == SaveCloseAll メソッド == | ||
すべての文書を保存して閉じます。 | すべての文書を保存して閉じます。 | ||
| 249行目: | 249行目: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==WriteSettingInteger メソッド== | == WriteSettingInteger メソッド == | ||
INI ファイルに指定された項目の値を数値として書き込みます。 | INI ファイルに指定された項目の値を数値として書き込みます。 | ||
| 265行目: | 265行目: | ||
:設定する項目の値を指定します。 | :設定する項目の値を指定します。 | ||
==WriteSettings メソッド== | == WriteSettings メソッド == | ||
現在のエディターウィンドウの設定を INI ファイルに書き込みます。通常、INI ファイルは [オプション] ダイアログで [OK] ボタンを押したときと、アプリケーションを終了したときに更新されますが、メニューから変更した設定を強制的に INI ファイルに反映させたい場合などに使用します。(すべての設定が反映されるわけではありません) | 現在のエディターウィンドウの設定を INI ファイルに書き込みます。通常、INI ファイルは [オプション] ダイアログで [OK] ボタンを押したときと、アプリケーションを終了したときに更新されますが、メニューから変更した設定を強制的に INI ファイルに反映させたい場合などに使用します。(すべての設定が反映されるわけではありません) | ||
| 273行目: | 273行目: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==WriteSettingString メソッド== | == WriteSettingString メソッド == | ||
INI ファイルに指定された項目の値を文字列として書き込みます。 | INI ファイルに指定された項目の値を文字列として書き込みます。 | ||
| 289行目: | 289行目: | ||
:設定する項目の値を指定します。 | :設定する項目の値を指定します。 | ||
=プロパティ= | = プロパティ = | ||
==ActiveDocument プロパティ== | == ActiveDocument プロパティ == | ||
現在の Document オブジェクトを取得します。 | 現在の Document オブジェクトを取得します。 | ||
| 298行目: | 298行目: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==Documents プロパティ== | == Documents プロパティ == | ||
現在のエディターウィンドウで開いている Documents コレクションを取得します。 | 現在のエディターウィンドウで開いている Documents コレクションを取得します。 | ||
| 306行目: | 306行目: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==EnableTab プロパティ== | == EnableTab プロパティ == | ||
タブが有効かどうかを true か false で取得します。 | タブが有効かどうかを true か false で取得します。 | ||
| 314行目: | 314行目: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==FullName プロパティ== | == FullName プロパティ == | ||
Mery の実行ファイル (Mery.exe) のパスを文字列で取得します。 | Mery の実行ファイル (Mery.exe) のパスを文字列で取得します。 | ||
| 322行目: | 322行目: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==Tag プロパティ== | == Tag プロパティ == | ||
オブジェクトに関するその他の情報を格納する Scripting.Dictionary 型の変数を取得します。変数はエディターウィンドウが閉じられるまで有効です。 | オブジェクトに関するその他の情報を格納する Scripting.Dictionary 型の変数を取得します。変数はエディターウィンドウが閉じられるまで有効です。 | ||
| 339行目: | 339行目: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==Version プロパティ== | == Version プロパティ == | ||
Mery のバージョンを文字列で取得します。 | Mery のバージョンを文字列で取得します。 | ||
2022年9月24日 (土) 17:51時点における版
メソッド
CloseAll メソッド
すべての文書を閉じます。
- 構文
editor.CloseAll();
ExecuteCommandByID メソッド
指定した ID のコマンドを実行します。ExecuteCommandByID メソッドはサポート対象外で、すべてのコマンドが使用できるとは限りません。
- 構文
editor.ExecuteCommandByID(id);
- 引数
id
- 実行するコマンドの ID を数値で指定します。ID はプラグインソフトウェア開発キットの MEID_ から始まる定数を参照してください。
FindInFiles メソッド
指定された文字列をファイルから検索します。
- 構文
editor.FindInFiles(strFind, strPath, flags);
- 引数
strFind
- 検索する文字列を指定します。
strPath
- 検索するパスを指定します。ワイルドカード (* または ?) を含めてファイル名を指定します。複数のファイル名を指定する場合はセミコロン (;) で区切ります。
flags
- 次の値を指定します。
meFindReplaceCase 大文字と小文字を区別します。 meFindReplaceOnlyWord 単語のみ検索します。 meFindReplaceRegExp 正規表現を使用します。 meFindRecursive サブフォルダーも検索します。 meFindFileNamesOnly ファイル名のみ表示します。 meFindKeepOptions ファイルから検索ダイアログのオプションを維持します。
- 例
editor.FindInFiles("検索する文字列", "C:\\Mery\\*.txt;*.js", meFindReplaceCase | meFindRecursive);
NewFile メソッド
文書を新規作成します。
- 構文
editor.NewFile();
OpenFile メソッド
文書を開きます。
- 構文
editor.OpenFile(fileName [, encoding, flags]);
- 引数
fileName
- ファイル名を指定します。
encoding
- 次の値を指定します。省略すると自動選択が使用されます。
meEncodingNone 自動選択 meEncodingUTF16LE UTF-16LE meEncodingUTF16LEBOM UTF-16LE (BOM付き) meEncodingUTF16LENoBOM UTF-16LE (BOM無し) meEncodingUTF16BE UTF-16BE meEncodingUTF16BEBOM UTF-16BE (BOM付き) meEncodingUTF16BENoBOM UTF-16BE (BOM無し) meEncodingUTF8 UTF-8 meEncodingUTF8BOM UTF-8 (BOM付き) meEncodingUTF8NoBOM UTF-8 (BOM無し) meEncodingUTF7 UTF-7 meEncodingArabic アラビア語 meEncodingBaltic バルト言語 meEncodingCentralEuropean 中央ヨーロッパ言語 meEncodingChineseSimplified 簡体字中国語 (GB2312) meEncodingChineseTraditional 繁体字中国語 (Big5) meEncodingCyrillic キリル言語 meEncodingGreek ギリシャ語 meEncodingHebrew ヘブライ語 meEncodingEUC 日本語 (EUC) meEncodingJIS 日本語 (JIS) meEncodingShiftJIS 日本語 (シフト JIS) meEncodingKorean 韓国語 meEncodingThai タイ語 meEncodingTurkish トルコ語 meEncodingVietnamese ベトナム語 meEncodingWesternEuropean 西ヨーロッパ言語
flags
- 次の値を指定します。省略すると現在の文書を閉じて開きます。
meOpenAllowNewWindow 現在の文書が変更されている場合に新しいタブまたはウィンドウで開きます。
QueryStatusByID メソッド
指定した ID のコマンドが有効かどうかを取得します。QueryStatusByID メソッドはサポート対象外で、すべてのコマンドが使用できるとは限りません。
- 構文
var result = editor.QueryStatusByID(id);
- 引数
id
- 実行するコマンドの ID を指定します。ID はプラグインソフトウェア開発キットの MEID_ から始まる定数を参照してください。
- 戻り値
result
- 次の値の組み合わせです。
meStatusEnabled コマンドが有効です。 meStatusChecked コマンドがチェックされています。
ReadSettingInteger メソッド
INI ファイルから指定された項目の値を数値として読み込みます。
- 構文
n = editor.ReadSettingInteger(strSection, strIdent, nDefault);
- 引数
strSection
- 取得する項目のセクションを指定します。
strIdent
- 取得する項目の名前を指定します。
nDefault
- セクションまたは項目が存在しないか、値が空の場合の既定値を指定します。
ReadSettings メソッド
INI ファイルから設定を読み込み、エディターウィンドウの設定を更新します。WriteSettingInteger、WriteSettingString で書き込んだ設定をエディターウィンドウに反映させたい場合などに使用します。(すべての設定が反映されるわけではありません)
- 構文
editor.ReadSettings();
ReadSettingString メソッド
INI ファイルから指定された項目の値を文字列として読み込みます。
- 構文
str = editor.ReadSettingString(strSection, strIdent, strDefault);
- 引数
strSection
- 取得する項目のセクションを指定します。
strIdent
- 取得する項目の名前を指定します。
strDefault
- セクションまたは項目が存在しないか、値が空の場合の既定値を指定します。
ReplaceInFiles メソッド
指定された文字列をファイルから置換します。
- 構文
editor.ReplaceInFiles(strFind, strReplace, strPath, flags);
- 引数
strFind
- 検索する文字列を指定します。
strReplace
- 置換後の文字列を指定します。
strPath
- 検索するパスを指定します。ワイルドカード (* または ?) を含めてファイル名を指定します。複数のファイル名を指定する場合はセミコロン (;) で区切ります。
flags
- 次の値を指定します。
meFindReplaceCase 大文字と小文字を区別します。 meFindReplaceOnlyWord 単語のみ検索します。 meFindReplaceRegExp 正規表現を使用します。 meFindRecursive サブフォルダーも検索します。 meReplaceBackup バックアップを保存します。 meFindKeepOptions ファイルから検索ダイアログのオプションを維持します。
- 例
editor.ReplaceInFiles("検索する文字列", "置換後の文字列", "C:\\Mery\\*.txt;*.js", meFindReplaceCase | meFindRecursive | meReplaceBackup);
SaveAll メソッド
すべての文書を保存します。
- 構文
editor.SaveAll();
SaveCloseAll メソッド
すべての文書を保存して閉じます。
- 構文
editor.SaveCloseAll();
WriteSettingInteger メソッド
INI ファイルに指定された項目の値を数値として書き込みます。
- 構文
n = editor.WriteSettingInteger(strSection, strIdent, nValue);
- 引数
strSection
- 設定する項目のセクションを指定します。
strIdent
- 設定する項目の名前を指定します。
nValue
- 設定する項目の値を指定します。
WriteSettings メソッド
現在のエディターウィンドウの設定を INI ファイルに書き込みます。通常、INI ファイルは [オプション] ダイアログで [OK] ボタンを押したときと、アプリケーションを終了したときに更新されますが、メニューから変更した設定を強制的に INI ファイルに反映させたい場合などに使用します。(すべての設定が反映されるわけではありません)
- 構文
editor.WriteSettings();
WriteSettingString メソッド
INI ファイルに指定された項目の値を文字列として書き込みます。
- 構文
str = editor.WriteSettingString(strSection, strIdent, strValue);
- 引数
strSection
- 設定する項目のセクションを指定します。
strIdent
- 設定する項目の名前を指定します。
strValue
- 設定する項目の値を指定します。
プロパティ
ActiveDocument プロパティ
現在の Document オブジェクトを取得します。
- 構文
var doc = editor.ActiveDocument;
Documents プロパティ
現在のエディターウィンドウで開いている Documents コレクションを取得します。
- 構文
var docs = editor.Documents;
EnableTab プロパティ
タブが有効かどうかを true か false で取得します。
- 構文
var b = editor.EnableTab;
FullName プロパティ
Mery の実行ファイル (Mery.exe) のパスを文字列で取得します。
- 構文
var s = editor.FullName;
Tag プロパティ
オブジェクトに関するその他の情報を格納する Scripting.Dictionary 型の変数を取得します。変数はエディターウィンドウが閉じられるまで有効です。
- 構文
var dic = editor.Tag;
- 例
var dic = editor.Tag;
if (!dic.exists("key1")) {
dic("key1") = "Value1";
}
alert(dic("key1"));
Version プロパティ
Mery のバージョンを文字列で取得します。
- 構文
var s = editor.Version;