multiline プロパティ

[アーティクル]
09/17/2008

更新 : 2007 年 11 月

正規表現で使用する multiline フラグ (m) の状態を表すブール値を返します。

rgExp.multiline

引数

rgExp
必ず指定します。Regular Expression オブジェクトのインスタンスを指定します。

解説

multiline プロパティは読み取り専用で、正規表現の複数行フラグが設定されているときは true を返し、設定されていないときは false を返します。m フラグを使用した正規表現オブジェクトを作成すると、multiline プロパティが true になります。既定値は false です。

multiline が false のとき、"^" で文字列の先頭位置に一致し、"$" で文字列の最終位置に一致します。multiline が true の場合は、"^" で "\n" または "\r" の直後を含む文字列の先頭位置に一致し、"$" で "\n" または "\r" の直前を含む文字列の最終位置に一致します。

使用例

multiline プロパティの使用例を次に示します。

function RegExpPropDemo(re : RegExp) {
   print("Regular expression: " + re);
   print("global:     " + re.global);
   print("ignoreCase: " + re.ignoreCase);
   print("multiline:  " + re.multiline);
   print();
};

// Some regular expression to test the function.
var re1 : RegExp = new RegExp("the","i");  // Use the constructor.
var re2 = /\w+/gm;                         // Use a literal.
RegExpPropDemo(re1);
RegExpPropDemo(re2);
RegExpPropDemo(/^\s*$/im);

このプログラムの出力は次のようになります。

Regular expression: /the/i
global:     false
ignoreCase: true
multiline:  false

Regular expression: /\w+/gm
global:     true
ignoreCase: false
multiline:  true

Regular expression: /^\s*$/im
global:     false
ignoreCase: true
multiline:  true