Wrap

説明

テキストを折り返して、各行の文字数が指定した最大文字数に収まるようにします。

戻り値

折り返したテキストが格納された文字列

カテゴリ

関数のシンタックス

Wrap(string, limit[, strip])

ヒストリ

ColdFusion MX 6.1: この関数が追加されました。

パラメータ

パラメータ	説明
string	文字列、または文字列を含んでいる変数です。このテキストを折り返します。
limit	正の整数です。1 行の最大文字数を指定します。
strip	ブール値です。折り返し処理の前に、入力文字列内の既存の復帰改行文字をスペースとともに削除するかどうかを指定します。デフォルト値は false です。

使用方法

行の文字数が指定した最大数に達する位置からさかのぼって最初に出てくる空白文字 (スペース、タブ、改行など) の箇所に改行が挿入されます。最大文字数に達する位置の前に空白文字がない場合は、最大文字数の位置に改行が挿入されます。この関数の処理には、各オペレーティングシステム固有の改行文字が使われます。これは UNIX の場合は LF、Windows の場合は CR/LF です。

strip パラメータを指定した場合は、既存の改行文字はすべて削除されるので、段落の整形はすべて損なわれます。

この関数は、メールメッセージに含めるテキストなどで、各行の長さに上限を設けるときに使用します。cfmail および cfmailpart タグの wraptext 属性ではこの関数が使われます。

例

<h3>Wrap の例</h3>
<cfset inputText="This is an example of a text message that we want to wrap.It is rather long and needs to be broken into shorter lines.">
<cfoutput>#Wrap(inputText, 59)#</cfoutput>

バージョン7