Strings.FormatNumber メソッド

.NET Framework クラス ライブラリ リファレンス

Strings.FormatNumber メソッド

数値として書式設定された式を返します。

名前空間: Microsoft.VisualBasic
アセンブリ: Microsoft.VisualBasic (microsoft.visualbasic.dll 内)
構文

Visual Basic (宣言)

Public Shared Function FormatNumber
 ( _
    Expression As Object, _
    <OptionalAttribute> Optional NumDigitsAfterDecimal As
 Integer = -1, _
    <OptionalAttribute> Optional IncludeLeadingDigit As
 TriState = TriState.UseDefault, _
    <OptionalAttribute> Optional UseParensForNegativeNumbers
 As TriState = TriState.UseDefault, _
    <OptionalAttribute> Optional GroupDigits As
 TriState = TriState.UseDefault _
) As String

Visual Basic (使用法)

Dim Expression As Object
Dim NumDigitsAfterDecimal As Integer
Dim IncludeLeadingDigit As TriState
Dim UseParensForNegativeNumbers As TriState
Dim GroupDigits As TriState
Dim returnValue As String

returnValue = Strings.FormatNumber(Expression, NumDigitsAfterDecimal, IncludeLeadingDigit,
 UseParensForNegativeNumbers, GroupDigits)

C#

public static string FormatNumber
 (
    Object Expression,
    [OptionalAttribute] int NumDigitsAfterDecimal,
    [OptionalAttribute] TriState IncludeLeadingDigit,
    [OptionalAttribute] TriState UseParensForNegativeNumbers,
    [OptionalAttribute] TriState GroupDigits
)

C++

public:
static String^ FormatNumber (
    Object^ Expression, 
    [OptionalAttribute] int NumDigitsAfterDecimal, 
    [OptionalAttribute] TriState IncludeLeadingDigit, 
    [OptionalAttribute] TriState UseParensForNegativeNumbers, 
    [OptionalAttribute] TriState GroupDigits
)

J#

public static String FormatNumber (
    Object Expression, 
    /** @attribute OptionalAttribute() */ int NumDigitsAfterDecimal,
 
    /** @attribute OptionalAttribute() */ TriState IncludeLeadingDigit, 
    /** @attribute OptionalAttribute() */ TriState UseParensForNegativeNumbers, 
    /** @attribute OptionalAttribute() */ TriState GroupDigits
)

JScript

public static function FormatNumber
 (
    Expression : Object, 
    NumDigitsAfterDecimal : int, 
    IncludeLeadingDigit : TriState, 
    UseParensForNegativeNumbers : TriState, 
    GroupDigits : TriState
) : String

パラメータ

Expression

必須。書式設定する式。

NumDigitsAfterDecimal

省略可能。表示される小数点以下の桁数を示す数値。既定値は –1 です。これは、コンピュータの地域設定が使用されることを示しています。

IncludeLeadingDigit

省略可能。少数値の先頭の 0 を表示するかどうかを示す TriState 定数。値については、「設定」を参照してください。

UseParensForNegativeNumbers

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

GroupDigits

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

戻り値
数値として書式設定された式を返します。

解説

詳細については、Visual Basic のトピック「FormatNumber 関数 (Visual Basic)」を参照してください。

1 つ以上のオプション引数が省略された場合、省略された引数の値はロケール設定によって提供されます。

メモ
設定情報はすべてアプリケーションのロケールから提供されます。既定では、コントロール パネルのロケール セットになります。これは、.NET Framework を使ってプログラムで変更できます。

IncludeLeadingDigit、UseParensForNegativeNumbers、および GroupDigits の各引数には次の設定があります。

定数	説明
TriState.True	True
TriState.False	False
TriState.UseDefault	コンピュータの地域設定

使用例

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

Visual Basic

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

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
Strings クラス
Strings メンバ
Microsoft.VisualBasic 名前空間
InvalidCastException
その他の技術情報
FormatNumber 関数 (Visual Basic)
文字列操作の概要
FormatCurrency 関数 (Visual Basic)
FormatDateTime 関数 (Visual Basic)
FormatPercent 関数 (Visual Basic)
TriState 列挙型