Enum.ToString Metoda

To Przeciążenie metody jest przestarzałe; Użyj 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

Parametry

Zwraca

Implementuje

Atrybuty

ObsoleteAttribute

Wyjątki

Uwagi

Parametr format może być jednym z następujących ciągów formatu: "G" lub "g", "D", "d", "X" lub "x", "F" lub "f" (ciąg formatu nie jest rozróżniana wielkość liter).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). Jeśli format jest null lub pustym ciągiem (""), używany jest specyfikator formatu ogólnego ("G").If format is null or an empty string (""), the general format specifier ("G") is used. Aby uzyskać więcej informacji na temat ciągów formatu wyliczenia i wartości wyliczenia formatowania, zobacz ciągi formatujące Wyliczenie.For more information about the enumeration format strings and formatting enumeration values, see Enumeration Format Strings. Aby uzyskać więcej informacji na temat ogólnego formatowania, zobacz Typy formatowania.For more information about formatting in general, see Formatting Types.

Określ tylko format; parametr provider jest przestarzały.Specify only format; the provider parameter is obsolete.

Zobacz też

• Format(Type, Object, String)
• Formatowanie typów w programie .NETFormatting Types in .NET
• Wyliczanie ciągów formatującychEnumeration Format Strings

Konwertuje wartość tego wystąpienia na jego równoważną reprezentację w postaci ciągu przy użyciu podanego formatu.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

Parametry

Zwraca

Wyjątki

Przykłady

Poniższy przykład ilustruje sposób konwersji wartości wyliczanej na ciąg.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
'

Uwagi

Parametr format może być jednym z następujących ciągów formatu: "G" lub "g", "D", "d", "X" lub "x", "F" lub "f" (ciąg formatu nie jest rozróżniana wielkość liter).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). Jeśli format jest null lub pustym ciągiem (""), używany jest specyfikator formatu ogólnego ("G").If format is null or an empty string (""), the general format specifier ("G") is used. Aby uzyskać więcej informacji na temat ciągów formatu wyliczenia i wartości wyliczenia formatowania, zobacz ciągi formatujące Wyliczenie.For more information about the enumeration format strings and formatting enumeration values, see Enumeration Format Strings. Aby uzyskać więcej informacji na temat ogólnego formatowania, zobacz Typy formatowania.For more information about formatting in general, see Formatting Types.

Uwagi dotyczące wywoływania

Jeśli wiele elementów członkowskich wyliczenia ma tę samą wartość podstawową i podjęto próbę pobrania ciągu reprezentującego nazwę elementu członkowskiego wyliczenia na podstawie jego podstawowej wartości, kod nie powinien wprowadzać żadnych założeń dotyczących nazwy, która zwróci metodę.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. Na przykład następujące Wyliczenie definiuje dwa elementy członkowskie, cieniowanie. szary i cień. szary, który ma taką samą wartość podstawową.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] Poniższe wywołanie metody próbuje pobrać nazwę elementu członkowskiego wyliczenia cienia , którego wartość bazowa to 1.The following method call attempts to retrieve the name of a member of the Shade enumeration whose underlying value is 1. Metoda może zwracać wartość "szary" lub "szary", a kod nie powinien zawierać żadnych założeń dotyczących tego, który ciąg zostanie zwrócony.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]

Zobacz też

• Format(Type, Object, String)
• Parse(Type, String)
• ToString(String, IFormatProvider)
• Formatowanie typów w programie .NETFormatting Types in .NET
• Wyliczanie ciągów formatującychEnumeration Format Strings

To Przeciążenie metody jest przestarzałe; Użyj 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

Parametry

Zwraca

Implementuje

Atrybuty

ObsoleteAttribute

Konwertuje wartość tego wystąpienia na jego równoważną reprezentację w postaci ciągu.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

Zwraca

Przykłady

Poniższy przykład demonstruje konwersję wartości wyliczanej na ciąg.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'.

Uwagi

Wartość zwracana jest formatowana przy użyciu specyfikatora formatu ogólnego ("G").The return value is formatted with the general format specifier ("G"). Oznacza to, że jeśli FlagsAttribute nie zostanie zastosowana do tego typu wyliczeniowego i istnieje nazwana stała równa wartości tego wystąpienia, wartość zwracana jest ciągiem zawierającym nazwę stałej.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. Jeśli FlagsAttribute jest stosowany i istnieje kombinacja jednej lub więcej nazwanych stałych równych wartości tego wystąpienia, wartość zwracana jest ciągiem zawierającym rozdzielaną ogranicznikami listę nazw stałych.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. W przeciwnym razie wartością zwracaną jest ciąg reprezentujący wartość liczbową tego wystąpienia.Otherwise, the return value is the string representation of the numeric value of this instance. Aby uzyskać więcej informacji na temat formatowania wartości wyliczenia, zobacz ciągi formatujące Wyliczenie.For more information about formatting enumeration values, see Enumeration Format Strings. Aby uzyskać więcej informacji na temat ogólnego formatowania, zobacz Typy formatowania.For more information about formatting in general, see Formatting Types.

Uwagi dotyczące wywoływania

Jeśli wiele elementów członkowskich wyliczenia ma tę samą wartość podstawową i podjęto próbę pobrania ciągu reprezentującego nazwę elementu członkowskiego wyliczenia na podstawie jego podstawowej wartości, kod nie powinien wprowadzać żadnych założeń dotyczących nazwy, która zwróci metodę.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. Na przykład następujące Wyliczenie definiuje dwa elementy członkowskie, cieniowanie. szary i cień. szary, który ma taką samą wartość podstawową.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] Poniższe wywołanie metody próbuje pobrać nazwę elementu członkowskiego wyliczenia cienia , którego wartość bazowa to 1.The following method call attempts to retrieve the name of a member of the Shade enumeration whose underlying value is 1. Metoda może zwracać wartość "szary" lub "szary", a kod nie powinien zawierać żadnych założeń dotyczących tego, który ciąg zostanie zwrócony.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]

Zobacz też

• Format(Type, Object, String)
• Parse(Type, String)