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

定義

名前空間:
Microsoft.VisualBasic
アセンブリ:
Microsoft.VisualBasic.dll

システムのコントロール パネルで定義されている通貨記号を使って通貨値として書式設定された式を返します。

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

オプション。 TriState 小数部の値に対して先頭の 0 が表示されるかどうかを示す列挙型。 値については、「解説」を参照してください。

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

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

Note

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

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

価値 Description
TriState.True 正しい
TriState.False いいえ
TriState.UseDefault コンピューターの地域設定

適用対象

こちらもご覧ください