Merge pull request #926 from ermshiperete/novell-bug-674098
[mono.git] / mcs / class / corlib / Documentation / en / System.Globalization / CultureTypes.xml
1 <?xml version="1.0" encoding="utf-8"?>
2 <Type Name="CultureTypes" FullName="System.Globalization.CultureTypes">
3   <TypeSignature Maintainer="auto" Language="C#" Value="public enum CultureTypes" />
4   <TypeSignature Language="ILAsm" Value=".class public auto ansi serializable sealed CultureTypes extends System.Enum" />
5   <AssemblyInfo>
6     <AssemblyName>mscorlib</AssemblyName>
7     <AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00]</AssemblyPublicKey>
8     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
9     <AssemblyVersion>2.0.0.0</AssemblyVersion>
10     <AssemblyVersion>4.0.0.0</AssemblyVersion>
11   </AssemblyInfo>
12   <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the &lt;link location="node:gtk-sharp/programming/threads"&gt;Gtk# Thread Programming&lt;/link&gt; for details.</ThreadSafetyStatement>
13   <Base>
14     <BaseTypeName>System.Enum</BaseTypeName>
15   </Base>
16   <Attributes>
17     <Attribute>
18       <AttributeName>System.Flags</AttributeName>
19     </Attribute>
20     <Attribute>
21       <AttributeName>System.Runtime.InteropServices.ComVisible(true)</AttributeName>
22     </Attribute>
23   </Attributes>
24   <Docs>
25     <remarks>
26       <attribution license="cc4" from="Microsoft" modified="false" />
27       <para>These culture type values are returned by the <see cref="P:System.Globalization.CultureInfo.CultureTypes" /> property, and also serve as a filter that limits the cultures returned by the <see cref="M:System.Globalization.CultureInfo.GetCultures(System.Globalization.CultureTypes)" /> method. For more information on cultures, see <see cref="T:System.Globalization.CultureInfo" />.</para>
28       <para>Generally, your application should enumerate all cultures, using the <see cref="F:System.Globalization.CultureTypes.AllCultures" /> value. This allows enumeration of custom cultures, as well as the other culture types.</para>
29       <para>Note that the <see cref="F:System.Globalization.CultureTypes.FrameworkCultures" /> and <see cref="F:System.Globalization.CultureTypes.WindowsOnlyCultures" /> members have been deprecated. </para>
30     </remarks>
31     <summary>
32       <attribution license="cc4" from="Microsoft" modified="false" />
33       <para>Defines the types of culture lists that can be retrieved using the <see cref="M:System.Globalization.CultureInfo.GetCultures(System.Globalization.CultureTypes)" /> method.</para>
34     </summary>
35   </Docs>
36   <Members>
37     <Member MemberName="AllCultures">
38       <MemberSignature Language="C#" Value="AllCultures" />
39       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Globalization.CultureTypes AllCultures = int32(7)" />
40       <MemberType>Field</MemberType>
41       <AssemblyInfo>
42         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
43         <AssemblyVersion>2.0.0.0</AssemblyVersion>
44         <AssemblyVersion>4.0.0.0</AssemblyVersion>
45       </AssemblyInfo>
46       <ReturnValue>
47         <ReturnType>System.Globalization.CultureTypes</ReturnType>
48       </ReturnValue>
49       <Parameters />
50       <Docs>
51         <remarks>To be added</remarks>
52         <summary>
53           <attribution license="cc4" from="Microsoft" modified="false" />
54           <para>All cultures that ship with the .NET Framework, including neutral and specific cultures, cultures installed in the Windows operating system, and custom cultures created by the user.</para>
55         </summary>
56       </Docs>
57     </Member>
58     <Member MemberName="FrameworkCultures">
59       <MemberSignature Language="C#" Value="FrameworkCultures" />
60       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Globalization.CultureTypes FrameworkCultures = int32(64)" />
61       <MemberType>Field</MemberType>
62       <AssemblyInfo>
63         <AssemblyVersion>2.0.0.0</AssemblyVersion>
64         <AssemblyVersion>4.0.0.0</AssemblyVersion>
65       </AssemblyInfo>
66       <Attributes>
67         <Attribute>
68           <AttributeName>System.Obsolete</AttributeName>
69         </Attribute>
70       </Attributes>
71       <ReturnValue>
72         <ReturnType>System.Globalization.CultureTypes</ReturnType>
73       </ReturnValue>
74       <Docs>
75         <since version=".NET 2.0" />
76         <summary>
77           <attribution license="cc4" from="Microsoft" modified="false" />
78           <para>This member is deprecated; using this value with <see cref="M:System.Globalization.CultureInfo.GetCultures(System.Globalization.CultureTypes)" />  returns neutral and specific cultures shipped with the previous .NET Framework.</para>
79         </summary>
80       </Docs>
81     </Member>
82     <Member MemberName="InstalledWin32Cultures">
83       <MemberSignature Language="C#" Value="InstalledWin32Cultures" />
84       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Globalization.CultureTypes InstalledWin32Cultures = int32(4)" />
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.CultureTypes</ReturnType>
93       </ReturnValue>
94       <Parameters />
95       <Docs>
96         <remarks>To be added</remarks>
97         <summary>
98           <attribution license="cc4" from="Microsoft" modified="false" />
99           <para>All cultures that are installed in the Windows operating system. Note that not all cultures supported by the .NET Framework are installed in the operating system.</para>
100         </summary>
101       </Docs>
102     </Member>
103     <Member MemberName="NeutralCultures">
104       <MemberSignature Language="C#" Value="NeutralCultures" />
105       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Globalization.CultureTypes NeutralCultures = int32(1)" />
106       <MemberType>Field</MemberType>
107       <AssemblyInfo>
108         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
109         <AssemblyVersion>2.0.0.0</AssemblyVersion>
110         <AssemblyVersion>4.0.0.0</AssemblyVersion>
111       </AssemblyInfo>
112       <ReturnValue>
113         <ReturnType>System.Globalization.CultureTypes</ReturnType>
114       </ReturnValue>
115       <Parameters />
116       <Docs>
117         <remarks>
118           <attribution license="cc4" from="Microsoft" modified="false" />
119           <para>Custom cultures can have any user-specified name, not just a two-letter code.</para>
120           <para>The invariant culture is included in the array of cultures returned by the <see cref="M:System.Globalization.CultureInfo.GetCultures(System.Globalization.CultureTypes)" /> method that specifies this value.</para>
121         </remarks>
122         <summary>
123           <attribution license="cc4" from="Microsoft" modified="false" />
124           <para>Cultures that are associated with a language but are not specific to a country/region. The names of .NET Framework cultures consist of the lowercase two-letter code derived from ISO 639-1. For example: "en" (English) is a neutral culture. </para>
125         </summary>
126       </Docs>
127     </Member>
128     <Member MemberName="ReplacementCultures">
129       <MemberSignature Language="C#" Value="ReplacementCultures" />
130       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Globalization.CultureTypes ReplacementCultures = int32(16)" />
131       <MemberType>Field</MemberType>
132       <AssemblyInfo>
133         <AssemblyVersion>2.0.0.0</AssemblyVersion>
134         <AssemblyVersion>4.0.0.0</AssemblyVersion>
135       </AssemblyInfo>
136       <ReturnValue>
137         <ReturnType>System.Globalization.CultureTypes</ReturnType>
138       </ReturnValue>
139       <Docs>
140         <since version=".NET 2.0" />
141         <summary>
142           <attribution license="cc4" from="Microsoft" modified="false" />
143           <para>Custom cultures created by the user that replace cultures shipped with the .NET Framework.</para>
144         </summary>
145       </Docs>
146     </Member>
147     <Member MemberName="SpecificCultures">
148       <MemberSignature Language="C#" Value="SpecificCultures" />
149       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Globalization.CultureTypes SpecificCultures = int32(2)" />
150       <MemberType>Field</MemberType>
151       <AssemblyInfo>
152         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
153         <AssemblyVersion>2.0.0.0</AssemblyVersion>
154         <AssemblyVersion>4.0.0.0</AssemblyVersion>
155       </AssemblyInfo>
156       <ReturnValue>
157         <ReturnType>System.Globalization.CultureTypes</ReturnType>
158       </ReturnValue>
159       <Parameters />
160       <Docs>
161         <remarks>
162           <attribution license="cc4" from="Microsoft" modified="false" />
163           <para>Custom cultures can have any user-specified name, not just a standard-compliant name.</para>
164         </remarks>
165         <summary>
166           <attribution license="cc4" from="Microsoft" modified="false" />
167           <para>Cultures that are specific to a country/region. The names of these cultures follow RFC 4646 (Windows Vista and later). The format is "&lt;languagecode2&gt;-&lt;country/regioncode2&gt;", where &lt;languagecode2&gt; is a lowercase two-letter code derived from ISO 639-1 and &lt;country/regioncode2&gt; is an uppercase two-letter code derived from ISO 3166. For example, "en-US" for English (United States) is a specific culture.</para>
168         </summary>
169       </Docs>
170     </Member>
171     <Member MemberName="UserCustomCulture">
172       <MemberSignature Language="C#" Value="UserCustomCulture" />
173       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Globalization.CultureTypes UserCustomCulture = int32(8)" />
174       <MemberType>Field</MemberType>
175       <AssemblyInfo>
176         <AssemblyVersion>2.0.0.0</AssemblyVersion>
177         <AssemblyVersion>4.0.0.0</AssemblyVersion>
178       </AssemblyInfo>
179       <ReturnValue>
180         <ReturnType>System.Globalization.CultureTypes</ReturnType>
181       </ReturnValue>
182       <Docs>
183         <since version=".NET 2.0" />
184         <summary>
185           <attribution license="cc4" from="Microsoft" modified="false" />
186           <para>Custom cultures created by the user.</para>
187         </summary>
188       </Docs>
189     </Member>
190     <Member MemberName="WindowsOnlyCultures">
191       <MemberSignature Language="C#" Value="WindowsOnlyCultures" />
192       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Globalization.CultureTypes WindowsOnlyCultures = int32(32)" />
193       <MemberType>Field</MemberType>
194       <AssemblyInfo>
195         <AssemblyVersion>2.0.0.0</AssemblyVersion>
196         <AssemblyVersion>4.0.0.0</AssemblyVersion>
197       </AssemblyInfo>
198       <Attributes>
199         <Attribute>
200           <AttributeName>System.Obsolete</AttributeName>
201         </Attribute>
202       </Attributes>
203       <ReturnValue>
204         <ReturnType>System.Globalization.CultureTypes</ReturnType>
205       </ReturnValue>
206       <Docs>
207         <since version=".NET 2.0" />
208         <summary>
209           <attribution license="cc4" from="Microsoft" modified="false" />
210           <para>This member is deprecated; the default behavior is set to return an empty list for backward compatibility reasons.</para>
211         </summary>
212       </Docs>
213     </Member>
214   </Members>
215 </Type>