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

定義

名前空間:

Microsoft.VisualBasic

アセンブリ:

Microsoft.VisualBasic.Core.dll

ソース:

Strings.vb

パーセント記号 (%) が付加されたパーセント形式 (100 で乗算した) の文字列に書式設定して返す文字列処理関数です。

public static string FormatPercent (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 FormatPercent : obj * int * Microsoft.VisualBasic.TriState * Microsoft.VisualBasic.TriState * Microsoft.VisualBasic.TriState -> string

Public Function FormatPercent (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 定数を指定します。 値については、「設定」を参照してください。

UseParensForNegativeNumbers

TriState

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

GroupDigits

TriState

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

戻り値

String

末尾に % 文字を付けた割合の値 (100 を乗算) に形式が変換された式です。

例外

InvalidCastException

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

例

この例では、 関数の使用方法を FormatPercent 示します。

Dim testNumber As Single = 0.76
' Returns "76.00%".
Dim testString As String = FormatPercent(testNumber)

注釈

1 つ以上の省略可能な引数を省略すると、省略された引数の値はロケール設定によって提供されます。

注意

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

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

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

こちらもご覧ください

• FormatCurrency(Object, Int32, TriState, TriState, TriState)
• FormatDateTime(DateTime, DateFormat)
• FormatNumber(Object, Int32, TriState, TriState, TriState)
• Format(Object, String)
• TriState
• InvalidCastException
• 文字列操作の概要