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

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

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

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

== 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 以降で使用できます。

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

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

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

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

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

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

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

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

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

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

;引数
fileName
:ファイル名を指定します。
encoding
:次の値を指定します。省略すると自動選択が使用されます。
:{|class="wikitable"
|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
:次の値を指定します。省略すると現在の文書を閉じて開きます。
:{|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);
</syntaxhighlight>

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

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

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

== 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">
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 以降で使用できます。