substring メソッド

String オブジェクトに格納されている文字列内の指定された位置にある文字列を返します

function substring(start : Number[, end : Number]) : String

引数

  • start
    必ず指定します。 必ず指定します。取得する文字列の先頭文字の位置を 0 から始まる値で指定します

  • end
    省略可能です。 必ず指定します。取得する文字列の終了文字の位置を 0 から始まる値で指定します。 部分文字列には、end で指定された文字の 1 つ前の文字までが含まれます。

    end を省略すると、start から元の文字列の末尾の文字までが返されます。

解説

substring メソッドの戻り値は、start から end の前の文字までを含む文字列です。

substring メソッドでは、引数 start と引数 end のうち値の小さい方が取得する文字列の先頭位置になります。 たとえば strvar.substring(0, 3) メソッドと strvar.substring(3, 0) メソッドは同じ文字列を返します。

引数 start または end のいずれかが NaN または負である場合は、0 に置き換えられます。

取得した文字列の長さは、start と end の2 つの引数の差の絶対値になります。 たとえば、strvar.substring(0, 3) メソッドと strvar.substring(3, 0) メソッドで返される文字列の長さは 3 になります。

使用例

substring メソッドの使用例を次に示します。

function SubstringDemo(){
   var s = "The quick brown fox jumps over the lazy dog.";
   var result = s.substring(10, 15);
   // Returns "brown".
   return(result);
}

必要条件

Version 1

対象

String オブジェクト

参照

参照

substr メソッド