Format Function

Converts a numeric expression to a string, and then formats it according to the format that you specify.

Syntax:


Format(expression [, format As String]) As String

Parameters:

expression: Numeric expression that you want to convert to a formatted string.

format: String that specifies the format code for the number. If format is omitted, the Format function works like the LibreOffice Basic Str() function.

Return value:

Text string.

書式コード

The following list describes the codes that you can use for formatting a numeric expression:

0: If expression has a digit at the position of the 0 in the format code, the digit is displayed, otherwise a zero is displayed.

If expression has fewer digits than the number of zeros in the format code, (on either side of the decimal), leading or trailing zeros are displayed. If the expression has more digits to the left of the decimal separator than the amount of zeros in the format code, the additional digits are displayed without formatting.

Decimal places in the expression are rounded according to the number of zeros that appear after the decimal separator in the format code.

#: If expression contains a digit at the position of the # placeholder in the format code, the digit is displayed, otherwise nothing is displayed at this position.

This symbol works like the 0, except that leading or trailing zeroes are not displayed if there are more # characters in the format code than digits in the expression. Only the relevant digits of the expression are displayed.

.: 小数点プレースホルダーは、小数点の位置を指定する記号で、この位置に応じて整数部および小数部の桁数も規定されます。

If the format code contains only # placeholders to the left of this symbol, numbers less than 1 begin with a decimal separator. To always display a leading zero with fractional numbers, use 0 as a placeholder for the first digit to the left of the decimal separator.

%: Multiplies the expressionby 100 and inserts the percent sign (%) where the expression appears in the format code.

E- E+ e- e+ : If the format code contains at least one digit placeholder (0 or #) to the right of the symbol E-, E+, e-, or e+, the expression is formatted in the scientific or exponential format. The letter E or e is inserted between the number and the exponent. The number of placeholders for digits to the right of the symbol determines the number of digits in the exponent.

負の指数の場合は、E-、E+、e-、e+ による指数表示の直前にマイナス記号が表示されます。正の指数の場合は、E+ および e+ による指数表示にのみ、直前にプラス記号が表示されます。

The thousands delimiter is displayed if the format code contains the delimiter enclosed by digit placeholders (0 or #).

ピリオド記号が小数点と千単位の桁区切りのどちらに使われるかは、ロケール設定により決まります。 BASICのソースコード内で数値を直接記述するときは、常にピリオド記号を小数点の記号として使います。 小数点としてどの記号が実際に表示されるかは、システムの数値表式設定により決まります。

- + $ ( ) space: A plus (+), minus (-), dollar ($), space, or brackets entered directly in the format code is displayed as a literal character.

ここで説明したプレースホルダなどの記号を、本来の記号そのものとして表記させるには、バックスラッシュ記号 (\) を直前に付けるか、引用符 (" ") で囲む必要があります。

\ : The backslash displays the next character in the format code.

Characters in the format code that have a special meaning can only be displayed as literal characters if they are preceded by a backslash. The backslash itself is not displayed, unless you enter a double backslash (\\) in the format code.

バックスラッシュ記号を付けないと本来の記号として表示されない書式コード用文字には、日付および時刻の書式設定用文字 (a、c、d、h、m、n、p、q、s、t、w、y、/、:)、数値の書式設定用文字2(#、0、%、E、e、コンマ、ピリオド)、文字列の書式設定用文字 (@、&、<、>、!) が該当します。

You can also use the following predefined number formats. Except for "General Number", all of the predefined format codes return the number as a decimal number with two decimal places.

こうした事前定義された書式コードは、書式コード名を引用符で囲んで使用します。

事前定義された書式コード

General Number: 与えられた数値をそのまま表示します。

Currency: 数値の前に通貨記号を挿入し、負の値の場合はかっこで囲みます。

Fixed: 1 より小さい小数の場合に 1 の位の桁の0を表示させます。

Standard: 千単位の桁区切り記号を表示させます

Percent: 数値を 100 倍して、パーセント記号 (%) を表示させます。

科学: 数字を指数表現で表します (例;1000は1.00E+03 と表示されます )。

A format code can be divided into three sections that are separated by semicolons. The first part defines the format for positive values, the second part for negative values, and the third part for zero. If you only specify one format code, it applies to all numbers.

LibreOffice Basic では - 言語設定 - 言語 でローカルユーザーの使う書式設定した数、日付と通貨をコントロールを設定することができます。Basic フォーマットコードでは、小数点 (.) は常に プレースホルダー として使われるので、十進セパレーターはローカルで設定した対応する文字に置き換えられます。

これは、日付、時間、通貨の書式設定とロケールの関係についても同様です。Basic の書式コードは、個々のロケール設定に応じて、適切な表示に変換されます。

Error codes:

5 無効なプロシージャー呼び出しです

Example:


Sub ExampleFormat
    MsgBox Format(6328.2, "##,##0.00")
    REM BASICのソースコード内で数値を直接記述するときは、常にピリオド記号を小数点の記号として使います。
    REM ロケール設定が英語であれば 6,328.20 と表示し、ドイツ語であれば 6.328,20 と表示します。
End Sub

ご支援をお願いします!