マクロリファレンス:3:Editor オブジェクトのソースを表示

= メソッド =
== CloseAll メソッド ==
すべての文書を閉じます。

;構文
<syntaxhighlight lang="javascript">
editor.CloseAll();
</syntaxhighlight>

;バージョン
Mery Ver 2.6.7 以降で使用できます。

== DeleteSetting メソッド ==
INI ファイルから指定された項目を削除します。

;構文
<syntaxhighlight lang="javascript">
editor.DeleteSetting(strSection, strIdent);
</syntaxhighlight>

;引数
strSection
:削除する項目のセクションを指定します。
strIdent
:削除する項目の名前を指定します。

;バージョン
Mery Ver 3.7.17 以降で使用できます。

== ExecuteCommandByID メソッド ==
指定した ID のコマンドを実行します。ExecuteCommandByID メソッドはサポート対象外で、すべてのコマンドが使用できるとは限りません。

;構文
<syntaxhighlight lang="javascript">
editor.ExecuteCommandByID(id);
</syntaxhighlight>

;引数
id
:実行するコマンドの ID を数値で指定します。ID は[https://github.com/haijinboys/mery-plugin-sdk/blob/master/Delphi/Basic/mPlugin.pas プラグインソフトウェア開発キット]の MEID_ から始まる定数を参照してください。

;バージョン
Mery Ver 2.6.7 以降で使用できます。

== ExecuteMacro メソッド ==
指定したマクロを実行します。

;構文
<syntaxhighlight lang="javascript">
editor.ExecuteMacro(strFileName [, flags]);
</syntaxhighlight>

;引数
strFileName
:実行するマクロ ファイル名、またはマクロ テキストを指定します。

flags
:次の値の組み合わせを指定します。省略すると strFileName はマクロ ファイル名として扱われ、マクロの種類は自動的に選択されます。
:{|class="wikitable"
|meRunFile||strFileName はマクロ ファイル名を指定します。
|-
|meRunText||strFileName はマクロ テキストを指定します。
|-
|meMacroLangJScript||meRunText の場合、マクロを JScript として実行します。
|-
|meMacroLangVBScript||meRunText の場合、マクロを VBScript として実行します。
|-
|meMacroLangChakra||meRunText の場合、マクロを JScript9 として実行します。
|-
|meMacroLangV8||meRunText の場合、マクロを V8 として実行します。
|-
|meMacroAsync||マクロを非同期で実行します。
|}

;バージョン
Mery Ver 3.7.13 以降で使用できます。

== ExecutePlugin メソッド ==
指定したプラグインを実行します。

;構文
<syntaxhighlight lang="javascript">
var n = editor.ExecutePlugin(strPluginFileName [, flag, nParam, strParam]);
</syntaxhighlight>

;引数
strPluginFileName
:実行するプラグインのファイル名を指定します。

flags
:次の値を指定します。
:{|class="wikitable"
|mePluginExecuteCommand||ユーザーがプラグイン コマンドを選択したときのようにプラグインを実行します。この場合、<code>nParam</code> と <code>strParam</code> は無視されます。
|-
|mePluginUserMessage||<code>nParam</code> と <code>strParam</code> を使用して、プラグインにメッセージを送ります。
|-
|mePluginQueryStatus||プラグインの状態を取得します。この場合、<code>nParam</code> と <code>strParam</code> は無視されます。
|}

nParam
:プラグインに渡す整数パラメーターです。意味はプラグインごとに異なります。省略すると 0 が指定されます。

strParam
:プラグインに渡す文字列パラメーターです。意味はプラグインごとに異なります。省略すると空文字列が指定されます。

;戻り値
エラーが発生した場合は負の値を返します。<code>mePluginExecuteCommand</code> が指定された場合、戻り値は 0 です。<code>mePluginUserMessage</code> が指定された場合、戻り値の意味はプラグインごとに異なります。<code>mePluginQueryStatus</code> が指定された場合、戻り値は状態値の組み合わせです。
:{|class="wikitable"
|meStatusEnabled||コマンドが有効です。
|-
|meStatusChecked||コマンドがチェックされています。
|}

;バージョン
Mery Ver 3.8.0 以降で使用できます。

== FileDialog メソッド ==
[開く]、[名前を付けて保存] ダイアログを表示します。

;構文
<syntaxhighlight lang="javascript">
var s = editor.FileDialog(type [, flags, strTitle, strFilter, nFilterIndex, strFileName, strDefaultFolder, strDefaultExt]);
</syntaxhighlight>

;引数
type
:次の値を指定します。
:{|class="wikitable"
|meFileDialogOpen||[開く] ダイアログを表示します。
|-
|meFileDialogSave||[名前を付けて保存] ダイアログを表示します。
|}

flags
:次の値の組み合わせを指定します。
:{|class="wikitable"
|meFileDialogOverwritePrompt||既存のファイル名をユーザーが選択した場合に警告を表示し、上書きするか確認します。(保存ダイアログ用)
|-
|meFileDialogNoChangeDir||ファイルを選択した後、カレント ディレクトリをダイアログ表示前の状態に戻します。
|-
|meFileDialogNoValidate||ファイル名の無効文字チェックを行わず、無効文字を含む名前も選択可能にします。
|-
|meFileDialogPathMustExist||存在しないディレクトリ パスを選択した場合に警告を表示します。
|-
|meFileDialogFileMustExist||存在しないファイルを選択した場合に警告を表示します。(開くダイアログ用)
|-
|meFileDialogCreatePrompt||存在しないファイルを作成する際に警告を表示し、新規作成するか確認します。
|-
|meFileDialogShareAware||共有エラーを無視し、共有違反が発生してもファイル選択を許可します。
|-
|meFileDialogNoReadOnlyReturn||読み取り専用ファイルを選択した場合に警告を表示します。
|-
|meFileDialogNoTestFileCreate||ネットワーク保護やアクセス不可のディスク ドライブのチェックを無効にします。特定の共有ネットワーク ディレクトリでの保存時にのみ有効です。
|-
|meFileDialogNoDereferenceLinks||Windows ショートカットのリンク先ではなく、ショートカット自体 (.LNK ファイル) のパスを返します。
|-
|meFileDialogDontAddToRecent||最近使ったファイルのリストに追加しません。
|}

strTitle
:ダイアログのタイトルを指定します。省略すると既定のタイトルが使用されます。

strFilter
:フィルターを指定します。形式は <code>Text|*.txt|すべてのファイル|*.*</code> のように記述します。

nFilterIndex
:初期状態で選択されるフィルターを 1 基準のインデックスで指定します。

strFileName
:初期状態で選択されるファイル パスを指定します。

strDefaultFolder
:初期状態で選択されるフォルダーを指定します。

strDefaultExt
:既定のファイル拡張子を指定します。

;戻り値
選択されたファイルのパスを返します。ユーザーがキャンセルした場合は <code>null</code> を返します。

;バージョン
Mery Ver 3.8.0 以降で使用できます。

== FindInFiles メソッド ==
指定された文字列をファイルから検索します。

;構文
<syntaxhighlight lang="javascript">
editor.FindInFiles(strFind, strPath, flags [, encoding]);
</syntaxhighlight>

;引数
strFind
:検索する文字列を指定します。
strPath
:検索するパスを指定します。ワイルドカード (* または ?) を含めてファイル名を指定します。複数のフォルダーを指定する場合は縦線 (|)、複数のファイルの種類を指定する場合はセミコロン (;) で区切ります。
flags
:次の値を指定します。
:{|class="wikitable"
|meFindReplaceCase||大文字と小文字を区別します。
|-
|meFindReplaceOnlyWord||単語のみ検索します。
|-
|meFindReplaceRegExp||正規表現を使用します。
|-
|meFindFuzzy||あいまい検索を使用します。
|-
|meFindRecursive||サブフォルダーも検索します。
|-
|meFindFileNamesOnly||ファイル名のみ表示します。
|-
|meFindKeepOptions||ファイルから検索ダイアログのオプションを維持します。
|}

encoding
:ファイルの[[マクロリファレンス:3:エンコード定数|エンコード]]を指定します。省略すると自動選択します。

;例
<syntaxhighlight lang="javascript">
editor.FindInFiles("検索する文字列", "C:\\Temp|C:\\Mery\\*.txt;*.js", meFindReplaceCase | meFindRecursive);
</syntaxhighlight>

;バージョン
Mery Ver 3.7.18 以降で使用できます。

== NewFile メソッド ==
文書を新規作成します。

;構文
<syntaxhighlight lang="javascript">
editor.NewFile();
</syntaxhighlight>

;バージョン
Mery Ver 2.6.7 以降で使用できます。

== OpenFile メソッド ==
文書を開きます。

;構文
<syntaxhighlight lang="javascript">
editor.OpenFile(fileName [, encoding, flags]);
</syntaxhighlight>

;引数
fileName
:ファイル名を指定します。
encoding
:ファイルの[[マクロリファレンス:3:エンコード定数|エンコード]]を指定します。

flags
:次の値を指定します。省略すると現在の文書を閉じて開きます。
:{|class="wikitable"
|meOpenAllowNewWindow||現在の文書が無題でないか、変更されている場合に新しいタブまたはウィンドウで開きます。
|}

;バージョン
Mery Ver 2.6.7 以降で使用できます。

== QueryStatusByID メソッド ==
指定した ID のコマンドが有効かどうかを取得します。QueryStatusByID メソッドはサポート対象外で、すべてのコマンドが使用できるとは限りません。

;構文
<syntaxhighlight lang="javascript">
var n = editor.QueryStatusByID(id);
</syntaxhighlight>

;引数
id
:実行するコマンドの ID を指定します。ID は[https://github.com/haijinboys/mery-plugin-sdk/blob/master/Delphi/Basic/mPlugin.pas プラグインソフトウェア開発キット]の MEID_ から始まる定数を参照してください。

;戻り値
:次の値の組み合わせです。
:{|class="wikitable"
|meStatusEnabled||コマンドが有効です。
|-
|meStatusChecked||コマンドがチェックされています。
|}

;バージョン
Mery Ver 2.6.7 以降で使用できます。

== ReadSettingInteger メソッド ==
INI ファイルから指定された項目の値を数値として読み込みます。

;構文
<syntaxhighlight lang="javascript">
var i = editor.ReadSettingInteger(strSection, strIdent, nDefault);
</syntaxhighlight>

;引数
strSection
:取得する項目のセクションを指定します。
strIdent
:取得する項目の名前を指定します。
nDefault
:セクションまたは項目が存在しないか、値が空の場合の既定値を指定します。

;バージョン
Mery Ver 3.2.6 以降で使用できます。

== ReadSettings メソッド ==
INI ファイルから設定を読み込み、エディターウィンドウの設定を更新します。WriteSettingInteger、WriteSettingString で書き込んだ設定をエディターウィンドウに反映させたい場合などに使用します。(すべての設定が反映されるわけではありません)

;構文
<syntaxhighlight lang="javascript">
editor.ReadSettings([strFile]);
</syntaxhighlight>

;引数
strFile
:設定を読み込む INI ファイルのパスを指定します。相対パスを使用する場合は、Mery.exe からの相対パスとなります。省略すると Mery.ini を読み込みます。

;バージョン
Mery Ver 3.2.6 以降で使用できます。

== ReadSettingString メソッド ==
INI ファイルから指定された項目の値を文字列として読み込みます。

;構文
<syntaxhighlight lang="javascript">
var s = editor.ReadSettingString(strSection, strIdent, strDefault);
</syntaxhighlight>

;引数
strSection
:取得する項目のセクションを指定します。
strIdent
:取得する項目の名前を指定します。
strDefault
:セクションまたは項目が存在しないか、値が空の場合の既定値を指定します。

;バージョン
Mery Ver 3.2.6 以降で使用できます。

== ReplaceInFiles メソッド ==
指定された文字列をファイルから置換します。

;構文
<syntaxhighlight lang="javascript">
editor.ReplaceInFiles(strFind, strReplace, strPath, flags [, encoding]);
</syntaxhighlight>

;引数
strFind
:検索する文字列を指定します。
strReplace
:置換後の文字列を指定します。
strPath
:検索するパスを指定します。ワイルドカード (* または ?) を含めてファイル名を指定します。複数のフォルダーを指定する場合は縦線 (|)、複数のファイルの種類を指定する場合はセミコロン (;) で区切ります。
flags
:次の値を指定します。
:{|class="wikitable"
|meFindReplaceCase||大文字と小文字を区別します。
|-
|meFindReplaceOnlyWord||単語のみ検索します。
|-
|meFindReplaceRegExp||正規表現を使用します。
|-
|meFindFuzzy||あいまい検索を使用します。
|-
|meFindRecursive||サブフォルダーも検索します。
|-
|meReplaceBackup||バックアップを保存します。
|-
|meFindKeepOptions||ファイルから検索ダイアログのオプションを維持します。
|}

encoding
:ファイルの[[マクロリファレンス:3:エンコード定数|エンコード]]を指定します。省略すると自動選択します。

;例
<syntaxhighlight lang="javascript">
editor.ReplaceInFiles("検索する文字列", "置換後の文字列", "C:\\Temp|C:\\Mery\\*.txt;*.js", meFindReplaceCase | meFindRecursive | meReplaceBackup);
</syntaxhighlight>

;バージョン
Mery Ver 3.7.18 以降で使用できます。

== SaveAll メソッド ==
すべての文書を保存します。

;構文
<syntaxhighlight lang="javascript">
editor.SaveAll();
</syntaxhighlight>

;バージョン
Mery Ver 2.6.7 以降で使用できます。

== SaveCloseAll メソッド ==
すべての文書を保存して閉じます。

;構文
<syntaxhighlight lang="javascript">
editor.SaveCloseAll();
</syntaxhighlight>

;バージョン
Mery Ver 2.6.7 以降で使用できます。

== WriteSettingInteger メソッド ==
INI ファイルに指定された項目の値を数値として書き込みます。

;構文
<syntaxhighlight lang="javascript">
editor.WriteSettingInteger(strSection, strIdent, nValue);
</syntaxhighlight>

;引数
strSection
:設定する項目のセクションを指定します。
strIdent
:設定する項目の名前を指定します。
nValue
:設定する項目の値を指定します。

;バージョン
Mery Ver 3.2.6 以降で使用できます。

== WriteSettings メソッド ==
現在のエディターウィンドウの設定を INI ファイルに書き込みます。通常、INI ファイルは [オプション] ダイアログで [OK] ボタンを押したときと、アプリケーションを終了したときに更新されますが、メニューから変更した設定を強制的に INI ファイルに反映させたい場合などに使用します。(すべての設定が反映されるわけではありません)

;構文
<syntaxhighlight lang="javascript">
editor.WriteSettings();
</syntaxhighlight>

;バージョン
Mery Ver 3.2.6 以降で使用できます。

== WriteSettingString メソッド ==
INI ファイルに指定された項目の値を文字列として書き込みます。

;構文
<syntaxhighlight lang="javascript">
editor.WriteSettingString(strSection, strIdent, strValue);
</syntaxhighlight>

;引数
strSection
:設定する項目のセクションを指定します。
strIdent
:設定する項目の名前を指定します。
strValue
:設定する項目の値を指定します。

;バージョン
Mery Ver 3.2.6 以降で使用できます。

= プロパティ =
== ActiveDocument プロパティ ==
現在の Document オブジェクトを取得します。

;構文
<syntaxhighlight lang="javascript">
var obj = editor.ActiveDocument;
</syntaxhighlight>

;バージョン
Mery Ver 2.6.7 以降で使用できます。

== Documents プロパティ ==
現在のエディターウィンドウで開いている Documents コレクションを取得します。

;構文
<syntaxhighlight lang="javascript">
var objs = editor.Documents;
</syntaxhighlight>

;バージョン
Mery Ver 2.6.7 以降で使用できます。

== EnableTab プロパティ ==
タブが有効かどうかを true か false で取得します。

;構文
<syntaxhighlight lang="javascript">
var b = editor.EnableTab;
</syntaxhighlight>

;バージョン
Mery Ver 2.6.7 以降で使用できます。

== FullName プロパティ ==
Mery の実行ファイル (Mery.exe) のパスを文字列で取得します。

;構文
<syntaxhighlight lang="javascript">
var s = editor.FullName;
</syntaxhighlight>

;バージョン
Mery Ver 2.6.7 以降で使用できます。

== Tag プロパティ ==
オブジェクトに関するその他の情報を格納する Scripting.Dictionary 型の変数を取得します。変数はエディターウィンドウが閉じられるまで有効です。

;構文
<syntaxhighlight lang="javascript">
var d = editor.Tag;
</syntaxhighlight>

;例
<syntaxhighlight lang="javascript">
// JScript
var d = editor.Tag;
if (!d.exists("key1")) {
    d("key1") = "Value1";
}
alert(d("key1"));
</syntaxhighlight>

<syntaxhighlight lang="javascript">
// V8
var d = editor.Tag;
if (!d.exists("key1")) {
    d["key1"] = "Value1";
}
alert(d["key1"]);
</syntaxhighlight>

;バージョン
Mery Ver 3.0.0 以降で使用できます。

== Version プロパティ ==
Mery のバージョンを文字列で取得します。

;構文
<syntaxhighlight lang="javascript">
var s = editor.Version;
</syntaxhighlight>

;バージョン
Mery Ver 2.6.7 以降で使用できます。