Strings.Format メソッド

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

Strings.Format メソッド

String 型の書式指定式に含まれている指示に応じて書式設定された文字列を返します。

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

Visual Basic (宣言)

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

Visual Basic (使用法)

Dim Expression As Object
Dim Style As String
Dim returnValue As String

returnValue = Strings.Format(Expression, Style)

C#

public static string Format
 (
    Object Expression,
    [OptionalAttribute] string Style
)

C++

public:
static String^ Format (
    Object^ Expression, 
    [OptionalAttribute] String^ Style
)

J#

public static String Format (
    Object Expression, 
    /** @attribute OptionalAttribute() */ String Style
)

JScript

public static function Format
 (
    Expression : Object, 
    Style : String
) : String

パラメータ

Expression

必須。任意の有効な式。

Style

省略可能。有効な名前の付いた、またはユーザー定義による String 型の書式指定式

戻り値
String 型の書式指定式に含まれている指示に応じて書式設定された文字列を返します。

解説

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

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

System.String.Format メソッドも類似の機能を提供します。

Style 引数を作成する方法については、以下の該当するトピックを参照してください。

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

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

使用例

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

メモ
24 時間方式を使用するロケールの場合、AM/PM インジケータ (t および tt) には何も表示されません。

Visual Basic

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%")

プラットフォーム

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 名前空間
Format
その他の技術情報
Format 関数
文字列操作の概要
数値ごとに異なる書式指定 (Format 関数)
定義済みの日付/時刻書式 (Format 関数)
定義済み数値書式 (Format 関数)
Str 関数
データ型変換関数
ユーザー定義の日付/時刻書式 (Format 関数)
ユーザー定義の数値書式 (Format 関数)