WP Get selection

4D v16

WP Get selection


WP Get selection ( {* ;} wpArea ) -> 戻り値

引数	型	説明
*	演算子	指定時、wpAreaはオブジェクト名(文字列)。省略時はwpAreaはオブジェクトフィールドあるいは変数。
wpArea	文字, Object	フォームオブジェクト名(指定時)、または4D Write Proオブジェクト変数またはフィールド(省略時)
戻り値	Object	レンジオブジェクト

説明

WP Get selectionコマンドはwpArea引数で指定した4D Write Proエリア内で現在選択されているテキストに基づいた新しいテキストレンジオブジェクト(rangeObj)を返します。

任意の * 引数を渡した場合、wpAreaがフォームオブジェクト名(文字列)である事を指示します。この引数を渡さなかった場合、wpAreaが4D Write Proオブジェクト変数あるいはフィールドであることを指示します。wpArea引数に有効な4D Write Proエリアが渡されなかった場合、空のrangeObjが返されます。

このコマンドは新しいrangeObjを返します。rangeObjは4D Write Proテキストレンジオブジェクトであり、これを使用してテキストセレクション属性を管理する事ができます(その際新しいWP GET ATTRIBUTESとWP SET ATTRIBUTESを使用します)。これには4つのプライベートな読み込みのみ属性(wk range type, wk range start, wk range end and wk range owner)があり、レンジ自身を定義するのに使用されます。

例題

4D Write Proエリアから選択されたテキストを取得したい場合を考えます:

$range:=WP Get selection(*;"WParea")

参照

WP Get paragraphs
WP Get pictures
WP Get range