FormatNumber 関数 (Visual Basic)

  • [アーティクル]

更新 : 2007 年 11 月

数値形式の文字列に書式設定して返す文字列処理関数です。

Function FormatNumber(
   ByVal Expression As Object,
   Optional ByVal NumDigitsAfterDecimal As Integer = -1,
   Optional ByVal IncludeLeadingDigit As TriState = TriState.UseDefault,
   Optional ByVal UseParensForNegativeNumbers As TriState = TriState.UseDefault,
   Optional ByVal GroupDigits As TriState = TriState.UseDefault
) As String

パラメータ

  • Expression
    必ず指定します。書式を変換する式を指定します。

  • NumDigitsAfterDecimal
    省略可能です。小数点以下に表示する桁数を表す数値を指定します。既定値は -1 で、[地域のオプション] の値を使用します。

  • IncludeLeadingDigit
    省略可能です。小数点の左側の 0 を表示するかどうかを表す定数を指定します。値については、「設定」を参照してください。

  • UseParensForNegativeNumbers
    省略可能です。負の値をかっこで囲むかどうかを表す定数を指定します。値については、「設定」を参照してください。

  • GroupDigits
    省略可能です。ロケール設定で指定されている桁区切り記号を使用して、数値を区切るかどうかを表す定数を指定します。値については、「設定」を参照してください。

設定

IncludeLeadingDigit、UseParensForNegativeNumbers、および GroupDigits の各引数の設定値は次のとおりです。

定数

説明

TriState.True

True

TriState.False

False

TriState.UseDefault

コンピュータの地域設定

例外

例外の種類

エラー番号

条件

InvalidCastException

13

型が数値型ではありません。

非構造化エラー処理を使用する Visual Basic 6.0 アプリケーションをアップグレードする場合は、「エラー番号」列を参照してください(エラー番号を Number プロパティ (Err オブジェクト) と照らし合わせます)。しかし、可能な限り、このエラー処理は Visual Basic の構造化例外処理の概要 で置き換えてください。

解説

引数を省略すると、ロケール設定の対応する値を使用します。

xfta99yt.alert_note(ja-jp,VS.90).gifメモ :

これらの設定値の情報は、アプリケーションのロケールに基づいています。既定では、コントロール パネルのロケール設定になります。ただし、.NET Framework を使ってプログラムで変更可能です。

使用例

FormatNumber 関数の使用例を次に示します。

Dim TestNumber As Integer = 45600
' Returns "45,600.00".
Dim TestString As String = FormatNumber(TestNumber, 2, , , TriState.True)

必要条件

名前空間 : Microsoft.VisualBasic

モジュール : Strings

アセンブリ : Visual Basic ランタイム ライブラリ (Microsoft.VisualBasic.dll)

参照

参照

文字列操作の概要

FormatCurrency 関数 (Visual Basic)

FormatDateTime 関数 (Visual Basic)

FormatPercent 関数 (Visual Basic)

TriState 列挙型

InvalidCastException