Format()

static string System.Enum.Format ( Type enumType, object value, string format )

inlinestatic

Definition at line 896 of file Enum.cs.

    {
        RuntimeType enumType2 = ValidateRuntimeType(enumType);
        if (value == null)
        {
            throw new ArgumentNullException("value");
        }
        if (format == null)
        {
            throw new ArgumentNullException("format");
        }
        Type type = value.GetType();
        if (type.IsEnum)
        {
            if (!type.IsEquivalentTo(enumType))
            {
                throw new ArgumentException(SR.Format(SR.Arg_EnumAndObjectMustBeSameType, type, enumType));
            }
            if (format.Length != 1)
            {
                throw new FormatException(SR.Format_InvalidEnumFormatSpecification);
            }
            return ((Enum)value).ToString(format);
        }
        Type underlyingType = GetUnderlyingType(enumType);
        if (type != underlyingType)
        {
            throw new ArgumentException(SR.Format(SR.Arg_EnumFormatUnderlyingTypeAndObjectMustBeSameType, type, underlyingType));
        }
        if (format.Length == 1)
        {
            switch (format[0])
            {
            case 'G':
            case 'g':
                return InternalFormat(enumType2, ToUInt64(value)) ?? value.ToString();
            case 'D':
            case 'd':
                return value.ToString();
            case 'X':
            case 'x':
                return ValueToHexString(value);
            case 'F':
            case 'f':
                return InternalFlagsFormat(enumType2, ToUInt64(value)) ?? value.ToString();
            }
        }
        throw new FormatException(SR.Format_InvalidEnumFormatSpecification);
    }

References System.SR.Arg_EnumAndObjectMustBeSameType, System.SR.Arg_EnumFormatUnderlyingTypeAndObjectMustBeSameType, System.SR.Format(), System.format, System.SR.Format_InvalidEnumFormatSpecification, System.Type.GetType(), System.Enum.GetUnderlyingType(), System.Enum.InternalFlagsFormat(), System.Enum.InternalFormat(), System.Enum.ToUInt64(), System.type, System.Enum.ValidateRuntimeType(), System.value, and System.Enum.ValueToHexString().

Referenced by System.ComponentModel.EnumConverter.ConvertTo(), System.Xml.Serialization.SoapReflectionImporter.GetDefaultValue(), and System.Xml.Serialization.XmlReflectionImporter.GetDefaultValue().