setselectionrange文（Ver9.55対応版）

---

目次− setselectionrange文

---

setselectionrange文は、まとめて選択します。（V9.20以降）

パラメータ１（文字列型またはオブジェクト）

選択する範囲をJSONの文字列で指定します。
JavaScriptの場合はオブジェクトを指定できます。

結果コード

失敗した場合、resultは0になります。
成功した場合、resultは0以外になります。

JavaScript

JavaScriptの場合、パラメータ１はオブジェクトを指定できます。

---

JSON/オブジェクト指定について

マクロの文の場合、JSONの文字列を指定します。
JavaScriptの場合、オブジェクトを指定します。
書き方はcolormarkerのJSON/オブジェクト指定と同じで、単位と範囲だけに限定されたものです。

指定可能なプロパティ名と意味：

プロパティ名 値の種類 意味
unit         文字列   位置の単位　既定は"char"
items        配列     入れ子構造のオブジェクトの配列
line1        数値     開始行
col1         数値     開始桁
line2        数値     終了行
col2         数値     終了桁

unitは、"xy" "char" "wcs" "ucs4" "cmu" "gcu" のいずれかで、文字の単位に準じます。"xy"は秀丸単位(座標)で、"char"は秀丸単位(文字列/行)です。既定は"char"です。
既定の"char"のとき、line1, line2は1から数えます。col1, col2は0から数えます。
line1, col1, line2, col2の４つが揃って記述されたら選択されます。

例

js{ setselectionrange({ items:[ {line1:1,col1:0,line2:2,col2:0}, {line1:5,col1:0,line2:6,col2:0}, ] }); } endmacro;

colormarker, getcolormarker, setselectionrange, getselectedrangeのオブジェクト指定はだいたい同じ書き方になっていて、相互に呼び換えることができます。

---

TypeScript的な定義

declare function setselectionrange( p1:string|SelectionRangeItem):number;

interface SelectionRangeItem {
  unit?: UNIT;
  items?: SelectionRangeItem[];
  line1 ?: number; //1-based
  col1 ?: number;  //zero-based
  line2 ?: number; //1-based
  col2 ?: number;  //zero-based
}

type UNIT = "xy"|"char"|"wcs"|"ucs4"|"cmu"|"gcu";