RangeListObject

RangeListObjectは値のRangeListを表し、手動で文字列を解析することなく、RangeListプロパティの検査に使用できます。適切なデータ型の派生プロパティから戻されるよう、新しいRangeListObjectを構成することも可能です。

コンストラクタの例

var x = new RangeListObject();
var y = new RangeListObject("1-10,20-25");
var z = new RangeListObject([{start:1, end:10},{start:20, end:25}]);

表28.  RangeListObjectコンストラクタ・パラメータ

パラメータ

オプション

説明

範囲

True

初期化の範囲の値。このパラメータはオプションです。2つのフォーマットを使用できます:

  • Array––配列の各要素が、範囲を示す開始と終了のプロパティを持つオブジェクトである配列。これらのプロパティがない配列のオブジェクトは無視されます。

  • String––文字列エントリのカンマ区切りリスト。各エントリには、ダッシュ(-)または等号(=)記号で区切られた、開始値と終了値が含まれます。

表29.  RangeListObjectプロパティ

名前

説明

範囲

オブジェクトの配列。各オブジェクトには2つのプロパティがあります:

  • start––範囲エントリの開始

  • end––範囲エントリの終了

このプロパティは読取り専用です。範囲を変更するには、次のメソッドを使用します。

表30.  RangeListObjectメソッド

名前

説明

AddRange(start, end)

範囲リストに新しい範囲を追加します。これにより、既存の範囲エントリを拡張するか、新たに作成します。リストに1つの数字を追加するには、開始と終了の両方のパラメータにその数字使用します。必要な場合は、両方のパラメータが整数に強制されます。

Contains(value)

値が範囲リスト内にある場合はTrue、それ以外の場合はFalseが戻されます。

必要な場合は、値が整数に強制されます。

IsSupersetOf(range)

現在のRangeListObjectが、指定されたRangeListObjectのスーパーセットである場合はTrueが戻されます。別のタイプのオブジェクトを渡すとエラーが発生します。

RemoveRange(start, end)

リストから範囲を削除します。この削除により、既存の範囲エントリが2つに分割されるか、エントリ全体が削除されます。リストから1つの数字を削除するには、開始と終了の両方のパラメータにその数字を使用します。必要な場合は、両方のパラメータが整数に強制されます。