StyleEdit.GetWrappedStringメソッド

 

説明

画面表示と同じ位置で改行されている文字列を返します。

GetWrappedStringメソッドは、StyleEditが初期化され画面上に表示されている間にだけ呼び出すことができます。

また、表示上の改行位置に影響する、Value, Width, WordWrap, WordWrapMode, LineWidthLimit, LineNumberが変更され、表示に反映されるまでの間にGetWrappedStringを呼び出すと、EXT-20例外がthrowされます。この例外は、StyleEditは画面表示によって改行位置が始めて決定されるため、最新状態の改行位置が取得できない事を示します。但し、この状況においてもforce引数にtrueを指定するとによって、変更されたプロパティの反映前の文字列を強制的に取得することが可能です。

 

このメソッドは、Biz/Designer内で実行すると常に"Word Wrapped String"を返します。

 

より追加されました

 

呼出形式

var s = StyleEdit1.GetWrappedString( [ force ] )

 

戻り値

改行を含む文字列

 

引数

boolean force

trueを指定すると、最新のプロパティ設定が反映されていない状態でも、文字列を返します。forceを省略するかfalseを指定すると、最新の状態の文字列が取得できない場合、EXT-20例外をthrowします。

 

例外

EXT-20

プロパティの変更による改行位置の調整が、現在保留されています。

 

EXT-21

実体化されていない、または、既に削除されてるオブジェクトのGetWrappedStringを呼び出すことはできません

 

使用例

 

 

関連項目

 

 



「オンラインマニュアル」一覧へ戻る
「Bizの宝箱」TOPへ戻る