System.Globalization.DateTimeFormatInfo.cs

#region 程序集 mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089
// C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETFramework\v4.6.1\mscorlib.dll
#endregion

using System.Runtime.InteropServices;

namespace System.Globalization
{
    //
    // 摘要:
    //     提供有关日期和时间值格式的区域性特定信息。
    [ComVisible(true)]
    public sealed class DateTimeFormatInfo : ICloneable, IFormatProvider
    {
        //
        // 摘要:
        //     初始化不依赖于区域性的（固定的）System.Globalization.DateTimeFormatInfo 类的新可写实例。
        public DateTimeFormatInfo();

        //
        // 摘要:
        //     获取基于当前区域性对值进行格式设置的只读的 System.Globalization.DateTimeFormatInfo 对象。
        //
        // 返回结果:
        //     一个基于当前线程的 System.Globalization.CultureInfo 对象的只读的 System.Globalization.DateTimeFormatInfo
        //     对象。
        public static DateTimeFormatInfo CurrentInfo { get; }
        //
        // 摘要:
        //     获取默认值，只读 System.Globalization.DateTimeFormatInfo 对象，该对象依赖于区域性的 （固定）。
        //
        // 返回结果:
        //     不依赖于区域性的（固定的）默认只读对象。
        public static DateTimeFormatInfo InvariantInfo { get; }
        //
        // 摘要:
        //     为长时间值获取或设置自定义格式字符串。
        //
        // 返回结果:
        //     长时间值的格式模式。
        //
        // 异常:
        //   T:System.ArgumentNullException:
        //     该属性设置为 null。
        //
        //   T:System.InvalidOperationException:
        //     设置了该属性，但 System.Globalization.DateTimeFormatInfo 对象为只读。
        public string LongTimePattern { get; set; }
        //
        // 摘要:
        //     获取或设置月份和日期值的自定义格式字符串。
        //
        // 返回结果:
        //     月份和日期值的自定义格式字符串。
        //
        // 异常:
        //   T:System.ArgumentNullException:
        //     该属性设置为 null。
        //
        //   T:System.InvalidOperationException:
        //     设置了该属性，但 System.Globalization.DateTimeFormatInfo 对象为只读。
        public string MonthDayPattern { get; set; }
        //
        // 摘要:
        //     获取或设置表示处于“下午”（中午后）的各小时的字符串指示符。
        //
        // 返回结果:
        //     表示处于“下午”（中午后）的各小时的字符串指示符。 默认值为 System.Globalization.DateTimeFormatInfo.InvariantInfo
        //     "pm"。
        //
        // 异常:
        //   T:System.ArgumentNullException:
        //     该属性设置为 null。
        //
        //   T:System.InvalidOperationException:
        //     设置了该属性，但 System.Globalization.DateTimeFormatInfo 对象为只读。
        public string PMDesignator { get; set; }
        //
        // 摘要:
        //     获取自定义的格式字符串，该字符串用于基于 Internet 工程任务组 (IETF) 征求意见文档 (RFC) 1123 规范的时间值。
        //
        // 返回结果:
        //     基于 IETF RFC 1123 规范的时间值的自定义格式字符串。
        public string RFC1123Pattern { get; }
        //
        // 摘要:
        //     获取或设置短日期值的自定义格式字符串。
        //
        // 返回结果:
        //     短日期值的自定义格式字符串。
        //
        // 异常:
        //   T:System.ArgumentNullException:
        //     该属性设置为 null。
        //
        //   T:System.InvalidOperationException:
        //     设置了该属性，但 System.Globalization.DateTimeFormatInfo 对象为只读。
        public string ShortDatePattern { get; set; }
        //
        // 摘要:
        //     获取或设置短时间值的自定义格式字符串。
        //
        // 返回结果:
        //     短时间值的自定义格式字符串。
        //
        // 异常:
        //   T:System.ArgumentNullException:
        //     该属性设置为 null。
        //
        //   T:System.InvalidOperationException:
        //     设置了该属性，但 System.Globalization.DateTimeFormatInfo 对象为只读。
        public string ShortTimePattern { get; set; }
        //
        // 摘要:
        //     获取可排序数据和时间值的自定义格式字符串。
        //
        // 返回结果:
        //     可排序的日期和时间值的自定义格式字符串。
        public string SortableDateTimePattern { get; }
        //
        // 摘要:
        //     获取或设置分隔时间中各组成部分（即小时、分钟和秒钟）的字符串。
        //
        // 返回结果:
        //     分隔时间中各组成部分的字符串。 默认值为 System.Globalization.DateTimeFormatInfo.InvariantInfo 是":"。
        //
        // 异常:
        //   T:System.ArgumentNullException:
        //     该属性设置为 null。
        //
        //   T:System.InvalidOperationException:
        //     此属性设置与 System.Globalization.DateTimeFormatInfo 对象是只读的。
        public string TimeSeparator { get; set; }
        //
        // 摘要:
        //     获取通用的可排序数据和时间字符串的自定义格式字符串。
        //
        // 返回结果:
        //     通用的可排序的日期和时间字符串的自定义格式字符串。
        public string UniversalSortableDateTimePattern { get; }
        //
        // 摘要:
        //     获取或设置年份和月份值的自定义格式字符串。
        //
        // 返回结果:
        //     年份和月份值的自定义格式字符串。
        //
        // 异常:
        //   T:System.ArgumentNullException:
        //     该属性设置为 null。
        //
        //   T:System.InvalidOperationException:
        //     设置了该属性，但 System.Globalization.DateTimeFormatInfo 对象为只读。
        public string YearMonthPattern { get; set; }
        //
        // 摘要:
        //     获取或设置类型的一维数组 System.String 包含区域性特定的日期是星期几的缩写的名称。
        //
        // 返回结果:
        //     类型的一维数组 System.String 包含区域性特定的日期是星期几的缩写的名称。 对于数组 System.Globalization.DateTimeFormatInfo.InvariantInfo
        //     包含"Sun"、"Mon"、"Tue"、"Wed"、"Thu"、"Fri"和"Sat"。
        //
        // 异常:
        //   T:System.ArgumentNullException:
        //     该属性设置为 null。
        //
        //   T:System.ArgumentException:
        //     属性被设置为数组是多维的或已有的长度不是正好为 7。
        //
        //   T:System.InvalidOperationException:
        //     此属性设置与 System.Globalization.DateTimeFormatInfo 对象是只读的。
        public string[] AbbreviatedDayNames { get; set; }
        //
        // 摘要:
        //     获取或设置与当前关联的最短唯一日期缩写的名称的字符串数组 System.Globalization.DateTimeFormatInfo 对象。
        //
        // 返回结果:
        //     日期名称的字符串数组。
        //
        // 异常:
        //   T:System.ArgumentException:
        //     在设置操作中，该数组并没有完全七个元素。
        //
        //   T:System.ArgumentNullException:
        //     在设置操作中，值数组或值数组的元素之一是 null。
        //
        //   T:System.InvalidOperationException:
        //     在设置操作中，当前 System.Globalization.DateTimeFormatInfo 对象是只读的。
        [ComVisible(false)]
        public string[] ShortestDayNames { get; set; }
        //
        // 摘要:
        //     获取或设置一维字符串数组，它包含该周中各天的特定于区域性的完整名称。
        //
        // 返回结果:
        //     一个一维字符串数组，它包含周中各天的特定于区域性的完整名称。 对于数组 System.Globalization.DateTimeFormatInfo.InvariantInfo
        //     包含"星期日"、"Monday"、"星期二"、"星期三"、"Thursday"、"Friday"和"星期六"。
        //
        // 异常:
        //   T:System.ArgumentNullException:
        //     该属性设置为 null。
        //
        //   T:System.ArgumentException:
        //     属性被设置为数组是多维的或已有的长度不是正好为 7。
        //
        //   T:System.InvalidOperationException:
        //     此属性设置与 System.Globalization.DateTimeFormatInfo 对象是只读的。
        public string[] DayNames { get; set; }
        //
        // 摘要:
        //     获取或设置一维字符串数组，它包含各月的特定于区域性的缩写名称。
        //
        // 返回结果:
        //     一个具有 13 个元素的一维字符串数组，它包含各月的特定于区域性的缩写名称。 对于 12 个月的日历，数组的第 13 个元素是一个空字符串。 对于数组 System.Globalization.DateTimeFormatInfo.InvariantInfo
        //     包含"Jan"、"Feb"、"Mar"、"Apr"、"May"、"Jun"、"Jul"、"Aug"、"Sep"、"Oct"、"Nov"、"Dec"和""。
        //
        // 异常:
        //   T:System.ArgumentNullException:
        //     该属性设置为 null。
        //
        //   T:System.ArgumentException:
        //     该属性被设置为数组是多维的且长度不是正好为 13。
        //
        //   T:System.InvalidOperationException:
        //     此属性设置与 System.Globalization.DateTimeFormatInfo 对象是只读的。
        public string[] AbbreviatedMonthNames { get; set; }
        //
        // 摘要:
        //     获取或设置类型的一维数组 System.String 包含各月的特定于区域性的完整名称。
        //
        // 返回结果:
        //     类型的一维数组 System.String 包含各月的特定于区域性的完整名称。 在 12 个月的日历中，数组的第 13 个元素是一个空字符串。 对于数组
        //     System.Globalization.DateTimeFormatInfo.InvariantInfo 包含"January"、"February"、"March"、"April"、"May"、"June"、"July"、"August"、"September"、"October"、"November"、"December"和""。
        //
        // 异常:
        //   T:System.ArgumentNullException:
        //     该属性设置为 null。
        //
        //   T:System.ArgumentException:
        //     该属性被设置为数组是多维的且长度不是正好为 13。
        //
        //   T:System.InvalidOperationException:
        //     设置了该属性，但 System.Globalization.DateTimeFormatInfo 对象为只读。
        public string[] MonthNames { get; set; }
        //
        // 摘要:
        //     获取一个值，该值指示是否 System.Globalization.DateTimeFormatInfo 对象是只读的。
        //
        // 返回结果:
        //     true 如果 System.Globalization.DateTimeFormatInfo 对象是只读的; 否则为 false。
        public bool IsReadOnly { get; }
        //
        // 摘要:
        //     获取与当前关联的日历的本机名称 System.Globalization.DateTimeFormatInfo 对象。
        //
        // 返回结果:
        //     在与当前关联的区域性所使用的日历的本机名称 System.Globalization.DateTimeFormatInfo 对象，该名称是否可用或空字符串
        //     ("") 如果该本地日历名称不可用。
        [ComVisible(false)]
        public string NativeCalendarName { get; }
        //
        // 摘要:
        //     获取或设置长日期值的自定义格式字符串。
        //
        // 返回结果:
        //     长日期值的自定义格式字符串。
        //
        // 异常:
        //   T:System.ArgumentNullException:
        //     该属性设置为 null。
        //
        //   T:System.InvalidOperationException:
        //     设置了该属性，但 System.Globalization.DateTimeFormatInfo 对象为只读。
        public string LongDatePattern { get; set; }
        //
        // 摘要:
        //     为长日期和长时间值获取或设置自定义格式字符串。
        //
        // 返回结果:
        //     长日期和时间值的自定义格式字符串。
        //
        // 异常:
        //   T:System.ArgumentNullException:
        //     该属性设置为 null。
        //
        //   T:System.InvalidOperationException:
        //     设置了该属性，但 System.Globalization.DateTimeFormatInfo 对象为只读。
        public string FullDateTimePattern { get; set; }
        //
        // 摘要:
        //     获取或设置一周的第一天。
        //
        // 返回结果:
        //     表示一周的第一天的枚举值。 默认值为 System.Globalization.DateTimeFormatInfo.InvariantInfo 是 System.DayOfWeek.Sunday。
        //
        // 异常:
        //   T:System.ArgumentOutOfRangeException:
        //     属性被设置为一个值，不是有效 System.DayOfWeek 值。
        //
        //   T:System.InvalidOperationException:
        //     设置了该属性，但 System.Globalization.DateTimeFormatInfo 对象为只读。
        public DayOfWeek FirstDayOfWeek { get; set; }
        //
        // 摘要:
        //     获取或设置与当前相关联的缩写的月份名称的字符串数组 System.Globalization.DateTimeFormatInfo 对象。
        //
        // 返回结果:
        //     月份缩写名称的数组。
        //
        // 异常:
        //   T:System.ArgumentException:
        //     在设置操作中，数组是多维的或不是正好为 13 的长度。
        //
        //   T:System.ArgumentNullException:
        //     在设置操作中，该数组的元素之一是 null。
        //
        //   T:System.InvalidOperationException:
        //     在设置操作中，当前 System.Globalization.DateTimeFormatInfo 对象是只读的。
        [ComVisible(false)]
        public string[] AbbreviatedMonthGenitiveNames { get; set; }
        //
        // 摘要:
        //     获取或设置一个值，该值指定使用哪个规则确定该年的第一个日历周。
        //
        // 返回结果:
        //     确定该年的第一个日历周的值。 默认值为 System.Globalization.DateTimeFormatInfo.InvariantInfo 是 System.Globalization.CalendarWeekRule.FirstDay。
        //
        // 异常:
        //   T:System.ArgumentOutOfRangeException:
        //     属性被设置为一个值，不是有效 System.Globalization.CalendarWeekRule 值。
        //
        //   T:System.InvalidOperationException:
        //     在设置操作中，当前 System.Globalization.DateTimeFormatInfo 对象是只读的。
        public CalendarWeekRule CalendarWeekRule { get; set; }
        //
        // 摘要:
        //     获取或设置表示处于“上午”（中午前）的各小时的字符串指示符。
        //
        // 返回结果:
        //     表示属于上午的各小时的字符串指示符。 默认值为 System.Globalization.DateTimeFormatInfo.InvariantInfo
        //     "am"。
        //
        // 异常:
        //   T:System.ArgumentNullException:
        //     该属性设置为 null。
        //
        //   T:System.InvalidOperationException:
        //     此属性设置与 System.Globalization.DateTimeFormatInfo 对象是只读的。
        public string AMDesignator { get; set; }
        //
        // 摘要:
        //     获取或设置与当前关联的月份名称的字符串数组 System.Globalization.DateTimeFormatInfo 对象。
        //
        // 返回结果:
        //     月份名称的字符串数组。
        //
        // 异常:
        //   T:System.ArgumentException:
        //     在设置操作中，数组是多维的或不是正好为 13 的长度。
        //
        //   T:System.ArgumentNullException:
        //     在设置操作中，该数组或其元素之一是 null。
        //
        //   T:System.InvalidOperationException:
        //     在设置操作中，当前 System.Globalization.DateTimeFormatInfo 对象是只读的。
        [ComVisible(false)]
        public string[] MonthGenitiveNames { get; set; }
        //
        // 摘要:
        //     获取或设置分隔日期中各组成部分（即年、月、日）的字符串。
        //
        // 返回结果:
        //     分隔日期中各组成部分（即年、月、日）的字符串。 默认值为 System.Globalization.DateTimeFormatInfo.InvariantInfo
        //     是"/"。
        //
        // 异常:
        //   T:System.ArgumentNullException:
        //     该属性设置为 null。
        //
        //   T:System.InvalidOperationException:
        //     设置了该属性，但 System.Globalization.DateTimeFormatInfo 对象为只读。
        public string DateSeparator { get; set; }
        //
        // 摘要:
        //     获取或设置用于当前区域性的日历。
        //
        // 返回结果:
        //     用于当前区域性的日历。 默认值为 System.Globalization.DateTimeFormatInfo.InvariantInfo 是 System.Globalization.GregorianCalendar
        //     对象。
        //
        // 异常:
        //   T:System.ArgumentNullException:
        //     该属性设置为 null。
        //
        //   T:System.ArgumentOutOfRangeException:
        //     该属性设置为 System.Globalization.Calendar 不能用于当前区域性的对象。
        //
        //   T:System.InvalidOperationException:
        //     设置了该属性，但 System.Globalization.DateTimeFormatInfo 对象为只读。
        public Calendar Calendar { get; set; }

        //
        // 摘要:
        //     返回 System.Globalization.DateTimeFormatInfo 对象关联的 System.IFormatProvider。
        //
        // 参数:
        //   provider:
        //     System.IFormatProvider 获取 System.Globalization.DateTimeFormatInfo 对象。 - 或 - 要获取
        //     System.Globalization.DateTimeFormatInfo.CurrentInfo 的 null。
        //
        // 返回结果:
        //     一个 System.Globalization.DateTimeFormatInfo 与关联对象 System.IFormatProvider。
        public static DateTimeFormatInfo GetInstance(IFormatProvider provider);
        //
        // 摘要:
        //     返回只读的 System.Globalization.DateTimeFormatInfo 包装。
        //
        // 参数:
        //   dtfi:
        //     要包装的 System.Globalization.DateTimeFormatInfo 对象。
        //
        // 返回结果:
        //     一个只读的 System.Globalization.DateTimeFormatInfo 包装。
        //
        // 异常:
        //   T:System.ArgumentNullException:
        //     dtfi 为 null。
        public static DateTimeFormatInfo ReadOnly(DateTimeFormatInfo dtfi);
        //
        // 摘要:
        //     创建的浅表副本 System.Globalization.DateTimeFormatInfo。
        //
        // 返回结果:
        //     一个新 System.Globalization.DateTimeFormatInfo 对象复制从原始 System.Globalization.DateTimeFormatInfo。
        public object Clone();
        //
        // 摘要:
        //     返回一周根据与当前关联的区域性的指定日期的特定于区域性的缩写的名称 System.Globalization.DateTimeFormatInfo 对象。
        //
        // 参数:
        //   dayofweek:
        //     一个 System.DayOfWeek 值。
        //
        // 返回结果:
        //     由表示星期几的特定于区域性的缩写的名称 dayofweek。
        //
        // 异常:
        //   T:System.ArgumentOutOfRangeException:
        //     dayofweek 不是有效的 System.DayOfWeek 值。
        public string GetAbbreviatedDayName(DayOfWeek dayofweek);
        //
        // 摘要:
        //     返回包含指定纪元的缩写名称的字符串（如果缩写名称存在）。
        //
        // 参数:
        //   era:
        //     表示纪元的整数。
        //
        // 返回结果:
        //     包含指定纪元的缩写名称的字符串（如果缩写名称存在）。 - 或 - 包含纪元的完整名称的字符串（如果缩写名称不存在）。
        //
        // 异常:
        //   T:System.ArgumentOutOfRangeException:
        //     era 并不表示中指定的日历中的有效纪元 System.Globalization.DateTimeFormatInfo.Calendar 属性。
        public string GetAbbreviatedEraName(int era);
        //
        // 摘要:
        //     返回基于与当前关联的区域性的指定月份的特定于区域性的缩写的名称 System.Globalization.DateTimeFormatInfo 对象。
        //
        // 参数:
        //   month:
        //     一个介于 1 到 13 表示月份的名称来检索。
        //
        // 返回结果:
        //     通过表示的月份的特定于区域性的缩写的名称 month。
        //
        // 异常:
        //   T:System.ArgumentOutOfRangeException:
        //     month 是小于 1 或大于 13。
        public string GetAbbreviatedMonthName(int month);
        //
        // 摘要:
        //     返回可用于对日期和时间值进行格式设置的所有标准模式。
        //
        // 返回结果:
        //     一个数组，包含可以用于对日期和时间值进行格式设置的标准模式。
        public string[] GetAllDateTimePatterns();
        //
        // 摘要:
        //     返回可在其中使用指定标准格式字符串对日期和时间值进行格式设置的所有模式。
        //
        // 参数:
        //   format:
        //     标准格式字符串。
        //
        // 返回结果:
        //     一个数组，它包含可在其中使用指定格式字符串对日期和时间值进行格式设置的标准模式。
        //
        // 异常:
        //   T:System.ArgumentException:
        //     format 不是有效的标准格式字符串。
        public string[] GetAllDateTimePatterns(char format);
        //
        // 摘要:
        //     返回一周根据与当前关联的区域性的指定日期的特定于区域性的完整名称 System.Globalization.DateTimeFormatInfo 对象。
        //
        // 参数:
        //   dayofweek:
        //     一个 System.DayOfWeek 值。
        //
        // 返回结果:
        //     由表示星期几的特定于区域性的完整名称 dayofweek。
        //
        // 异常:
        //   T:System.ArgumentOutOfRangeException:
        //     dayofweek 不是有效的 System.DayOfWeek 值。
        public string GetDayName(DayOfWeek dayofweek);
        //
        // 摘要:
        //     返回表示指定纪元的整数。
        //
        // 参数:
        //   eraName:
        //     包含纪元名称的字符串。
        //
        // 返回结果:
        //     如果表示表示纪元的整数 eraName 有效; 否则为-1。
        //
        // 异常:
        //   T:System.ArgumentNullException:
        //     eraName 为 null。
        public int GetEra(string eraName);
        //
        // 摘要:
        //     返回包含指定纪元名称的字符串。
        //
        // 参数:
        //   era:
        //     表示纪元的整数。
        //
        // 返回结果:
        //     包含纪元名称的字符串。
        //
        // 异常:
        //   T:System.ArgumentOutOfRangeException:
        //     era 并不表示中指定的日历中的有效纪元 System.Globalization.DateTimeFormatInfo.Calendar 属性。
        public string GetEraName(int era);
        //
        // 摘要:
        //     返回指定类型的对象，它提供日期和时间格式化服务。
        //
        // 参数:
        //   formatType:
        //     所需格式化服务的类型。
        //
        // 返回结果:
        //     当前对象，如果 formatType 等同于当前的类型 System.Globalization.DateTimeFormatInfo; 否则为 null。
        public object GetFormat(Type formatType);
        //
        // 摘要:
        //     返回基于与当前关联的区域性的指定月份的特定于区域性的完整名称 System.Globalization.DateTimeFormatInfo 对象。
        //
        // 参数:
        //   month:
        //     一个介于 1 到 13 表示月份的名称来检索。
        //
        // 返回结果:
        //     通过表示的月份的特定于区域性的完整名称 month。
        //
        // 异常:
        //   T:System.ArgumentOutOfRangeException:
        //     month 是小于 1 或大于 13。
        public string GetMonthName(int month);
        //
        // 摘要:
        //     获取最短日期名缩写中指定日期的关联与当前的周 System.Globalization.DateTimeFormatInfo 对象。
        //
        // 参数:
        //   dayOfWeek:
        //     System.DayOfWeek 值之一。
        //
        // 返回结果:
        //     对应于在星期几的缩写的名称 dayOfWeek 参数。
        //
        // 异常:
        //   T:System.ArgumentOutOfRangeException:
        //     dayOfWeek 不是值中的 System.DayOfWeek 枚举。
        [ComVisible(false)]
        public string GetShortestDayName(DayOfWeek dayOfWeek);
        //
        // 摘要:
        //     设置对应于指定的标准格式字符串的自定义日期和时间格式字符串。
        //
        // 参数:
        //   patterns:
        //     自定义格式字符串的数组。
        //
        //   format:
        //     中指定的自定义格式字符串与关联的标准格式字符串 patterns 参数。
        //
        // 异常:
        //   T:System.ArgumentException:
        //     patterns 是 null 或长度为零的数组。 - 或 - format 不是有效的标准格式字符串或不能设置其模式的标准格式字符串。
        //
        //   T:System.ArgumentNullException:
        //     patterns 具有其值是一个数组元素 null。
        //
        //   T:System.InvalidOperationException:
        //     这 System.Globalization.DateTimeFormatInfo 对象是只读的。
        [ComVisible(false)]
        public void SetAllDateTimePatterns(string[] patterns, char format);
    }
}