この記事の英語版を表示するには、[英語] のチェック ボックスをオンにしてください。また、テキストにマウス ポインターを合わせると、ポップアップ ウィンドウに英語のテキストを表示することもできます。
翻訳
英語
このドキュメントはアーカイブされており、メンテナンスされていません。

Enum.Format メソッド

指定した形式に従って、指定した列挙型の指定した値をそれと等価の文字列形式に変換します。

名前空間:  System
アセンブリ:  mscorlib (mscorlib.dll 内)

[ComVisibleAttribute(true)]
public static string Format(
	Type enumType,
	Object value,
	string format
)

パラメーター

enumType
型: System.Type
変換する値の列挙型。
value
型: System.Object
変換する値。
format
型: System.String
使用する出力書式。

戻り値

型: System.String
value の文字列形式。

例外条件
ArgumentNullException

enumTypevalueformat の各パラメーターが null です。

ArgumentException

enumType パラメーターが Enum 型ではありません。

または

value は、enumType とは型の異なる列挙体からの値です。

または

value の型が、enumType の基になる型ではありません。

FormatException

format パラメーターには無効な値が含まれています。

InvalidOperationException

format は "X"と等しいですが、列挙型は不明です。

次の表は、format パラメーターの有効な値を示しています。

Format

説明

"G" または "g"

value が名前付き列挙型定数と等しい場合は、その定数の名前が返されます。それ以外の場合は、value の 10 進等価値が返されます。

たとえば、唯一の列挙定数が Red という名前で、その値が 1 だとします。 value を 1 と指定した場合、この形式は "Red" を返します。 ただし、value を 2 と指定した場合、この形式は "2" を返します。

または

FlagsAttribute カスタム属性をこの列挙体に適用した場合、value は、1 つ以上のビットから成るフラグが 1 つ以上含まれたビット フィールドとして扱われます。

value が名前付きの列挙定数の組み合わせに等しい場合、これらの定数の名前を区切り記号で区切ったリストが返されます。 value でフラグが検索されます。この検索は、値が最大のフラグから最小のフラグへの順に行われます。 value でビット フィールドに対応するフラグが見つかるごとに、区切り記号で区切られたリストにその定数の名前が連結されます。 以後、そのフラグの値は検索対象から除外され、その次のフラグから検索が続行されます。

value が名前付き列挙型定数と等しくない場合は、value の 10 進等価値が返されます。

"X" または "x"

先頭に "0x" を付けない 16 進形式で value を表します。

"D" または "d"

value を 10 進形式で表します。

"F" または "f"

宣言 EnumFlagsAttribute が存在する必要がない点を除いて、"G" または "g" と同じように動作します。

Enum のコンテキストでの Format の使用方法を次の例に示します。


using System;

enum Colors { Red, Green, Blue, Yellow };

public class FormatTest {
    public static void Main() {
        Colors myColor = Colors.Blue;

        Console.WriteLine("My favorite color is {0}.", myColor);
        Console.WriteLine("The value of my favorite color is {0}.", Enum.Format(typeof(Colors), myColor, "d"));
        Console.WriteLine("The hex value of my favorite color is {0}.", Enum.Format(typeof(Colors), myColor, "x"));
    }
}
// The example displays the following output:
//    My favorite color is Blue.
//    The value of my favorite color is 2.
//    The hex value of my favorite color is 00000002.


.NET Framework

サポート対象: 4、3.5、3.0、2.0、1.1、1.0

.NET Framework Client Profile

サポート対象: 4、3.5 SP1

Windows 7, Windows Vista SP1 以降, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core はサポート対象外), Windows Server 2008 R2 (SP1 以降で Server Core をサポート), Windows Server 2003 SP2

.NET Framework では、各プラットフォームのすべてのバージョンはサポートしていません。 サポートされているバージョンについては、「.NET Framework システム要件」を参照してください。
表示: