Enum.ToString Метод

Определение

Пространство имен:: System

Сборки:: netstandard.dll, System.Runtime.dll

Сборка:: System.Runtime.dll

Сборка:: mscorlib.dll

Сборка:: netstandard.dll

Сборки:: mscorlib.dll, System.Runtime.dll

Важно!

Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.

Преобразует значение этого экземпляра в эквивалентное строковое представление.

Перегрузки

Имя	Описание
ToString(String, IFormatProvider)	Устаревшие.. Устаревшие.. Эта перегрузка метода устарела; используйте ToString(String).
ToString()	Преобразует значение этого экземпляра в эквивалентное строковое представление.
ToString(String)	Преобразует значение этого экземпляра в эквивалентное строковое представление с помощью указанного формата.
ToString(IFormatProvider)	Устаревшие.. Устаревшие.. Эта перегрузка метода устарела; используйте ToString().

ToString(String, IFormatProvider)

Исходный код:: Enum.cs

Исходный код:: Enum.cs

Исходный код:: Enum.cs

Исходный код:: Enum.cs

Исходный код:: Enum.cs

Внимание

The provider argument is not used. Use ToString(String) instead.

Внимание

The provider argument is not used. Please use ToString(String).

Эта перегрузка метода устарела; используйте ToString(String).

public:
 virtual System::String ^ ToString(System::String ^ format, IFormatProvider ^ provider);

[System.Obsolete("The provider argument is not used. Use ToString(String) instead.")]
public string ToString(string? format, IFormatProvider? provider);

[System.Obsolete("The provider argument is not used. Please use ToString(String).")]
public string ToString(string? format, IFormatProvider? provider);

[System.Obsolete("The provider argument is not used. Please use ToString(String).")]
public string ToString(string format, IFormatProvider provider);

public string ToString(string format, IFormatProvider provider);

[<System.Obsolete("The provider argument is not used. Use ToString(String) instead.")>]
override this.ToString : string * IFormatProvider -> string

[<System.Obsolete("The provider argument is not used. Please use ToString(String).")>]
override this.ToString : string * IFormatProvider -> string

override this.ToString : string * IFormatProvider -> string

Public Function ToString (format As String, provider As IFormatProvider) As String

Параметры

format: String

Спецификация формата.

provider: IFormatProvider

(Устаревшее.)

Возвращаемое значение

String

Строковое представление значения этого экземпляра, указанного в параметре format.

Реализации

ToString(String, IFormatProvider)

Атрибуты: ObsoleteAttribute

Исключения

FormatException

format не содержит допустимой спецификации формата.

InvalidOperationException

format равно "X", но тип перечисления неизвестен.

Параметр format может быть одной из следующих строк формата: "G" или "g", "D" или "d", "X" или "x", а "F" или "f" (строка формата не учитывает регистр). Если format используется null пустая строка (""), используется описатель общего формата (G). Дополнительные сведения о строках формата перечисления и значениях форматирования см. в разделе "Строки формата перечисления". Дополнительные сведения о форматировании в целом см. в разделе "Типы форматирования".

Укажите только format; provider параметр устарел.

См. также раздел

Применяется к

ToString()

Исходный код:: Enum.cs

Исходный код:: Enum.cs

Исходный код:: Enum.cs

Исходный код:: Enum.cs

Исходный код:: Enum.cs

Преобразует значение этого экземпляра в эквивалентное строковое представление.

public:
 override System::String ^ ToString();

public override string ToString();

override this.ToString : unit -> string

Public Overrides Function ToString () As String

Возвращаемое значение

String

Строковое представление значения этого экземпляра.

Примеры

В следующем примере показано преобразование перечисленного значения в строку.

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'.
*/

type Colors =
    | Red = 1
    | Blue = 2

let myColors = Colors.Red
printfn $"The value of this instance is '{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'.

Возвращаемое значение отформатировано с помощью общего описателя формата ("G"). То есть, если FlagsAttribute к перечислению не применяется и имеется именованной константы, равной значению этого экземпляра, возвращается строка, содержащая имя константы. FlagsAttribute Если применяется и существует сочетание одной или нескольких именованных констант, равных значению этого экземпляра, возвращаемое значение является строкой, содержащей разделенный разделителями список имен констант. В противном случае возвращаемое значение представляет строковое представление числового значения этого экземпляра. Дополнительные сведения о форматировании значений перечисления см. в разделе "Строки формата перечисления". Дополнительные сведения о форматировании в целом см. в разделе "Типы форматирования".

Примечания для тех, кто вызывает этот метод

Если несколько элементов перечисления имеют одно и то же базовое значение, и вы пытаетесь получить строковое представление имени элемента перечисления на основе его базового значения, код не должен делать никаких предположений о том, какое имя будет возвращать метод. Например, следующее перечисление определяет два члена и Shade.GrayShade.Greyимеет одно и то же базовое значение.

enum Shade
{
    White = 0, Gray = 1, Grey = 1, Black = 2
}

type Shade =
    | White = 0
    | Gray = 1
    | Grey = 1
    | Black = 2

Public Enum Shade
   White = 0
   Gray = 1
   Grey = 1
   Black = 2
End Enum

Следующий вызов метода пытается получить имя члена Shade перечисления, базовое значение которого равно 1. Метод может возвращать значение "Серый" или "Серый", и код не должен делать никаких предположений о том, какая строка будет возвращена.

string shadeName = ((Shade) 1).ToString();

let shadeName = (enum<Shade> 1).ToString()

Dim shadeName As String = CType(1, Shade).ToString()

См. также раздел

Применяется к

ToString(String)

Исходный код:: Enum.cs

Исходный код:: Enum.cs

Исходный код:: Enum.cs

Исходный код:: Enum.cs

Исходный код:: Enum.cs

Преобразует значение этого экземпляра в эквивалентное строковое представление с помощью указанного формата.

public:
 System::String ^ ToString(System::String ^ format);

public string ToString(string format);

public string ToString(string? format);

override this.ToString : string -> string

Public Function ToString (format As String) As String

Параметры

format: String

Строка формата.

Возвращаемое значение

String

Строковое представление значения этого экземпляра, указанного в параметре format.

Исключения

FormatException

format содержит недопустимую спецификацию.

InvalidOperationException

format равно "X", но тип перечисления неизвестен.

Примеры

В следующем примере показано, как преобразовать перечисленное значение в строку.

// 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)
open System

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

let myColor = Colors.Yellow

printfn $"""Colors.Red = {Colors.Red.ToString "d"}"""
printfn $"""Colors.Green = {Colors.Green.ToString "d"}"""
printfn $"""Colors.Blue = {Colors.Blue.ToString "d"}"""
printfn $"""Colors.Yellow = {Colors.Yellow.ToString "d"}"""

printfn "\nmyColor = Colors.Yellow\n"

printfn $"""myColor.ToString("g") = {myColor.ToString "g"}"""
printfn $"""myColor.ToString("G") = {myColor.ToString "G"}"""

printfn $"""myColor.ToString("x") = {myColor.ToString "x"}"""
printfn $"""myColor.ToString("X") = {myColor.ToString "X"}"""

printfn $"""myColor.ToString("d") = {myColor.ToString "d"}"""
printfn $"""myColor.ToString("D") = {myColor.ToString "d"}"""

printfn $"""myColor.ToString("f") = {myColor.ToString "f"}"""
printfn $"""myColor.ToString("F") = {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
'

Примечания для тех, кто вызывает этот метод

enum Shade
{
    White = 0, Gray = 1, Grey = 1, Black = 2
}

type Shade =
    | White = 0
    | Gray = 1
    | Grey = 1
    | Black = 2

Public Enum Shade
   White = 0
   Gray = 1
   Grey = 1
   Black = 2
End Enum

string shadeName = ((Shade) 1).ToString("F");

let shadeName = (enum<Shade> 1).ToString "F"

Dim shadeName As String = CType(1, Shade).ToString("F")

См. также раздел

Применяется к

ToString(IFormatProvider)

Исходный код:: Enum.cs

Исходный код:: Enum.cs

Исходный код:: Enum.cs

Исходный код:: Enum.cs

Исходный код:: Enum.cs

Внимание

The provider argument is not used. Use ToString() instead.

Внимание

The provider argument is not used. Please use ToString().

Эта перегрузка метода устарела; используйте ToString().

public:
 virtual System::String ^ ToString(IFormatProvider ^ provider);

[System.Obsolete("The provider argument is not used. Use ToString() instead.")]
public string ToString(IFormatProvider? provider);

[System.Obsolete("The provider argument is not used. Please use ToString().")]
public string ToString(IFormatProvider? provider);

[System.Obsolete("The provider argument is not used. Please use ToString().")]
public string ToString(IFormatProvider provider);

public string ToString(IFormatProvider provider);

[<System.Obsolete("The provider argument is not used. Use ToString() instead.")>]
override this.ToString : IFormatProvider -> string

[<System.Obsolete("The provider argument is not used. Please use ToString().")>]
override this.ToString : IFormatProvider -> string

override this.ToString : IFormatProvider -> string

Public Function ToString (provider As IFormatProvider) As String

Параметры

provider: IFormatProvider

(устарело)

Возвращаемое значение

String

Строковое представление значения этого экземпляра.

Реализации

ToString(IFormatProvider)

Атрибуты: ObsoleteAttribute

Применяется к

Обратная связь

Были ли сведения на этой странице полезными?

Enum.ToString Метод

Определение

Перегрузки

ToString(String, IFormatProvider)

Параметры

Возвращаемое значение

Реализации

Исключения

Комментарии

См. также раздел

Применяется к

ToString()

Возвращаемое значение

Примеры

Комментарии

Примечания для тех, кто вызывает этот метод

См. также раздел

Применяется к

ToString(String)

Параметры

Возвращаемое значение

Исключения

Примеры

Комментарии

Примечания для тех, кто вызывает этот метод

См. также раздел

Применяется к

ToString(IFormatProvider)

Параметры

Возвращаемое значение

Реализации

Применяется к