System.Globalization.CultureInfo.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;
using System.Security;

namespace System.Globalization
{
    //
    // 摘要:
    //     提供有关特定区域性的信息 (称为区域设置对于非托管的代码开发)。 这些信息包括区域性的名称、书写系统、使用的日历、字符串的排序顺序以及对日期和数字的格式化设置。
    [ComVisible(true)]
    public class CultureInfo : ICloneable, IFormatProvider
    {
        //
        // 摘要:
        //     根据由名称指定的区域性初始化 System.Globalization.CultureInfo 类的新实例。
        //
        // 参数:
        //   name:
        //     预定义的 System.Globalization.CultureInfo 名称、现有 System.Globalization.CultureInfo
        //     的 System.Globalization.CultureInfo.Name 或仅 Windows 区域性名称。 name 不区分大小写。
        //
        // 异常:
        //   T:System.ArgumentNullException:
        //     name 为 null。
        //
        //   T:System.Globalization.CultureNotFoundException:
        //     name 不是有效的区域性名称。 有关详细信息，请参阅“对调用方的说明”部分。
        public CultureInfo(string name);
        //
        // 摘要:
        //     根据区域性标识符指定的区域性初始化 System.Globalization.CultureInfo 类的新实例。
        //
        // 参数:
        //   culture:
        //     预定义的 System.Globalization.CultureInfo 标识符、现有 System.Globalization.CultureInfo
        //     对象的 System.Globalization.CultureInfo.LCID 属性或仅 Windows 区域性标识符。
        //
        // 异常:
        //   T:System.ArgumentOutOfRangeException:
        //     culture 小于零。
        //
        //   T:System.Globalization.CultureNotFoundException:
        //     culture 不是有效的区域性标识符。 有关详细信息，请参阅“调用方备注”部分。
        public CultureInfo(int culture);
        //
        // 摘要:
        //     基于名称指定的区域性并基于布尔值（指定是否使用系统中用户选定的区域性设置）来初始化 System.Globalization.CultureInfo 类的新实例。
        //
        // 参数:
        //   name:
        //     预定义的 System.Globalization.CultureInfo 名称、现有 System.Globalization.CultureInfo
        //     的 System.Globalization.CultureInfo.Name 或仅 Windows 区域性名称。 name 不区分大小写。
        //
        //   useUserOverride:
        //     一个布尔值，它指示是使用用户选定的区域性设置 (true)，还是使用默认区域性设置 (false)。
        //
        // 异常:
        //   T:System.ArgumentNullException:
        //     name 为 null。
        //
        //   T:System.Globalization.CultureNotFoundException:
        //     name 不是有效的区域性名称。 有关详细信息，请参阅“调用方备注”部分。
        public CultureInfo(string name, bool useUserOverride);
        //
        // 摘要:
        //     基于区域性标识符指定的区域性并基于布尔值（指定是否使用系统中用户选定的区域性设置）来初始化 System.Globalization.CultureInfo
        //     类的新实例。
        //
        // 参数:
        //   culture:
        //     预定义的 System.Globalization.CultureInfo 标识符、现有 System.Globalization.CultureInfo
        //     对象的 System.Globalization.CultureInfo.LCID 属性或仅 Windows 区域性标识符。
        //
        //   useUserOverride:
        //     一个布尔值，它指示是使用用户选定的区域性设置 (true)，还是使用默认区域性设置 (false)。
        //
        // 异常:
        //   T:System.ArgumentOutOfRangeException:
        //     culture 小于零。
        //
        //   T:System.Globalization.CultureNotFoundException:
        //     culture 不是有效的区域性标识符。 有关详细信息，请参阅“调用方备注”部分。
        public CultureInfo(int culture, bool useUserOverride);

        //
        // 摘要:
        //     获取不依赖于区域性（固定）的 System.Globalization.CultureInfo 对象。
        //
        // 返回结果:
        //     不依赖于区域性（固定）的对象。
        public static CultureInfo InvariantCulture { get; }
        //
        // 摘要:
        //     获取或设置当前应用程序域中线程的默认区域性。
        //
        // 返回结果:
        //     如果当前系统区域性为应用程序域中的默认线程区域性，则为当前应用程序中线程的默认区域性或 null。
        public static CultureInfo DefaultThreadCurrentCulture { get; set; }
        //
        // 摘要:
        //     获取表示操作系统中安装的区域性的 System.Globalization.CultureInfo。
        //
        // 返回结果:
        //     表示操作系统中安装的区域性的 System.Globalization.CultureInfo。
        public static CultureInfo InstalledUICulture { get; }
        //
        // 摘要:
        //     获取或设置 System.Globalization.CultureInfo 对象，该对象表示资源管理器在运行时查找区域性特定资源时所用的当前用户接口区域性。
        //
        // 返回结果:
        //     资源管理器用于在运行时查找查找区域性特定资源的区域性。
        //
        // 异常:
        //   T:System.ArgumentNullException:
        //     属性设置为 null。
        //
        //   T:System.ArgumentException:
        //     该属性设置为不能用于定位资源文件的区域性名称。 资源文件名必须仅包含字母、数字、连字符或下划线。
        public static CultureInfo CurrentUICulture { get; set; }
        //
        // 摘要:
        //     获取表示当前线程使用的区域性的 System.Globalization.CultureInfo 对象。
        //
        // 返回结果:
        //     表示当前线程使用的区域性的对象。
        //
        // 异常:
        //   T:System.ArgumentNullException:
        //     属性设置为 null。
        public static CultureInfo CurrentCulture { get; set; }
        //
        // 摘要:
        //     获取或设置当前应用程序域中线程的默认 UI 区域性。
        //
        // 返回结果:
        //     如果当前系统 UI 区域性为当前应用程序域中的默认线程 UI 区域性，则当前应用程序域中线程的默认 UI 区域性或 null。
        //
        // 异常:
        //   T:System.ArgumentException:
        //     在集运算中，System.Globalization.CultureInfo.Name 属性值无效。
        public static CultureInfo DefaultThreadCurrentUICulture { get; set; }
        //
        // 摘要:
        //     获取格式为 languagecode2-country/regioncode2 的区域性名称。
        //
        // 返回结果:
        //     格式为 languagecode2-country/regioncode2 的区域性名称。 languagecode2 是派生自 ISO 639-1 的小写双字母代码。
        //     country/regioncode2 派生自 ISO 3166，一般包含两个大写字母，或一个 BCP-47 语言标记。
        public virtual string Name { get; }
        //
        // 摘要:
        //     获取该区域性可使用的日历的列表。
        //
        // 返回结果:
        //     类型为 System.Globalization.Calendar 的数组，表示当前 System.Globalization.CultureInfo 代表的区域性所使用的日历。
        public virtual Calendar[] OptionalCalendars { get; }
        //
        // 摘要:
        //     获取区域性使用的默认日历。
        //
        // 返回结果:
        //     表示区域性使用的默认日历的 System.Globalization.Calendar。
        public virtual Calendar Calendar { get; }
        //
        // 摘要:
        //     获取或设置 System.Globalization.DateTimeFormatInfo，它定义适合区域性的、显示日期和时间的格式。
        //
        // 返回结果:
        //     一个 System.Globalization.DateTimeFormatInfo，它定义适合区域性的、显示日期和时间的格式。
        //
        // 异常:
        //   T:System.ArgumentNullException:
        //     该属性设置为 null。
        //
        //   T:System.InvalidOperationException:
        //     设置了 System.Globalization.CultureInfo.DateTimeFormat 属性或任意 System.Globalization.DateTimeFormatInfo
        //     属性，但 System.Globalization.CultureInfo 为只读。
        public virtual DateTimeFormatInfo DateTimeFormat { get; set; }
        //
        // 摘要:
        //     获取或设置 System.Globalization.NumberFormatInfo，它定义适合区域性的、显示数字、货币和百分比的格式。
        //
        // 返回结果:
        //     一个 System.Globalization.NumberFormatInfo，它定义适合区域性的、显示数字、货币和百分比的格式。
        //
        // 异常:
        //   T:System.ArgumentNullException:
        //     该属性设置为 null。
        //
        //   T:System.InvalidOperationException:
        //     设置了 System.Globalization.CultureInfo.NumberFormat 属性或任意 System.Globalization.NumberFormatInfo
        //     属性，但 System.Globalization.CultureInfo 为只读。
        public virtual NumberFormatInfo NumberFormat { get; set; }
        //
        // 摘要:
        //     获取属于当前 System.Globalization.CultureInfo 对象的区域性类型。
        //
        // 返回结果:
        //     一个或多个 System.Globalization.CultureTypes 值的按位组合。 没有默认值。
        [ComVisible(false)]
        public CultureTypes CultureTypes { get; }
        //
        // 摘要:
        //     获取一个值，该值指示当前 System.Globalization.CultureInfo 是否表示非特定区域性。
        //
        // 返回结果:
        //     如果当前 System.Globalization.CultureInfo 表示非特定区域性，则为 true；否则为 false。
        public virtual bool IsNeutralCulture { get; }
        //
        // 摘要:
        //     获取定义与区域性关联的书写体系的 System.Globalization.TextInfo。
        //
        // 返回结果:
        //     定义与区域性关联的书写体系的 System.Globalization.TextInfo。
        public virtual TextInfo TextInfo { get; }
        //
        // 摘要:
        //     获取为区域性定义如何比较字符串的 System.Globalization.CompareInfo。
        //
        // 返回结果:
        //     为区域性定义如何比较字符串的 System.Globalization.CompareInfo。
        public virtual CompareInfo CompareInfo { get; }
        //
        // 摘要:
        //     获取 Windows API 中定义的由三个字母构成的语言代码。
        //
        // 返回结果:
        //     Windows API 中定义的由三个字母构成的语言代码。
        public virtual string ThreeLetterWindowsLanguageName { get; }
        //
        // 摘要:
        //     获取当前 System.Globalization.CultureInfo 的语言的由三个字母构成的 ISO 639-2 代码。
        //
        // 返回结果:
        //     当前 System.Globalization.CultureInfo 的语言的由三个字母构成的 ISO 639-2 代码。
        public virtual string ThreeLetterISOLanguageName { get; }
        //
        // 摘要:
        //     获取当前 System.Globalization.CultureInfo 的语言的由两个字母构成的 ISO 639-1 代码。
        //
        // 返回结果:
        //     当前 System.Globalization.CultureInfo 的语言的由两个字母构成的 ISO 639-1 代码。
        public virtual string TwoLetterISOLanguageName { get; }
        //
        // 摘要:
        //     获取格式为 languagefull [country/regionfull] 的英语区域性名称。
        //
        // 返回结果:
        //     格式为 languagefull [country/regionfull] 的英语区域性名称，其中 languagefull 是语言的全名，country/regionfull
        //     是国家/地区的全名。
        public virtual string EnglishName { get; }
        //
        // 摘要:
        //     获取为区域性设置的显示名称，它由语言、国家/地区以及可选脚本组成。
        //
        // 返回结果:
        //     区域性名称。 由语言的全名、国家/地区的全名以及可选脚本组成。 有关其格式的讨论，请参见对 System.Globalization.CultureInfo
        //     类的说明。
        public virtual string NativeName { get; }
        //
        // 摘要:
        //     获取完整的本地化区域性名称。
        //
        // 返回结果:
        //     格式为 languagefull [country/regionfull] 的完整本地化区域性名称，其中 languagefull 是语言的全名，country/regionfull
        //     是国家/地区的全名。
        public virtual string DisplayName { get; }
        //
        // 摘要:
        //     已否决。 获取某种语言的 RFC 4646 标准标识。
        //
        // 返回结果:
        //     一个表示某种语言的 RFC 4646 标准标识的字符串。
        [ComVisible(false)]
        public string IetfLanguageTag { get; }
        //
        // 摘要:
        //     获取一个值，该值指示当前 System.Globalization.CultureInfo 是否为只读。
        //
        // 返回结果:
        //     如果当前 true 为只读，则为 System.Globalization.CultureInfo；否则为 false。 默认值为 false。
        public bool IsReadOnly { get; }
        //
        // 摘要:
        //     获取当前 System.Globalization.CultureInfo 的区域性标识符。
        //
        // 返回结果:
        //     当前 System.Globalization.CultureInfo 的区域性标识符。
        public virtual int LCID { get; }
        //
        // 摘要:
        //     获取表示当前 System.Globalization.CultureInfo 的父区域性的 System.Globalization.CultureInfo。
        //
        // 返回结果:
        //     表示当前 System.Globalization.CultureInfo 的父区域性的 System.Globalization.CultureInfo。
        public virtual CultureInfo Parent { get; }
        //
        // 摘要:
        //     获取一个值，该值指示当前 System.Globalization.CultureInfo 对象是否使用用户选定的区域性设置。
        //
        // 返回结果:
        //     如果当前 System.Globalization.CultureInfo 使用用户选定的区域性设置，则为 true；否则为 false。
        public bool UseUserOverride { get; }
        //
        // 摘要:
        //     获取活动的输入区域设置标识符。
        //
        // 返回结果:
        //     一个指定输入区域设置标识符的 32 位的有符号数字。
        [ComVisible(false)]
        public virtual int KeyboardLayoutId { get; }

        //
        // 摘要:
        //     创建表示与指定名称关联的特定区域性的 System.Globalization.CultureInfo。
        //
        // 参数:
        //   name:
        //     预定义的 System.Globalization.CultureInfo 名称或现有 System.Globalization.CultureInfo
        //     的对象。 name 不区分大小写。
        //
        // 返回结果:
        //     一个表示以下内容的 System.Globalization.CultureInfo 对象： 固定的区域性，如果 name 是空字符串 ("")。 - 或
        //     - 与 name 关联的特定区域性，如果 name 是非特定区域性。 - 或 - 由 name 指定的区域性，如果 name 已经是特定区域性。
        //
        // 异常:
        //   T:System.Globalization.CultureNotFoundException:
        //     name 不是有效的区域性名称。 - 或 - name 指定的区域性不具有与其关联的特定区域性。
        //
        //   T:System.NullReferenceException:
        //     name 为 null。
        public static CultureInfo CreateSpecificCulture(string name);
        //
        // 摘要:
        //     检索某个区域性的缓存的只读实例。 参数指定了一个使用 System.Globalization.TextInfo 和 System.Globalization.CompareInfo
        //     对象进行初始化的区域性，而这些对象则是由另一个区域性指定的。
        //
        // 参数:
        //   name:
        //     区域性的名称。 name 不区分大小写。
        //
        //   altName:
        //     区域性的名称提供了 System.Globalization.TextInfo 和 System.Globalization.CompareInfo 对象，这些对象用于对
        //     name 进行初始化。 altName 不区分大小写。
        //
        // 返回结果:
        //     只读 System.Globalization.CultureInfo 对象。
        //
        // 异常:
        //   T:System.ArgumentNullException:
        //     name 或 altName 为 null。
        //
        //   T:System.Globalization.CultureNotFoundException:
        //     name 或 altName 指定不受支持的区域性。 有关详细信息，请参阅“调用方备注”部分。
        public static CultureInfo GetCultureInfo(string name, string altName);
        //
        // 摘要:
        //     使用特定的区域性名称检索某个区域性的缓存的只读实例。
        //
        // 参数:
        //   name:
        //     区域性的名称。 name 不区分大小写。
        //
        // 返回结果:
        //     只读 System.Globalization.CultureInfo 对象。
        //
        // 异常:
        //   T:System.ArgumentNullException:
        //     name 为 null。
        //
        //   T:System.Globalization.CultureNotFoundException:
        //     name 指定不支持的区域性。 有关详细信息，请参阅“调用方备注”部分。
        public static CultureInfo GetCultureInfo(string name);
        //
        // 摘要:
        //     使用特定的区域性标识符检索某个区域性的缓存的只读实例。
        //
        // 参数:
        //   culture:
        //     区域设置标识符 (LCID)。
        //
        // 返回结果:
        //     只读 System.Globalization.CultureInfo 对象。
        //
        // 异常:
        //   T:System.ArgumentOutOfRangeException:
        //     culture 小于零。
        //
        //   T:System.Globalization.CultureNotFoundException:
        //     culture 指定不支持的区域性。 有关详细信息，请参阅“调用方备注”部分。
        public static CultureInfo GetCultureInfo(int culture);
        //
        // 摘要:
        //     已否决。 检索只读的 System.Globalization.CultureInfo 对象，其语言特征由指定的 RFC 4646 语言标记标识。
        //
        // 参数:
        //   name:
        //     按 RFC 4646 标准指定的语言的名称。
        //
        // 返回结果:
        //     只读 System.Globalization.CultureInfo 对象。
        //
        // 异常:
        //   T:System.ArgumentNullException:
        //     name 为 null。
        //
        //   T:System.Globalization.CultureNotFoundException:
        //     name 与支持的区域性不对应。
        public static CultureInfo GetCultureInfoByIetfLanguageTag(string name);
        //
        // 摘要:
        //     获取由指定 System.Globalization.CultureTypes 参数筛选的支持的区域性列表。
        //
        // 参数:
        //   types:
        //     按位组合的枚举值，用于筛选要检索的区域性。
        //
        // 返回结果:
        //     一个数组，该数组包含由 types 参数指定的区域性。 区域性数组未排序。
        //
        // 异常:
        //   T:System.ArgumentOutOfRangeException:
        //     types 指定 System.Globalization.CultureTypes 值的无效组合。
        public static CultureInfo[] GetCultures(CultureTypes types);
        //
        // 摘要:
        //     返回指定的 System.Globalization.CultureInfo 对象周围的只读包装。
        //
        // 参数:
        //   ci:
        //     要包装的 System.Globalization.CultureInfo 对象。
        //
        // 返回结果:
        //     ci 周围的只读 System.Globalization.CultureInfo 包装。
        //
        // 异常:
        //   T:System.ArgumentNullException:
        //     ci 为 null。
        public static CultureInfo ReadOnly(CultureInfo ci);
        //
        // 摘要:
        //     刷新缓存的区域性相关信息。
        public void ClearCachedData();
        //
        // 摘要:
        //     创建当前 System.Globalization.CultureInfo 的副本。
        //
        // 返回结果:
        //     当前 System.Globalization.CultureInfo 的副本。
        public virtual object Clone();
        //
        // 摘要:
        //     确定指定的对象是否与当前 System.Globalization.CultureInfo 具有相同的区域性。
        //
        // 参数:
        //   value:
        //     将与当前 System.Globalization.CultureInfo 进行比较的对象。
        //
        // 返回结果:
        //     如果 value 与当前 System.Globalization.CultureInfo 具有相同的区域性，则为 true；否则为 false。
        public override bool Equals(object value);
        //
        // 摘要:
        //     如果默认的图形用户界面区域性不合适，则获取适合控制台应用程序的备用用户界面区域性。
        //
        // 返回结果:
        //     用于在控制台上读取和显示文本的备用区域性。
        [ComVisible(false)]
        [SecuritySafeCritical]
        public CultureInfo GetConsoleFallbackUICulture();
        //
        // 摘要:
        //     获取一个定义如何格式化指定类型的对象。
        //
        // 参数:
        //   formatType:
        //     要为其获取格式化对象的 System.Type。 此方法仅支持 System.Globalization.NumberFormatInfo 和 System.Globalization.DateTimeFormatInfo
        //     两种类型。
        //
        // 返回结果:
        //     System.Globalization.CultureInfo.NumberFormat 属性的值，如果 formatType 是 System.Globalization.NumberFormatInfo
        //     类的 System.Type 对象，则该属性为包含当前 System.Globalization.CultureInfo 的默认数字格式信息的 System.Globalization.NumberFormatInfo。
        //     - 或 - System.Globalization.CultureInfo.DateTimeFormat 属性的值，如果 formatType 是 System.Globalization.DateTimeFormatInfo
        //     类的 System.Type 对象，则该属性为包含当前 System.Globalization.CultureInfo 的默认日期和时间格式信息的 System.Globalization.DateTimeFormatInfo。
        //     - 或 - 如果 formatType 是其他任何对象，则为 null。
        public virtual object GetFormat(Type formatType);
        //
        // 摘要:
        //     用作当前 System.Globalization.CultureInfo 的哈希函数，适合用在哈希算法和数据结构（如哈希表）中。
        //
        // 返回结果:
        //     当前 System.Globalization.CultureInfo 的哈希代码。
        public override int GetHashCode();
        //
        // 摘要:
        //     返回一个字符串，该字符串包含当前 System.Globalization.CultureInfo 的名称，其格式为 languagecode2-country/regioncode2。
        //
        // 返回结果:
        //     包含当前 System.Globalization.CultureInfo 名称的字符串。
        public override string ToString();
    }
}