説明
formatは、文字列などを指定フォーマットに従って整形する関数です。
文字列または数値x1 をs2 で指定されるフォーマットに従って整形します。
構文
s0 = format(x1 [, s2])
パラメタ
x1 ：
整形される数値または文字列を指定します。
s2 ：
整形の仕方を表します。
コロン(:)で区切って項目を並べます。不要な空白を入れてはいけません。
最初の項目は、タイプを表します。指定できる値は、以下の3種類です。また、この値によってx1のコンテキストが定まります。
値 | 意味 | x1のコンテキスト |
|---|---|---|
str | 文字列 | 文字列 |
fix | 固定小数点表示の数値 | 数値 |
exp | 浮動小数点表示の数値 | 数値 |
この項目が省略された場合は、str が指定されたものとみなされます。
タイプによって、指定できる項目が異なります。
各項目は、単に値を指定する、または<キーワード>=<値>という形式で指定します。
各タイプに定められた順序に従って記述している間は、単に値を書くことで指定することができます。一度キーワードを指定した場合、それ以降はすべての項目にキーワードを指定してください。
ある項目に省略値を利用し、それ以降に省略値以外の項目を指定しようとする場合は、キーワードを指定してください。
文字列は引用符などで囲ってはいけません。したがって、文字列中にコロン(:)を含めることはできません。
値には、0以上の整数または文字列が指定できます。どちらを指定するかは項目によって決まっています。以下に示す「項目」の表を、参照してください。
戻り値
整形した結果の文字列を返します。
項目
【タイプが「str」の場合】
キーワード | 可能な値 | 省略値 | 説明 |
|---|---|---|---|
width | 0以上の整数 | 0 | 最小の幅（単位：バイト） |
adjust | left/right/center | left | 左詰(left)、右詰(right)、中央揃え(center) |
文字列の長さがwidthで指定した値以上だった場合は、その幅が使われます。
【タイプが「fix」の場合】
キーワード | 可能な値 | 省略値 | 説明 |
|---|---|---|---|
width | 0以上の整数 | 0 | 最小の幅（単位：バイト） |
prec | 0以上の整数 | 0 | 小数点以下の桁数 |
adjust | left/right/center | right | 左詰(left)、右詰(right)、中央揃え(center) |
ipad | 文字列(最初の1バイトだけが使われる) | ' ' | 整数部のパディング文字 |
fpad | 文字列(最初の1バイトだけが使われる) | ' ' | 小数部のパディング文字 |
delimit | 0以上の整数 | 0 | 正の整数が指定されていれば、整数部はそのけたごとにカンマ(,)が挿入される |
minus | 文字列 | '-' | 値が負の場合に数値の直前に挿入される |
plus | 文字列 | '' | 値が正の場合に数値の直前に挿入される |
zero | 文字列 | '' | 値が0の場合に数値の直前に挿入される |
【タイプが「exp」の場合】
キーワード | 可能な値 | 省略値 | 説明 |
|---|---|---|---|
width | 0以上の整数 | 0 | 最小の幅（単位：バイト） |
prec | 0以上の整数 | 6 | 小数点以下の桁数 |
adjust | left/right/center | right | 左詰(left)、右詰(right)、中央揃え(center) |
使用例
format("abc") → "abc"
format("abc", "str:10:adjust=center") → " abc "
format(1.45678,"fix:7:4") → "1.4568" （四捨五入されていることに注意）
format(-1234567.89012, "fix:prec=4:minus=▲:delimit=3") → "▲1,234,567.8901"
format(33.333, "exp") → "3.333300E+01"
<!HREPLACE 'format(x*100, "fix"). "%"'>
→ xに保持している割合をパーセントで表示する