Format 関数

[アーティクル]
08/16/2008

更新 : 2007 年 11 月

書式指定文字列 (String) 式に含まれる指示に従って書式設定された文字列を返します。

Public Shared Function Format( _
   ByVal Expression As Object, _
   Optional ByVal Style As String = "" _
) As String

パラメータ

Expression
必ず指定します。任意の有効な式。
Style
省略可能です。既定またはユーザー定義の書式指定文字列 (String) 式を指定します。

設定

Style 引数の作成方法については、次の各トピックを参照してください。

書式指定の対象	方法
数値	定義済み数値書式 (Format 関数)を使用するか、ユーザー定義の数値書式 (Format 関数)を作成します。
日付/時刻	定義済みの日付/時刻書式 (Format 関数)を使用するか、ユーザー定義の日付/時刻書式 (Format 関数)を作成します。
日付/時刻のシリアル番号	日付/時刻書式または数値書式を使用します。

Style を指定せずに数値書式を指定する場合、ロケール情報に対応している点以外は、Format 関数は Str 関数と同様に機能します。ただし、Format 関数で文字列として設定された正の数値には、先頭にプラス記号を表示するためのスペースは含まれません。Str 関数を使って変換された正の数値には先頭にスペースがあります。

解説

非ローカライズ数値文字列の書式を指定する場合は、ユーザー定義の数値書式設定を使って、目的の書式になるようにします。

String.Format メソッドも同様の機能を提供します。

使用例

String の書式指定とユーザー定義の書式指定の両方を使って値の書式を指定する、Format 関数のさまざまな使用例を次に示します。日付の区切り記号 (/)、時刻の区切り記号 (:)、および午前/午後を示す文字 (t および tt) について、システムで実際に表示される書式は、コードが使用するロケール設定によって決まります。時刻と日付を開発環境で表示する場合は、コードロケールの短い時刻書式と短い日付書式が使用されます。

メモ :
24 時間制を使用するロケールでは、午前/午後を示す記号 (t および tt) では何も表示されません。

Dim TestDateTime As Date = #1/27/2001 5:04:23 PM#
Dim TestStr As String
' Returns current system time in the system-defined long time format.
TestStr = Format(Now(), "Long Time")
' Returns current system date in the system-defined long date format.
TestStr = Format(Now(), "Long Date")
' Also returns current system date in the system-defined long date 
' format, using the single letter code for the format.
TestStr = Format(Now(), "D")

' Returns the value of TestDateTime in user-defined date/time formats.
' Returns "5:4:23".
TestStr = Format(TestDateTime, "h:m:s")
' Returns "05:04:23 PM".
TestStr = Format(TestDateTime, "hh:mm:ss tt")
' Returns "Saturday, Jan 27 2001".
TestStr = Format(TestDateTime, "dddd, MMM d yyyy")
' Returns "17:04:23".
TestStr = Format(TestDateTime, "HH:mm:ss")
' Returns "23".
TestStr = Format(23)

' User-defined numeric formats.
' Returns "5,459.40".
TestStr = Format(5459.4, "##,##0.00")
' Returns "334.90".
TestStr = Format(334.9, "###0.00")
' Returns "500.00%".
TestStr = Format(5, "0.00%")