WP Get selection

4D v17

WP Get selection


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

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

説明

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

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

注: このコマンドを使用するには、wpArea がフォームに関連付けられている(つまりフォーム上に表示されている)必要があります。

アンカーされた画像(位置が固定されたピクチャー)がwpArea 引数内で選択されている場合、WP Get selection コマンドはレンジオブジェクトではなく、ピクチャー参照オブエジェクトを返します(詳細な情報については、WP Add picture コマンドの詳細を参照してください)。それ以外の場合には、コマンドは新しいレンジオブジェクトを返します。レンジオブジェクトの詳細については、セレクションレンジコマンドを参照してください。

例題

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

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

参照

WP Create paragraph range
WP Create picture range
WP Create range