Enum.Format(Type, Object, String) Methode

Definitie

Naamruimte:
System
Assembly's:
mscorlib.dll, System.Runtime.dll
Assembly's:
netstandard.dll, System.Runtime.dll
Assembly:
System.Runtime.dll
Assembly:
mscorlib.dll
Assembly:
netstandard.dll
Bron:
Enum.cs
Bron:
Enum.cs
Bron:
Enum.cs
Bron:
Enum.cs
Bron:
Enum.cs

Converteert de opgegeven waarde van een opgegeven geïnventariseerd type naar de equivalente tekenreeksweergave volgens de opgegeven notatie.

public:
 static System::String ^ Format(Type ^ enumType, System::Object ^ value, System::String ^ format);
public static string Format(Type enumType, object value, string format);
[System.Runtime.InteropServices.ComVisible(true)]
public static string Format(Type enumType, object value, string format);
static member Format : Type * obj * string -> string
[<System.Runtime.InteropServices.ComVisible(true)>]
static member Format : Type * obj * string -> string
Public Shared Function Format (enumType As Type, value As Object, format As String) As String

Parameters

enumType
Type

Het opsommingstype van de waarde die moet worden geconverteerd.

value
Object

De waarde die moet worden geconverteerd.

format
String

De uitvoerindeling die moet worden gebruikt.

Retouren

String

Een tekenreeksweergave van value.

Kenmerken
ComVisibleAttribute

Uitzonderingen

ArgumentNullException

De enumTypeparameter , valueof format parameter is null.

ArgumentException

De enumType parameter is geen Enum type.

– of –

De value is afkomstig van een opsomming die verschilt van het type enumType.

– of –

Het type value is geen onderliggend type enumType.

FormatException

De format parameter bevat een ongeldige waarde.

InvalidOperationException

format is gelijk aan X, maar het opsommingstype is onbekend.

– of –

.NET 8 en hoger: enumType is een opsommingstype met booleaanse ondersteuning.

Voorbeelden

In het volgende voorbeeld ziet u het gebruik ervan Format in de context van Enum.

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.

open System

type Colors =
    | Red = 0
    | Green = 1
    | Blue = 2
    | Yellow = 3

let myColor = Colors.Blue

printfn $"My favorite color is {myColor}."
printfn $"""The value of my favorite color is {Enum.Format(typeof<Colors>, myColor, "d")}."""
printfn $"""The hex value of my favorite color is {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.

 Enum Colors
     Red
     Green
     Blue
     Yellow    
 End Enum
    
Public Class FormatTest
    Public Shared Sub Main()
        Dim myColor As Colors = Colors.Blue
        
        Console.WriteLine("My favorite color is {0}.", myColor)
        Console.WriteLine("The value of my favorite color is {0}.", [Enum].Format(GetType(Colors), myColor, "d"))
        Console.WriteLine("The hex value of my favorite color is {0}.", [Enum].Format(GetType(Colors), myColor, "x"))
    End Sub 
End Class 
' 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.

Opmerkingen

In de volgende tabel ziet u de geldige waarden voor de format parameter.

Format Beschrijving
"G" of "g" Als value deze gelijk is aan een benoemde en geïnventariseerd constante, wordt de naam van die constante geretourneerd. Anders wordt het decimale equivalent value geretourneerd.

Stel dat de enige geïnventareerde constante de naam Rood heeft en de waarde 1 is. Als value deze indeling is opgegeven als 1, retourneert deze notatie 'Rood'. Als value echter is opgegeven als 2, retourneert deze indeling '2'.

– of –

Als het FlagsAttribute aangepaste kenmerk wordt toegepast op de opsomming, value wordt het beschouwd als een bitveld dat een of meer vlaggen bevat die uit een of meer bits bestaan.

Als value deze gelijk is aan een combinatie van benoemde opsommingsconstanten, wordt een door scheidingstekens gescheiden lijst met namen van deze constanten geretourneerd. value wordt gezocht naar vlaggen, van de vlag met de grootste waarde naar de kleinste waarde. Voor elke vlag die overeenkomt met een bitveld in value, wordt de naam van de constante samengevoegd met de door scheidingstekens gescheiden lijst. De waarde van die vlag wordt vervolgens uitgesloten van verdere overweging en de zoekopdracht wordt voortgezet naar de volgende vlag.

Als value deze niet gelijk is aan een combinatie van benoemde enume constanten, wordt het decimale equivalent geretourneerd value .
"X" of "x" Vertegenwoordigt value in hexadecimale notatie zonder voorloop "0x".
"D" of "d" Vertegenwoordigt value in decimale vorm.
"F" of "f" Gedraagt zich identiek aan "G" of "g", behalve dat de FlagsAttribute verklaring niet aanwezig hoeft te zijn Enum .

Van toepassing op

Zie ook