DateTimeStyles Enum
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Defines the formatting options that customize string parsing for some date and time parsing methods.
This enumeration supports a bitwise combination of its member values.
public enum class DateTimeStyles[System.Flags]
public enum DateTimeStyles[System.Flags]
[System.Serializable]
public enum DateTimeStyles[System.Flags]
[System.Serializable]
[System.Runtime.InteropServices.ComVisible(true)]
public enum DateTimeStyles[<System.Flags>]
type DateTimeStyles = [<System.Flags>]
[<System.Serializable>]
type DateTimeStyles = [<System.Flags>]
[<System.Serializable>]
[<System.Runtime.InteropServices.ComVisible(true)>]
type DateTimeStyles = Public Enum DateTimeStyles- Inheritance
- Attributes
Fields
| Name | Value | Description |
|---|---|---|
| None | 0 | Default formatting options must be used. This value represents the default style for the Parse(String), ParseExact(String, String, IFormatProvider), and TryParse(String, DateTime) methods. |
| AllowLeadingWhite | 1 | Leading white-space characters must be ignored during parsing, except if they occur in the DateTimeFormatInfo format patterns. |
| AllowTrailingWhite | 2 | Trailing white-space characters must be ignored during parsing, except if they occur in the DateTimeFormatInfo format patterns. |
| AllowInnerWhite | 4 | Extra white-space characters in the middle of the string must be ignored during parsing, except if they occur in the DateTimeFormatInfo format patterns. |
| AllowWhiteSpaces | 7 | Extra white-space characters anywhere in the string must be ignored during parsing, except if they occur in the DateTimeFormatInfo format patterns. This value is a combination of the AllowLeadingWhite, AllowTrailingWhite, and AllowInnerWhite values. |
| NoCurrentDateDefault | 8 | If the parsed string contains only the time and not the date, the parsing methods assume the Gregorian date with year = 1, month = 1, and day = 1. If this value is not used, the current date is assumed. |
| AdjustToUniversal | 16 | Date and time are returned as a Coordinated Universal Time (UTC). If the input string denotes a local time, through a time zone specifier or AssumeLocal, the date and time are converted from the local time to UTC. If the input string denotes a UTC time, through a time zone specifier or AssumeUniversal, no conversion occurs. If the input string does not denote a local or UTC time, no conversion occurs and the resulting Kind property is Unspecified. This value cannot be used with RoundtripKind. |
| AssumeLocal | 32 | If no time zone is specified in the parsed string, the string is assumed to denote a local time. This value cannot be used with AssumeUniversal or RoundtripKind. |
| AssumeUniversal | 64 | If no time zone is specified in the parsed string, the string is assumed to denote a UTC. This value cannot be used with AssumeLocal or RoundtripKind. |
| RoundtripKind | 128 | The DateTimeKind field of a date is preserved when a DateTime object is converted to a string using the "o" or "r" standard format specifier, and the string is then converted back to a DateTime object. |
Remarks
DateTimeStyles values can be used with any of the following date and time parsing methods that include a styles parameter to define the interpretation of the style elements that may be present in the string to be parsed:
The ParseExact and TryParseExact methods can use any of the DateTimeStyles values. However, if none of the Allow* values is selected, the input string must have exactly the same white-space characters as the format string.
If the input string does not contain any indication of the time zone, the date and time parsing methods interpret the value of the date and time string based on the time zone setting for the operating system. To convert the date and time to the Universal Time or Greenwich Mean Time (GMT), the application should use the AdjustToUniversal value. The same effect can be achieved by calling the DateTime.ToUniversalTime or DateTimeOffset.ToUniversalTime method. However, using the AdjustToUniversal value with the date and time parsing method is more efficient.
