mcs/class/corlib/Documentation/en/System.Globalization/DateTimeStyles.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="DateTimeStyles" FullName="System.Globalization.DateTimeStyles" FullNameSP="System_Globalization_DateTimeStyles" Maintainer="ecma">
   3   <TypeSignature Language="ILASM" Value=".class public sealed serializable DateTimeStyles extends System.Enum" />
   4   <TypeSignature Language="C#" Value="public enum DateTimeStyles" />
   5   <TypeSignature Language="ILAsm" Value=".class public auto ansi serializable sealed DateTimeStyles extends System.Enum" />
   6   <MemberOfLibrary>BCL</MemberOfLibrary>
   7   <AssemblyInfo>
   8     <AssemblyName>mscorlib</AssemblyName>
   9     <AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00 ]</AssemblyPublicKey>
  10     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  11     <AssemblyVersion>2.0.0.0</AssemblyVersion>
  12     <AssemblyVersion>4.0.0.0</AssemblyVersion>
  13   </AssemblyInfo>
  14   <Base>
  15     <BaseTypeName>System.Enum</BaseTypeName>
  16   </Base>
  17   <Attributes>
  18     <Attribute>
  19       <AttributeName>System.Flags</AttributeName>
  20     </Attribute>
  21     <Attribute>
  22       <AttributeName>System.Runtime.InteropServices.ComVisible(true)</AttributeName>
  23     </Attribute>
  24   </Attributes>
  25   <Docs>
  26     <remarks>
  27       <attribution license="cc4" from="Microsoft" modified="false" />
  28       <para>
  29         <see cref="T:System.Globalization.DateTimeStyles" /> values can be used with any of the following date and time parsing methods that include a <paramref name="styles" /> parameter to define the interpretation of the style elements that may be present in the string to be parsed:</para>
  30       <list type="bullet">
  31         <item>
  32           <para>
  33             <see cref="M:System.DateTime.Parse(System.String)" />
  34           </para>
  35         </item>
  36         <item>
  37           <para>
  38             <see cref="M:System.DateTimeOffset.Parse(System.String)" />
  39           </para>
  40         </item>
  41         <item>
  42           <para>
  43             <see cref="M:System.DateTime.TryParse(System.String,System.DateTime@)" />
  44           </para>
  45         </item>
  46         <item>
  47           <para>
  48             <see cref="M:System.DateTimeOffset.TryParse(System.String,System.DateTimeOffset@)" />
  49           </para>
  50         </item>
  51         <item>
  52           <para>
  53             <see cref="M:System.DateTime.ParseExact(System.String,System.String,System.IFormatProvider)" />
  54           </para>
  55         </item>
  56         <item>
  57           <para>
  58             <see cref="M:System.DateTimeOffset.ParseExact(System.String,System.String,System.IFormatProvider)" />
  59           </para>
  60         </item>
  61         <item>
  62           <para>
  63             <see cref="M:System.DateTime.TryParseExact(System.String,System.String,System.IFormatProvider,System.Globalization.DateTimeStyles,System.DateTime@)" />
  64           </para>
  65         </item>
  66         <item>
  67           <para>
  68             <see cref="M:System.DateTimeOffset.TryParseExact(System.String,System.String,System.IFormatProvider,System.Globalization.DateTimeStyles,System.DateTimeOffset@)" />
  69           </para>
  70         </item>
  71       </list>
  72       <para>The ParseExact and TryParseExact methods can use any of the <see cref="T:System.Globalization.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.</para>
  73       <para>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 <see cref="F:System.Globalization.DateTimeStyles.AdjustToUniversal" /> value. The same effect can be achieved by calling the <see cref="M:System.DateTime.ToUniversalTime" /> or <see cref="M:System.DateTimeOffset.ToUniversalTime" /> method. However, using the <see cref="F:System.Globalization.DateTimeStyles.AdjustToUniversal" /> value with the date and time parsing method is more efficient.</para>
  74     </remarks>
  75     <summary>
  76       <attribution license="cc4" from="Microsoft" modified="false" />
  77       <para>Defines the formatting options that customize string parsing for some date and time parsing methods.</para>
  78     </summary>
  79   </Docs>
  80   <Members>
  81     <Member MemberName="AdjustToUniversal">
  82       <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Globalization.DateTimeStyles AdjustToUniversal = 0x10" />
  83       <MemberSignature Language="C#" Value="AdjustToUniversal" />
  84       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Globalization.DateTimeStyles AdjustToUniversal = int32(16)" />
  85       <MemberType>Field</MemberType>
  86       <AssemblyInfo>
  87         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  88         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  89         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  90       </AssemblyInfo>
  91       <ReturnValue>
  92         <ReturnType>System.Globalization.DateTimeStyles</ReturnType>
  93       </ReturnValue>
  94       <Parameters />
  95       <MemberValue>AdjustToUniversal</MemberValue>
  96       <Docs>
  97         <remarks>
  98           <attribution license="cc4" from="Microsoft" modified="false" />
  99           <para>This value cannot be used with <see cref="F:System.Globalization.DateTimeStyles.RoundtripKind" />.</para>
 100         </remarks>
 101         <summary>
 102           <attribution license="cc4" from="Microsoft" modified="false" />
 103           <para>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 <see cref="F:System.Globalization.DateTimeStyles.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 <see cref="F:System.Globalization.DateTimeStyles.AssumeUniversal" />, no conversion occurs. If the input string does not denote a local or UTC time, no conversion occurs and the resulting <see cref="P:System.DateTime.Kind" /> property is <see cref="F:System.DateTimeKind.Unspecified" />. </para>
 104         </summary>
 105       </Docs>
 106       <Excluded>0</Excluded>
 107     </Member>
 108     <Member MemberName="AllowInnerWhite">
 109       <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Globalization.DateTimeStyles AllowInnerWhite = 0x4" />
 110       <MemberSignature Language="C#" Value="AllowInnerWhite" />
 111       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Globalization.DateTimeStyles AllowInnerWhite = int32(4)" />
 112       <MemberType>Field</MemberType>
 113       <AssemblyInfo>
 114         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 115         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 116         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 117       </AssemblyInfo>
 118       <ReturnValue>
 119         <ReturnType>System.Globalization.DateTimeStyles</ReturnType>
 120       </ReturnValue>
 121       <Parameters />
 122       <MemberValue>AllowInnerWhite</MemberValue>
 123       <Docs>
 124         <remarks>To be added.</remarks>
 125         <summary>
 126           <attribution license="cc4" from="Microsoft" modified="false" />
 127           <para>Extra white-space characters in the middle of the string must be ignored during parsing, except if they occur in the <see cref="T:System.Globalization.DateTimeFormatInfo" /> format patterns.</para>
 128         </summary>
 129       </Docs>
 130       <Excluded>0</Excluded>
 131     </Member>
 132     <Member MemberName="AllowLeadingWhite">
 133       <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Globalization.DateTimeStyles AllowLeadingWhite = 0x1" />
 134       <MemberSignature Language="C#" Value="AllowLeadingWhite" />
 135       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Globalization.DateTimeStyles AllowLeadingWhite = int32(1)" />
 136       <MemberType>Field</MemberType>
 137       <AssemblyInfo>
 138         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 139         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 140         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 141       </AssemblyInfo>
 142       <ReturnValue>
 143         <ReturnType>System.Globalization.DateTimeStyles</ReturnType>
 144       </ReturnValue>
 145       <Parameters />
 146       <MemberValue>AllowLeadingWhite</MemberValue>
 147       <Docs>
 148         <remarks>To be added.</remarks>
 149         <summary>
 150           <attribution license="cc4" from="Microsoft" modified="false" />
 151           <para>Leading white-space characters must be ignored during parsing, except if they occur in the <see cref="T:System.Globalization.DateTimeFormatInfo" /> format patterns.</para>
 152         </summary>
 153       </Docs>
 154       <Excluded>0</Excluded>
 155     </Member>
 156     <Member MemberName="AllowTrailingWhite">
 157       <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Globalization.DateTimeStyles AllowTrailingWhite = 0x2" />
 158       <MemberSignature Language="C#" Value="AllowTrailingWhite" />
 159       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Globalization.DateTimeStyles AllowTrailingWhite = int32(2)" />
 160       <MemberType>Field</MemberType>
 161       <AssemblyInfo>
 162         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 163         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 164         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 165       </AssemblyInfo>
 166       <ReturnValue>
 167         <ReturnType>System.Globalization.DateTimeStyles</ReturnType>
 168       </ReturnValue>
 169       <Parameters />
 170       <MemberValue>AllowTrailingWhite</MemberValue>
 171       <Docs>
 172         <remarks>To be added.</remarks>
 173         <summary>
 174           <attribution license="cc4" from="Microsoft" modified="false" />
 175           <para>Trailing white-space characters must be ignored during parsing, except if they occur in the <see cref="T:System.Globalization.DateTimeFormatInfo" /> format patterns.</para>
 176         </summary>
 177       </Docs>
 178       <Excluded>0</Excluded>
 179     </Member>
 180     <Member MemberName="AllowWhiteSpaces">
 181       <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Globalization.DateTimeStyles AllowWhiteSpaces = AllowLeadingWhite | AllowTrailingWhite | AllowInnerWhite" />
 182       <MemberSignature Language="C#" Value="AllowWhiteSpaces" />
 183       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Globalization.DateTimeStyles AllowWhiteSpaces = int32(7)" />
 184       <MemberType>Field</MemberType>
 185       <AssemblyInfo>
 186         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 187         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 188         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 189       </AssemblyInfo>
 190       <ReturnValue>
 191         <ReturnType>System.Globalization.DateTimeStyles</ReturnType>
 192       </ReturnValue>
 193       <Parameters />
 194       <MemberValue>AllowWhiteSpaces</MemberValue>
 195       <Docs>
 196         <remarks>To be added.</remarks>
 197         <summary>
 198           <attribution license="cc4" from="Microsoft" modified="false" />
 199           <para>Extra white-space characters anywhere in the string must be ignored during parsing, except if they occur in the <see cref="T:System.Globalization.DateTimeFormatInfo" /> format patterns. This value is a combination of the <see cref="F:System.Globalization.DateTimeStyles.AllowLeadingWhite" />, <see cref="F:System.Globalization.DateTimeStyles.AllowTrailingWhite" />, and <see cref="F:System.Globalization.DateTimeStyles.AllowInnerWhite" /> values.</para>
 200         </summary>
 201       </Docs>
 202       <Excluded>0</Excluded>
 203     </Member>
 204     <Member MemberName="AssumeLocal">
 205       <MemberSignature Language="C#" Value="AssumeLocal" />
 206       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Globalization.DateTimeStyles AssumeLocal = int32(32)" />
 207       <MemberType>Field</MemberType>
 208       <AssemblyInfo>
 209         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 210         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 211       </AssemblyInfo>
 212       <ReturnValue>
 213         <ReturnType>System.Globalization.DateTimeStyles</ReturnType>
 214       </ReturnValue>
 215       <Docs>
 216         <since version=".NET 2.0" />
 217         <remarks>
 218           <attribution license="cc4" from="Microsoft" modified="false" />
 219           <para>This value cannot be used with <see cref="F:System.Globalization.DateTimeStyles.AssumeUniversal" /> or <see cref="F:System.Globalization.DateTimeStyles.RoundtripKind" />.</para>
 220         </remarks>
 221         <summary>
 222           <attribution license="cc4" from="Microsoft" modified="false" />
 223           <para>If no time zone is specified in the parsed string, the string is assumed to denote a local time. </para>
 224         </summary>
 225       </Docs>
 226     </Member>
 227     <Member MemberName="AssumeUniversal">
 228       <MemberSignature Language="C#" Value="AssumeUniversal" />
 229       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Globalization.DateTimeStyles AssumeUniversal = int32(64)" />
 230       <MemberType>Field</MemberType>
 231       <AssemblyInfo>
 232         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 233         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 234       </AssemblyInfo>
 235       <ReturnValue>
 236         <ReturnType>System.Globalization.DateTimeStyles</ReturnType>
 237       </ReturnValue>
 238       <Docs>
 239         <since version=".NET 2.0" />
 240         <remarks>
 241           <attribution license="cc4" from="Microsoft" modified="false" />
 242           <para>This value cannot be used with <see cref="F:System.Globalization.DateTimeStyles.AssumeLocal" /> or <see cref="F:System.Globalization.DateTimeStyles.RoundtripKind" />.</para>
 243         </remarks>
 244         <summary>
 245           <attribution license="cc4" from="Microsoft" modified="false" />
 246           <para>If no time zone is specified in the parsed string, the string is assumed to denote a UTC. </para>
 247         </summary>
 248       </Docs>
 249     </Member>
 250     <Member MemberName="NoCurrentDateDefault">
 251       <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Globalization.DateTimeStyles NoCurrentDateDefault = 0x8" />
 252       <MemberSignature Language="C#" Value="NoCurrentDateDefault" />
 253       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Globalization.DateTimeStyles NoCurrentDateDefault = int32(8)" />
 254       <MemberType>Field</MemberType>
 255       <AssemblyInfo>
 256         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 257         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 258         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 259       </AssemblyInfo>
 260       <ReturnValue>
 261         <ReturnType>System.Globalization.DateTimeStyles</ReturnType>
 262       </ReturnValue>
 263       <Parameters />
 264       <MemberValue>NoCurrentDateDefault</MemberValue>
 265       <Docs>
 266         <remarks>To be added.</remarks>
 267         <summary>
 268           <attribution license="cc4" from="Microsoft" modified="false" />
 269           <para>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.</para>
 270         </summary>
 271       </Docs>
 272       <Excluded>0</Excluded>
 273     </Member>
 274     <Member MemberName="None">
 275       <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Globalization.DateTimeStyles None = 0x0" />
 276       <MemberSignature Language="C#" Value="None" />
 277       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Globalization.DateTimeStyles None = int32(0)" />
 278       <MemberType>Field</MemberType>
 279       <AssemblyInfo>
 280         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 281         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 282         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 283       </AssemblyInfo>
 284       <ReturnValue>
 285         <ReturnType>System.Globalization.DateTimeStyles</ReturnType>
 286       </ReturnValue>
 287       <Parameters />
 288       <MemberValue>None</MemberValue>
 289       <Docs>
 290         <remarks>To be added.</remarks>
 291         <summary>
 292           <attribution license="cc4" from="Microsoft" modified="false" />
 293           <para>Default formatting options must be used. This value represents the default style for the <see cref="M:System.DateTime.Parse(System.String)" />, <see cref="M:System.DateTime.ParseExact(System.String,System.String,System.IFormatProvider)" />, and <see cref="M:System.DateTime.TryParse(System.String,System.DateTime@)" /> methods.</para>
 294         </summary>
 295       </Docs>
 296       <Excluded>0</Excluded>
 297     </Member>
 298     <Member MemberName="RoundtripKind">
 299       <MemberSignature Language="C#" Value="RoundtripKind" />
 300       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Globalization.DateTimeStyles RoundtripKind = int32(128)" />
 301       <MemberType>Field</MemberType>
 302       <AssemblyInfo>
 303         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 304         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 305       </AssemblyInfo>
 306       <ReturnValue>
 307         <ReturnType>System.Globalization.DateTimeStyles</ReturnType>
 308       </ReturnValue>
 309       <Docs>
 310         <since version=".NET 2.0" />
 311         <summary>
 312           <attribution license="cc4" from="Microsoft" modified="false" />
 313           <para>The <see cref="T:System.DateTimeKind" /> field of a date is preserved when a <see cref="T:System.DateTime" /> object is converted to a string using the "o" or "r" standard format specifier, and the string is then converted back to a <see cref="T:System.DateTime" /> object.</para>
 314         </summary>
 315       </Docs>
 316     </Member>
 317   </Members>
 318   <TypeExcluded>0</TypeExcluded>
 319 </Type>