Enum.ToString Enum.ToString Enum.ToString Enum.ToString Method

Definicja

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.

Przeciążenia

ToString(String, IFormatProvider) ToString(String, IFormatProvider) ToString(String, IFormatProvider) ToString(String, IFormatProvider)

Tego przeciążenia metody jest przestarzała; Użyj ToString(String).This method overload is obsolete; use ToString(String).

ToString(String) ToString(String) ToString(String) ToString(String)

Konwertuje wartość tego wystąpienia na jego reprezentację ciągu równoważnego przy użyciu określonego formatu.Converts the value of this instance to its equivalent string representation using the specified format.

ToString(IFormatProvider) ToString(IFormatProvider) ToString(IFormatProvider) ToString(IFormatProvider)

Tego przeciążenia metody jest przestarzała; Użyj ToString().This method overload is obsolete; use ToString().

ToString() ToString() ToString() ToString()

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.

ToString(String, IFormatProvider) ToString(String, IFormatProvider) ToString(String, IFormatProvider) ToString(String, IFormatProvider)

Ostrzeżenie

Ten interfejs API jest teraz przestarzały.

Tego przeciążenia metody jest przestarzała; 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

format
String String String String

Specyfikacja formatu.A format specification.

provider
IFormatProvider IFormatProvider IFormatProvider IFormatProvider

(Przestarzałe).(Obsolete.)

Zwraca

Ciąg reprezentujący wartość tego wystąpienia określony przez format.The string representation of the value of this instance as specified by format.

Implementuje

Wyjątki

format nie zawiera specyfikacji prawidłowy format.format does not contain a valid format specification.

format jest równy "X", ale typ wyliczeniowy jest nieznany.format equals "X", but the enumeration type is unknown.

Uwagi

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

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

Zobacz też

ToString(String) ToString(String) ToString(String) ToString(String)

Konwertuje wartość tego wystąpienia na jego reprezentację ciągu równoważnego przy użyciu określonego 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

format
String String String String

Ciąg formatu.A format string.

Zwraca

Ciąg reprezentujący wartość tego wystąpienia określony przez format.The string representation of the value of this instance as specified by format.

Wyjątki

format zawiera nieprawidłową specyfikację.format contains an invalid specification.

format jest równy "X", ale typ wyliczeniowy jest nieznany.format equals "X", but the enumeration type is unknown.

Przykłady

Poniższy przykład pokazuje, jak przekonwertować wartość wyliczana 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)
Imports System

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 'Main
End Class 'Sample
'
'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

format Parametr może być jedną z następujących ciągów formatu: "G" lub "g", "D" lub "d", "X" lub "x" i "F" lub "f" (w formacie ciągu 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 ani być pustym ciągiem (""), specyfikator formatu ogólnego ("G") jest używany.If format is null or an empty string (""), the general format specifier ("G") is used. Aby uzyskać więcej informacji na temat wyliczanie ciągów formatujących i formatowania wartości wyliczenia, zobacz wyliczanie ciągów formatujących.For more information about the enumeration format strings and formatting enumeration values, see Enumeration Format Strings. Aby uzyskać więcej informacji na temat formatowania ogólnie rzecz biorąc, 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 mają taką samą wartość podstawowych i próbują pobrać ciąg reprezentujący nazwę elementu członkowskiego wyliczenia, na podstawie jego podstawowej wartości, kod nie powinna dokonywać czynić żadnych założeń o nazwie, który zwróci metoda.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, poniższy wyliczenie definiuje dwa elementy członkowskie, Shade.Gray i Shade.Grey, które mają taką samą wartość podstawowy.For example, the following enumeration defines two members, Shade.Gray and Shade.Grey, that have the same underlying value.

[! code-csharpSystem.Enum.ToString#1] [! kodu vbSystem.Enum.ToString#1][!code-csharpSystem.Enum.ToString#1] [!code-vbSystem.Enum.ToString#1] Następujące wywołanie metody podejmie próbę pobrania nazwy członka odcień wyliczenie, którego podstawowym wartością jest 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 zwrócić "Szarym" lub "Grey", a Twój kod, nie należy wprowadzać żadnych założeń, o których zostanie zwrócony ciąg.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] [! kodu vbSystem.Enum.ToString#3][!code-csharpSystem.Enum.ToString#3] [!code-vbSystem.Enum.ToString#3]

Zobacz też

ToString(IFormatProvider) ToString(IFormatProvider) ToString(IFormatProvider) ToString(IFormatProvider)

Ostrzeżenie

Ten interfejs API jest teraz przestarzały.

Tego przeciążenia metody jest przestarzała; 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

provider
IFormatProvider IFormatProvider IFormatProvider IFormatProvider

(przestarzałe)(obsolete)

Zwraca

Ciąg reprezentujący wartość tego wystąpienia.The string representation of the value of this instance.

Implementuje

ToString() ToString() ToString() ToString()

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

Ciąg reprezentujący wartość tego wystąpienia.The string representation of the value of this instance.

Przykłady

W poniższym przykładzie pokazano, konwertowania wartości wyliczenia 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'.
*/
Imports System

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 jeśli FlagsAttribute nie ma zastosowania do to Typ wyliczany i ma nazwanych stałych równa wartość tego wystąpienia, a następnie wartość zwracana jest ciąg zawierający 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 są stosowane i kombinacji jednego lub więcej nazwanych stałych jest równa wartości tego wystąpienia, a następnie wartość zwracana jest ciąg zawierający listę nazw stałych rozdzielonych ogranicznikami.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ść zwracana 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 wyliczanie ciągów formatujących.For more information about formatting enumeration values, see Enumeration Format Strings. Aby uzyskać więcej informacji na temat formatowania ogólnie rzecz biorąc, 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 mają taką samą wartość podstawowych i próbują pobrać ciąg reprezentujący nazwę elementu członkowskiego wyliczenia, na podstawie jego podstawowej wartości, kod nie powinna dokonywać czynić żadnych założeń o nazwie, który zwróci metoda.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, poniższy wyliczenie definiuje dwa elementy członkowskie, Shade.Gray i Shade.Grey, które mają taką samą wartość podstawowy.For example, the following enumeration defines two members, Shade.Gray and Shade.Grey, that have the same underlying value.

[! code-csharpSystem.Enum.ToString#1] [! kodu vbSystem.Enum.ToString#1][!code-csharpSystem.Enum.ToString#1] [!code-vbSystem.Enum.ToString#1] Następujące wywołanie metody podejmie próbę pobrania nazwy członka odcień wyliczenie, którego podstawowym wartością jest 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 zwrócić "Szarym" lub "Grey", a Twój kod, nie należy wprowadzać żadnych założeń, o których zostanie zwrócony ciąg.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] [! kodu vbSystem.Enum.ToString#2][!code-csharpSystem.Enum.ToString#2] [!code-vbSystem.Enum.ToString#2]

Zobacz też

Dotyczy