Enum.ToString Méthode

Définition

Convertit la valeur de cette instance en sa représentation sous forme de chaîne équivalente.Converts the value of this instance to its equivalent string representation.

Surcharges

ToString(String, IFormatProvider)

Cette surcharge de méthode est obsolète ; utilisez ToString(String).This method overload is obsolete; use ToString(String).

ToString(String)

Convertit la valeur de cette instance en sa représentation sous forme de chaîne équivalente à l'aide du format spécifié.Converts the value of this instance to its equivalent string representation using the specified format.

ToString(IFormatProvider)

Cette surcharge de méthode est obsolète ; utilisez ToString().This method overload is obsolete; use ToString().

ToString()

Convertit la valeur de cette instance en sa représentation sous forme de chaîne équivalente.Converts the value of this instance to its equivalent string representation.

ToString(String, IFormatProvider)

Avertissement

Cette API est désormais obsolète.

Cette surcharge de méthode est obsolète ; utilisez ToString(String).This method overload is obsolete; use ToString(String).

public:
 virtual System::String ^ ToString(System::String ^ format, IFormatProvider ^ provider);
[System.Obsolete("The provider argument is not used. Please use ToString(String).")]
public string ToString (string format, IFormatProvider provider);
override this.ToString : string * IFormatProvider -> string
Public Function ToString (format As String, provider As IFormatProvider) As String

Paramètres

format
String

Spécification de format.A format specification.

provider
IFormatProvider

(Obsolète.)(Obsolete.)

Retours

Représentation sous forme de chaîne de la valeur de cette instance, comme indiqué par format.The string representation of the value of this instance as specified by format.

Implémente

Attributs

Exceptions

format ne contient pas une spécification de format valide.format does not contain a valid format specification.

format égale "X", mais le type d'énumération est inconnu.format equals "X", but the enumeration type is unknown.

Remarques

Le format paramètre peut être l’une des chaînes de format suivantes : « G » ou « g », « D » ou « d », « X » ou « x », et « F » ou « f » (la chaîne de format n’est pas sensible à la casse).The format parameter can be one of the following format strings: "G" or "g", "D" or "d", "X" or "x", and "F" or "f" (the format string is not case-sensitive). Si format estnull ou une chaîne vide (""), le spécificateur de format général ("G") est utilisé.If format is null or an empty string (""), the general format specifier ("G") is used. Pour plus d’informations sur les chaînes de format d’énumération et sur la mise en forme des valeurs d’énumération, consultez chaînes de format d’énumération.For more information about the enumeration format strings and formatting enumeration values, see Enumeration Format Strings. Pour plus d’informations sur la mise en forme en général, consultez mise en forme des types.For more information about formatting in general, see Formatting Types.

Spécifiez formatuniquement ; provider le paramètre est obsolète.Specify only format; the provider parameter is obsolete.

Voir aussi

ToString(String)

Convertit la valeur de cette instance en sa représentation sous forme de chaîne équivalente à l'aide du format spécifié.Converts the value of this instance to its equivalent string representation using the specified format.

public:
 System::String ^ ToString(System::String ^ format);
public string ToString (string format);
override this.ToString : string -> string
Public Function ToString (format As String) As String

Paramètres

format
String

Chaîne de format.A format string.

Retours

Représentation sous forme de chaîne de la valeur de cette instance, comme indiqué par format.The string representation of the value of this instance as specified by format.

Exceptions

format contient une spécification non valide.format contains an invalid specification.

format égale "X", mais le type d'énumération est inconnu.format equals "X", but the enumeration type is unknown.

Exemples

L’exemple suivant montre comment convertir une valeur énumérée en chaîne.The following example demonstrates how to convert an enumerated value to a string.

// Sample for Enum::ToString(String)

using namespace System;

public enum class Colors
{
   Red, Green, Blue, Yellow = 12
};

int main()
{
   Colors myColor = Colors::Yellow;
   Console::WriteLine( "Colors::Red = {0}", Colors::Red.ToString( "d" ) );
   Console::WriteLine( "Colors::Green = {0}", Colors::Green.ToString( "d" ) );
   Console::WriteLine( "Colors::Blue = {0}", Colors::Blue.ToString( "d" ) );
   Console::WriteLine( "Colors::Yellow = {0}", Colors::Yellow.ToString( "d" ) );
   Console::WriteLine( " {0}myColor = Colors::Yellow {0}", Environment::NewLine );
   Console::WriteLine( "myColor->ToString(\"g\") = {0}", myColor.ToString( "g" ) );
   Console::WriteLine( "myColor->ToString(\"G\") = {0}", myColor.ToString( "G" ) );
   Console::WriteLine( "myColor->ToString(\"x\") = {0}", myColor.ToString( "x" ) );
   Console::WriteLine( "myColor->ToString(\"X\") = {0}", myColor.ToString( "X" ) );
   Console::WriteLine( "myColor->ToString(\"d\") = {0}", myColor.ToString( "d" ) );
   Console::WriteLine( "myColor->ToString(\"D\") = {0}", myColor.ToString( "D" ) );
   Console::WriteLine( "myColor->ToString(\"f\") = {0}", myColor.ToString( "f" ) );
   Console::WriteLine( "myColor->ToString(\"F\") = {0}", myColor.ToString( "F" ) );
}

/*
This example produces the following results:
Colors::Red = 0
Colors::Green = 1
Colors::Blue = 2
Colors::Yellow = 12

myColor = Colors::Yellow

myColor->ToString("g") = Yellow
myColor->ToString("G") = Yellow
myColor->ToString("x") = 0000000C
myColor->ToString("X") = 0000000C
myColor->ToString("d") = 12
myColor->ToString("D") = 12
myColor->ToString("f") = Yellow
myColor->ToString("F") = Yellow
*/
// Sample for Enum.ToString(String)
using System;

class Sample 
{
    enum Colors {Red, Green, Blue, Yellow = 12};

    public static void Main() 
    {
    Colors myColor = Colors.Yellow;

    Console.WriteLine("Colors.Red = {0}", Colors.Red.ToString("d"));
    Console.WriteLine("Colors.Green = {0}", Colors.Green.ToString("d"));
    Console.WriteLine("Colors.Blue = {0}", Colors.Blue.ToString("d"));
    Console.WriteLine("Colors.Yellow = {0}", Colors.Yellow.ToString("d"));

    Console.WriteLine("{0}myColor = Colors.Yellow{0}", Environment.NewLine);

    Console.WriteLine("myColor.ToString(\"g\") = {0}", myColor.ToString("g"));
    Console.WriteLine("myColor.ToString(\"G\") = {0}", myColor.ToString("G"));

    Console.WriteLine("myColor.ToString(\"x\") = {0}", myColor.ToString("x"));
    Console.WriteLine("myColor.ToString(\"X\") = {0}", myColor.ToString("X"));

    Console.WriteLine("myColor.ToString(\"d\") = {0}", myColor.ToString("d"));
    Console.WriteLine("myColor.ToString(\"D\") = {0}", myColor.ToString("D"));    

    Console.WriteLine("myColor.ToString(\"f\") = {0}", myColor.ToString("f"));
    Console.WriteLine("myColor.ToString(\"F\") = {0}", myColor.ToString("F"));
    }
}
/*
This example produces the following results:
Colors.Red = 0
Colors.Green = 1
Colors.Blue = 2
Colors.Yellow = 12

myColor = Colors.Yellow

myColor.ToString("g") = Yellow
myColor.ToString("G") = Yellow
myColor.ToString("x") = 0000000C
myColor.ToString("X") = 0000000C
myColor.ToString("d") = 12
myColor.ToString("D") = 12
myColor.ToString("f") = Yellow
myColor.ToString("F") = Yellow
*/
' Sample for Enum.ToString(String)
Class Sample
   Enum Colors
      Red
      Green
      Blue
      Yellow = 12
   End Enum 'Colors
   
   Public Shared Sub Main()
      Dim myColor As Colors = Colors.Yellow
      
      Console.WriteLine("Colors.Red = {0}", Colors.Red.ToString("d"))
      Console.WriteLine("Colors.Green = {0}", Colors.Green.ToString("d"))
      Console.WriteLine("Colors.Blue = {0}", Colors.Blue.ToString("d"))
      Console.WriteLine("Colors.Yellow = {0}", Colors.Yellow.ToString("d"))
      
      Console.WriteLine("{0}myColor = Colors.Yellow{0}", Environment.NewLine)
      
      Console.WriteLine("myColor.ToString(""g"") = {0}", myColor.ToString("g"))
      Console.WriteLine("myColor.ToString(""G"") = {0}", myColor.ToString("G"))
      
      Console.WriteLine("myColor.ToString(""x"") = {0}", myColor.ToString("x"))
      Console.WriteLine("myColor.ToString(""X"") = {0}", myColor.ToString("X"))
      
      Console.WriteLine("myColor.ToString(""d"") = {0}", myColor.ToString("d"))
      Console.WriteLine("myColor.ToString(""D"") = {0}", myColor.ToString("D"))
      
      Console.WriteLine("myColor.ToString(""f"") = {0}", myColor.ToString("f"))
      Console.WriteLine("myColor.ToString(""F"") = {0}", myColor.ToString("F"))
   End Sub
End Class
'
'This example produces the following results:
'
'Colors.Red = 0
'Colors.Green = 1
'Colors.Blue = 2
'Colors.Yellow = 12
'
'myColor = Colors.Yellow
'
'myColor.ToString("g") = Yellow
'myColor.ToString("G") = Yellow
'myColor.ToString("x") = 0000000C
'myColor.ToString("X") = 0000000C
'myColor.ToString("d") = 12
'myColor.ToString("D") = 12
'myColor.ToString("f") = Yellow
'myColor.ToString("F") = Yellow
'

Remarques

Le format paramètre peut être l’une des chaînes de format suivantes : « G » ou « g », « D » ou « d », « X » ou « x », et « F » ou « f » (la chaîne de format n’est pas sensible à la casse).The format parameter can be one of the following format strings: "G" or "g", "D" or "d", "X" or "x", and "F" or "f" (the format string is not case-sensitive). Si format estnull ou une chaîne vide (""), le spécificateur de format général ("G") est utilisé.If format is null or an empty string (""), the general format specifier ("G") is used. Pour plus d’informations sur les chaînes de format d’énumération et sur la mise en forme des valeurs d’énumération, consultez chaînes de format d’énumération.For more information about the enumeration format strings and formatting enumeration values, see Enumeration Format Strings. Pour plus d’informations sur la mise en forme en général, consultez mise en forme des types.For more information about formatting in general, see Formatting Types.

Notes pour les appelants

Si plusieurs membres de l’énumération ont la même valeur sous-jacente et que vous tentez de récupérer la représentation sous forme de chaîne du nom d’un membre de l’énumération en fonction de sa valeur sous-jacente, votre code ne doit pas faire d’hypothèses concernant le nom retourné par la méthode.If multiple enumeration members have the same underlying value and you attempt to retrieve the string representation of an enumeration member's name based on its underlying value, your code should not make any assumptions about which name the method will return. Par exemple, l’énumération suivante définit deux membres, Shade. Gray et Shade. Grey, qui ont la même valeur sous-jacente.For example, the following enumeration defines two members, Shade.Gray and Shade.Grey, that have the same underlying value.

[!code-csharpSystem.Enum.ToString#1] [!code-vbSystem.Enum.ToString#1][!code-csharpSystem.Enum.ToString#1] [!code-vbSystem.Enum.ToString#1] L’appel de méthode suivant tente de récupérer le nom d’un membre de l’énumération Shade dont la valeur sous-jacente est 1.The following method call attempts to retrieve the name of a member of the Shade enumeration whose underlying value is 1. La méthode peut retourner la valeur « Gray » ou « Grey », et votre code ne doit pas faire d’hypothèses sur la chaîne qui sera retournée.The method can return either "Gray" or "Grey", and your code should not make any assumptions about which string will be returned.

[!code-csharpSystem.Enum.ToString#3] [!code-vbSystem.Enum.ToString#3][!code-csharpSystem.Enum.ToString#3] [!code-vbSystem.Enum.ToString#3]

Voir aussi

ToString(IFormatProvider)

Avertissement

Cette API est désormais obsolète.

Cette surcharge de méthode est obsolète ; utilisez ToString().This method overload is obsolete; use ToString().

public:
 virtual System::String ^ ToString(IFormatProvider ^ provider);
[System.Obsolete("The provider argument is not used. Please use ToString().")]
public string ToString (IFormatProvider provider);
override this.ToString : IFormatProvider -> string
Public Function ToString (provider As IFormatProvider) As String

Paramètres

provider
IFormatProvider

(obsolète)(obsolete)

Retours

Représentation sous forme de chaîne de la valeur de cette instance.The string representation of the value of this instance.

Implémente

Attributs

ToString()

Convertit la valeur de cette instance en sa représentation sous forme de chaîne équivalente.Converts the value of this instance to its equivalent string representation.

public:
 override System::String ^ ToString();
public override string ToString ();
override this.ToString : unit -> string
Public Overrides Function ToString () As String

Retours

Représentation sous forme de chaîne de la valeur de cette instance.The string representation of the value of this instance.

Exemples

L’exemple suivant illustre la conversion d’une valeur énumérée en chaîne.The following example demonstrates converting an enumerated value to a string.

using namespace System;
public ref class EnumSample
{
public:
   enum class Colors
   {
      Red = 1,
      Blue = 2
   };

   static void main()
   {
      Enum ^ myColors = Colors::Red;
      Console::WriteLine( "The value of this instance is '{0}'", myColors );
   }

};

int main()
{
   EnumSample::main();
}

/*
Output.
The value of this instance is 'Red'.
*/
using System;

public class EnumSample {
    enum Colors {Red = 1, Blue = 2};
    
    public static void Main() {
        Enum myColors = Colors.Red;
        Console.WriteLine("The value of this instance is '{0}'",
           myColors.ToString());
    }
}
/*
Output.
The value of this instance is 'Red'.
*/
Public Class EnumSample    
    Enum Colors
        Red = 1
        Blue = 2
    End Enum
    
    Public Shared Sub Main()
        Dim myColors As Colors = Colors.Red
        Console.WriteLine("The value of this instance is '{0}'", _
           myColors.ToString())
    End Sub
End Class

'Output.
'The value of this instance is 'Red'.

Remarques

La valeur de retour est mise en forme avec le spécificateur de format général (« G »).The return value is formatted with the general format specifier ("G"). Autrement dit, si FlagsAttribute n’est pas appliqué à ce type énuméré et qu’une constante nommée est égale à la valeur de cette instance, la valeur de retour est une chaîne contenant le nom de la constante.That is, if the FlagsAttribute is not applied to this enumerated type and there is a named constant equal to the value of this instance, then the return value is a string containing the name of the constant. FlagsAttribute Si est appliqué et qu’il existe une combinaison d’une ou plusieurs constantes nommées égales à la valeur de cette instance, la valeur de retour est une chaîne contenant une liste délimitée par des délimiteurs de noms des constantes.If the FlagsAttribute is applied and there is a combination of one or more named constants equal to the value of this instance, then the return value is a string containing a delimiter-separated list of the names of the constants. Sinon, la valeur de retour est la représentation sous forme de chaîne de la valeur numérique de cette instance.Otherwise, the return value is the string representation of the numeric value of this instance. Pour plus d’informations sur la mise en forme des valeurs d’énumération, consultez chaînes de format d’énumération.For more information about formatting enumeration values, see Enumeration Format Strings. Pour plus d’informations sur la mise en forme en général, consultez mise en forme des types.For more information about formatting in general, see Formatting Types.

Notes pour les appelants

Si plusieurs membres de l’énumération ont la même valeur sous-jacente et que vous tentez de récupérer la représentation sous forme de chaîne du nom d’un membre de l’énumération en fonction de sa valeur sous-jacente, votre code ne doit pas faire d’hypothèses concernant le nom retourné par la méthode.If multiple enumeration members have the same underlying value and you attempt to retrieve the string representation of an enumeration member's name based on its underlying value, your code should not make any assumptions about which name the method will return. Par exemple, l’énumération suivante définit deux membres, Shade. Gray et Shade. Grey, qui ont la même valeur sous-jacente.For example, the following enumeration defines two members, Shade.Gray and Shade.Grey, that have the same underlying value.

[!code-csharpSystem.Enum.ToString#1] [!code-vbSystem.Enum.ToString#1][!code-csharpSystem.Enum.ToString#1] [!code-vbSystem.Enum.ToString#1] L’appel de méthode suivant tente de récupérer le nom d’un membre de l’énumération Shade dont la valeur sous-jacente est 1.The following method call attempts to retrieve the name of a member of the Shade enumeration whose underlying value is 1. La méthode peut retourner la valeur « Gray » ou « Grey », et votre code ne doit pas faire d’hypothèses sur la chaîne qui sera retournée.The method can return either "Gray" or "Grey", and your code should not make any assumptions about which string will be returned.

[!code-csharpSystem.Enum.ToString#2] [!code-vbSystem.Enum.ToString#2][!code-csharpSystem.Enum.ToString#2] [!code-vbSystem.Enum.ToString#2]

Voir aussi

S’applique à