¿Le resultó útil esta página?
Sus comentarios sobre este contenido son muy importantes. Háganos saber su opinión.
¿Tiene comentarios adicionales?
Caracteres restantes: 1500
Format (Método)

Enum.Format (Método)

Convierte el valor especificado de un tipo enumerado especificado en la representación de cadena equivalente de acuerdo con el formato especificado.

Espacio de nombres: System
Ensamblado: mscorlib (en mscorlib.dll)

[ComVisibleAttribute(true)] 
public static string Format (
	Type enumType,
	Object value,
	string format
)
/** @attribute ComVisibleAttribute(true) */ 
public static String Format (
	Type enumType, 
	Object value, 
	String format
)
ComVisibleAttribute(true) 
public static function Format (
	enumType : Type, 
	value : Object, 
	format : String
) : String

Parámetros

enumType

Tipo de enumeración del valor que se va a convertir.

value

Valor que se va a convertir.

format

Formato de resultados que se va a utilizar.

Valor devuelto

Representación de cadena de value.

Tipo de excepciónCondición

ArgumentNullException

Los parámetros enumType, value o format son referencia de objeto null (Nothing en Visual Basic).

ArgumentException

El parámetro enumType no es un tipo Enum.

O bien,

value procede de una enumeración que difiere en tipo de enumType.

O bien,

El tipo de value no es un tipo subyacente de enumType.

FormatException

El parámetro format contiene un valor que no es válido.

Los valores de formato válidos son:

Formato

Descripción

"G" o "g"

Si value es igual a una constante enumerada con nombre, se devuelve el nombre de dicha constante; en caso contrario, se devuelve el equivalente decimal de value.

Por ejemplo, supongamos que la única constante enumerada se denomina Red y que su valor es 1. Si value se especifica como 1, este formato devuelve "Red". No obstante, si value se especifica como 2, este formato devuelve "2".

O bien

Si se aplica el atributo personalizado FlagsAttribute a la enumeración, entonces value se considera como un campo de bits que contiene uno o varios indicadores que se componen de uno o más bits.

Si value es igual a una combinación de constantes enumeradas con nombre, se devuelve una lista con los nombres de dichas constantes, separados por delimitadores. Se buscan los indicadores de value, desde el que tiene el mayor valor hasta el que tiene el menor valor. En los casos en los que un indicador se corresponde con un campo de bits de value, el nombre de la constante se concatena con la lista separada por delimitadores. Después, el valor de dicho indicador deja de tenerse en cuenta y se reanuda la búsqueda del siguiente indicador.

Si value no es igual a una combinación de constantes enumeradas con nombre, se devuelve el número decimal equivalente a value.

"X" o "x"

Representa value en formato hexadecimal sin el "0x" inicial.

"D" o "d"

Representa value en formato decimal.

"F" o "f"

Se comporta de forma idéntica a "G" o "g", excepto que no es necesario que FlagsAttribute esté presente en la declaración de Enum.

En el siguiente ejemplo de código se muestra el uso de Format en el contexto de Enum.

using System;

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

    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"));
    }
}

import System.*;

public class FormatTest
{
    enum Colors
    {
        red (0),
        green (1),
        blue (2),
        yellow (3);
    } //Colors

    public static void main(String[] args)
    {
        Colors myColor = Colors.blue;

        Console.WriteLine("My favorite color is {0}", myColor);
        Console.WriteLine("The value of my favorite color is {0}", 
            Enum.Format(Colors.class.ToType(), myColor, "d"));
        Console.WriteLine("The hex value of my favorite color is {0}", 
            Enum.Format(Colors.class.ToType(), myColor, "x"));
    } //main
} //FormatTest

import System;

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

    public static function Main() {
        var myColor : Colors = Colors.Blue;

        Console.WriteLine("My favorite color is {0}", myColor);
        Console.WriteLine("The value of my favorite color is {0}", Enum.Format(Colors, myColor, "d"));
        Console.WriteLine("The hex value of my favorite color is {0}", Enum.Format(Colors, myColor, "x"));
    }
}

Windows 98, Windows 2000 SP4, Windows Millennium, Windows Server 2003, Windows XP Media Center, Windows XP Professional x64, Windows XP SP2, Windows XP Starter Edition

.NET Framework no admite todas las versiones de cada plataforma. Para obtener una lista de las versiones admitidas, vea Requisitos del sistema.

.NET Framework

Compatible con: 2.0, 1.1, 1.0

Adiciones de comunidad

AGREGAR
Mostrar:
© 2015 Microsoft