Strings.FormatCurrency(Object, Int32, TriState, TriState, TriState) メソッド

定義

名前空間:

Microsoft.VisualBasic

アセンブリ:

Microsoft.VisualBasic.Core.dll

ソース:

Strings.vb

システムの [コントロール パネル] で定義されている通貨記号を使って通貨形式の文字列に書式設定して返す文字列処理関数です。

public static string FormatCurrency (object? Expression, int NumDigitsAfterDecimal = -1, Microsoft.VisualBasic.TriState IncludeLeadingDigit = Microsoft.VisualBasic.TriState.UseDefault, Microsoft.VisualBasic.TriState UseParensForNegativeNumbers = Microsoft.VisualBasic.TriState.UseDefault, Microsoft.VisualBasic.TriState GroupDigits = Microsoft.VisualBasic.TriState.UseDefault);

static member FormatCurrency : obj * int * Microsoft.VisualBasic.TriState * Microsoft.VisualBasic.TriState * Microsoft.VisualBasic.TriState -> string

Public Function FormatCurrency (Expression As Object, Optional NumDigitsAfterDecimal As Integer = -1, Optional IncludeLeadingDigit As TriState = Microsoft.VisualBasic.TriState.UseDefault, Optional UseParensForNegativeNumbers As TriState = Microsoft.VisualBasic.TriState.UseDefault, Optional GroupDigits As TriState = Microsoft.VisualBasic.TriState.UseDefault) As String

パラメーター

Expression

Object

必須です。 書式指定される式。

NumDigitsAfterDecimal

Int32

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

IncludeLeadingDigit

TriState

省略可能。 小数値の先頭の 0 を表示するかどうかを示す TriState 列挙体。 値については、「解説」を参照してください。

UseParensForNegativeNumbers

TriState

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

GroupDigits

TriState

省略可能。 コンピューターの地域設定で指定されている桁区切り記号を使用して数値を区切るかどうかを示す TriState 列挙体。 値については、「解説」を参照してください。

戻り値

String

システムのコントロール パネルで定義された通貨記号を使用して、通貨の値に形式が変換された式です。

例外

ArgumentException

小数点以下の桁数が 99 を超えています。

InvalidCastException

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

例

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

Dim testDebt As Double = -4456.43
Dim testString As String
' Returns "($4,456.43)".
testString = FormatCurrency(testDebt, , , TriState.True, TriState.True)

注釈

1 つ以上の省略可能な引数を省略すると、コンピューターの一致する地域設定の値が代わりに使用されます。

通貨値に対する通貨記号の相対位置は、システムの地域設定によって決まります。

注意

すべての設定情報は、アプリケーションのロケールから取得されます。 既定では、コントロール パネルで設定されたロケールになります。 ただし、タブからNumber取得される先頭の 0 を除き、.NET Frameworkを使用してプログラムによって変更できます。

、UseParensForNegativeNumbers、および GroupDigits の各引数はIncludeLeadingDigit、次の TriState 列挙値を受け取ります。

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

こちらもご覧ください

• FormatDateTime(DateTime, DateFormat)
• FormatNumber(Object, Int32, TriState, TriState, TriState)
• FormatPercent(Object, Int32, TriState, TriState, TriState)
• TriState
• Format(Object, String)
• ArgumentException
• InvalidCastException
• 文字列操作