4D Doc Center : ST SET PLAIN TEXT

4D v14.3

ST SET PLAIN TEXT


ST SET PLAIN TEXT ( {* ;} object ; newText {; startSel {; endSel}} )

引数	型	説明
*	演算子	指定時、objectはオブジェクト名 (文字列)。省略時、オブジェクトは変数またはフィールド
object	フォームオブジェクト	オブジェクト名 (指定時)、または変数/フィールド (省略時)
newText	テキスト	挿入するテキスト
startSel	倍長整数	選択の開始位置
endSel	倍長整数	選択の終了位置

説明

ST SET PLAIN TEXTコマンドはobject引数で指定されたマルチスタイルテキストや変数に、newText引数に渡されたテキストを挿入します。このコマンドはobject引数のプレーンテキストにのみ適用され、そこに含まれるスタイルタグを変更しません。

ST SET TEXTコマンドと異なり、ST SET PLAIN TEXTはプレーンテキストのみを挿入します。newTextにスタイルタグを含めることはできません。もし"<"や">"、"&"文字が含まれる場合、これらは標準の文字として扱われ、HTML実体参照に変換されます:

'&' -> &
'<' -> <
'>' -> >

オプションの * 引数を渡した場合、object引数にはオブジェクト名 (文字列) を渡します。コマンド実行時にオブジェクトにフォーカスがある場合、コマンドは編集中のオブジェクトにのみ適用され、(フィールドや変数などの) データソースには適用されません。変更がソース (およびこの同じソースを使用する他のオブジェクト) に転送されるのは、フォーカスが外れるかEnterキーが押されて、オブジェクトへの編集が有効化された場合のみです。オブジェクトにフォーカスがない場合、コマンドは直接データソースに適用され、変更は即座に同じソースを使用する他のオブジェクトに転送されます。
* 引数を省略した場合、object 引数にはフィールドや変数を指定します。この場合文字列ではなくフィールドまたは変数への参照を渡します。コマンドは直接データソースに適用され、変更は即座に同じソースを使用する他のオブジェクトに転送されます。

newTextには挿入するプレーンテキストを渡します。

オプションのstartSelとendSel引数を使用すると、object中で選択するテキストを指定できます。startSelとendSelの値はプレーンテキストを対象として、スタイルタグは考慮されません。コマンドの動作はオプションのstartSelとendSel引数の値により変化します:

startSelとendSelを省略すると、ST SET PLAIN TEXTはobjectのすべてのテキストをnewTextで置き換えます。
startSelのみを渡すか、startSelとendSelの値が同じ場合、ST SET PLAIN TEXTはobjectのstartSelの位置にnewTextを挿入します。
startSelとendSel両方を渡すと、ST SET PLAIN TEXTはこれらの引数で指定された範囲のプレーンテキストをnewTextで置き換えます。
endSelに0をセットすることで、自動的にテキストの最後を指定(startSelに1をセットすることでテキストの最初を指定)できます。

4D では、選択範囲を自動的に指定するために startSel 引数と endSel 引数に渡す定数を提供しています。これらの定数は "Multistyle Text" テーマ内にあります。

定数	型	値	コメント
ST End highlight	倍長整数	-1001	オブジェクト内のカレントのテキストセレクションの最後の文字を指定します(*)
ST End text	倍長整数	0	オブジェクトに含まれるテキストの最後の文字を指定します。
ST Start highlight	倍長整数	-1000	オブジェクト内のテキストのカレントセレクションの最初の文字をを指定します (*)
ST Start text	倍長整数	1	オブジェクト内に含まれるテキストの最初の文字を指定します。

(*) この定数を使用する際には、 object 引数にオブジェクト名を渡す必要があります。フィールドへの参照または変数を渡した場合、コマンドはオブジェクト内の全てのテキストに適用されます。

置き換えられる最初の文字のスタイルがnewTextのテキスト全体で使用されます。

startSelがendSelよりも大きい場合(endSelが0の場合を除く・上記参照)、テキストは変更されず、OK変数に0が設定されます。

例題

リッチテキスト (マルチスタイル) 設定された以下のようなフォーム上の変数があります:

ここに、テキストフィールドに格納されている会社名を挿入したいとします。この名前には例えば"&"のような文字が含まれているかもしれません。この場合ST SET PLAIN TEXTコマンドを使用する必要があります:

ST SET PLAIN TEXT(myStyledText;[Company]Name;33;34)

以下のような結果になります:

変数に格納されているプレーンテキストは以下のようになります:

挿入されたテキストは追加のスタイルタグ中にあることが分かります。このスタイルタグは挿入前の文字に設定されていたスタイルタグに対応します。このメカニズムにより、すべてのケースでリッチテキストエリアが正しく表示されるようになります。

注: このケースで ST SET TEXT コマンドを使用すると、4Dはテキストを挿入できない場合があります。エンコードされていない"&"のような文字が存在する場合、変数中のスタイルタグの解釈が妨げられるためです。詳細はこのコマンドの説明を参照してください。

システム変数およびセット

このコマンド実行後、エラーが発生しなければOKシステム変数が1に、そうでなければ0に設定されます。エラーは特にスタイルタグが正しく評価できなかった場合に発生します (タグが正しくないあるいはタグが足りない)。

エラーが発生した場合、変数は変更されません。テキストが評価されるときに変数上でエラーが発生すると、4Dはテキストをプレーンテキストに変換します。結果"<"や">"、"&"文字はHTML実体参照に変換されます。