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

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="TaiwanLunisolarCalendar" FullName="System.Globalization.TaiwanLunisolarCalendar">
   3   <TypeSignature Language="C#" Value="public class TaiwanLunisolarCalendar : System.Globalization.EastAsianLunisolarCalendar" />
   4   <TypeSignature Language="ILAsm" Value=".class public auto ansi serializable TaiwanLunisolarCalendar extends System.Globalization.EastAsianLunisolarCalendar" />
   5   <AssemblyInfo>
   6     <AssemblyName>mscorlib</AssemblyName>
   7     <AssemblyVersions>
   8       <AssemblyVersion>2.0.0.0</AssemblyVersion>
   9     </AssemblyVersions>
  10     <AssemblyVersion>2.0.0.0</AssemblyVersion>
  11     <AssemblyVersion>4.0.0.0</AssemblyVersion>
  12   </AssemblyInfo>
  13   <Base>
  14     <BaseTypeName>System.Globalization.EastAsianLunisolarCalendar</BaseTypeName>
  15   </Base>
  16   <Interfaces />
  17   <Docs>
  18     <since version=".NET 2.0" />
  19     <remarks>
  20       <attribution license="cc4" from="Microsoft" modified="false" />
  21       <para>The Taiwan lunisolar calendar works exactly like the Gregorian calendar, except that the year and era are different. The <see cref="T:System.Globalization.TaiwanLunisolarCalendar" /> class calculates years using the Gregorian calendar, days and months using the <see cref="T:System.Globalization.EastAsianLunisolarCalendar" /> class, and recognizes only the current era.</para>
  22       <block subset="none" type="note">
  23         <para>For information about using the <see cref="T:System.Globalization.TaiwanLunisolarCalendar" /> class and the other calendar classes in the .NET Framework, see <format type="text/html"><a href="0c1534e5-979b-4c8a-a588-1c24301aefb3">Working with Calendars</a></format>.</para>
  24       </block>
  25       <para>The <see cref="T:System.Globalization.TaiwanLunisolarCalendar" /> class is derived from the <see cref="T:System.Globalization.EastAsianLunisolarCalendar" /> class, which represents the lunisolar calendar. The <see cref="T:System.Globalization.EastAsianLunisolarCalendar" /> class supports the sexagenary year cycle (which repeats every 60 years) in addition to solar years and lunar months. Each solar year in the calendar is associated with a Sexagenary Year, a Celestial Stem, and a Terrestrial Branch, and these calendars can have leap months after any month of the year.</para>
  26       <para>A leap month can occur after any month in a year. For example, the <see cref="M:System.Globalization.EastAsianLunisolarCalendar.GetMonth(System.DateTime)" /> method returns a number between 1 and 13 that indicates the month associated with a specified date. If there is a leap month between the eighth and ninth months of the year, the <see cref="M:System.Globalization.EastAsianLunisolarCalendar.GetMonth(System.DateTime)" /> method returns 8 for the eighth month, 9 for the leap eighth month, and 10 for the ninth month.</para>
  27       <para>Currently, the <see cref="T:System.Globalization.TaiwanLunisolarCalendar" /> is not used by any of the cultures supported by the <see cref="T:System.Globalization.CultureInfo" /> class. Therefore, this class can be used only to calculate dates in the Taiwan lunisolar calendar.</para>
  28       <para>Each <see cref="T:System.Globalization.CultureInfo" /> object supports a set of calendars. The <see cref="P:System.Globalization.CultureInfo.Calendar" /> property returns the default calendar for the culture, and the <see cref="P:System.Globalization.CultureInfo.OptionalCalendars" /> property returns an array containing all the calendars supported by the culture. To change the calendar used by a <see cref="T:System.Globalization.CultureInfo" />, the application should set the <see cref="P:System.Globalization.DateTimeFormatInfo.Calendar" /> property of <see cref="P:System.Globalization.CultureInfo.DateTimeFormat" /> to a new <see cref="T:System.Globalization.Calendar" />.</para>
  29     </remarks>
  30     <summary>
  31       <attribution license="cc4" from="Microsoft" modified="false" />
  32       <para>Represents the Taiwan lunisolar calendar. As for the Taiwan calendar, years are calculated using the Gregorian calendar, while days and months are calculated using the lunisolar calendar.</para>
  33     </summary>
  34   </Docs>
  35   <Members>
  36     <Member MemberName=".ctor">
  37       <MemberSignature Language="C#" Value="public TaiwanLunisolarCalendar ();" />
  38       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
  39       <MemberType>Constructor</MemberType>
  40       <AssemblyInfo>
  41         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  42         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  43       </AssemblyInfo>
  44       <Parameters />
  45       <Docs>
  46         <remarks>To be added.</remarks>
  47         <since version=".NET 2.0" />
  48         <summary>
  49           <attribution license="cc4" from="Microsoft" modified="false" />
  50           <para>Initializes a new instance of the <see cref="T:System.Globalization.TaiwanLunisolarCalendar" /> class. </para>
  51         </summary>
  52       </Docs>
  53     </Member>
  54     <Member MemberName="DaysInYearBeforeMinSupportedYear">
  55       <MemberSignature Language="C#" Value="protected override int DaysInYearBeforeMinSupportedYear { get; }" />
  56       <MemberSignature Language="ILAsm" Value=".property instance int32 DaysInYearBeforeMinSupportedYear" />
  57       <MemberType>Property</MemberType>
  58       <AssemblyInfo>
  59         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  60       </AssemblyInfo>
  61       <ReturnValue>
  62         <ReturnType>System.Int32</ReturnType>
  63       </ReturnValue>
  64       <Docs>
  65         <value>To be added.</value>
  66         <remarks>
  67           <attribution license="cc4" from="Microsoft" modified="false" />
  68           <para>This property returns a constant value of 384.</para>
  69         </remarks>
  70         <summary>
  71           <attribution license="cc4" from="Microsoft" modified="false" />
  72           <para>Gets the number of days in the year that precedes the year specified by the <see cref="P:System.Globalization.TaiwanLunisolarCalendar.MinSupportedDateTime" /> property.</para>
  73         </summary>
  74       </Docs>
  75     </Member>
  76     <Member MemberName="Eras">
  77       <MemberSignature Language="C#" Value="public override int[] Eras { get; }" />
  78       <MemberSignature Language="ILAsm" Value=".property instance int32[] Eras" />
  79       <MemberType>Property</MemberType>
  80       <AssemblyInfo>
  81         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  82         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  83       </AssemblyInfo>
  84       <ReturnValue>
  85         <ReturnType>System.Int32[]</ReturnType>
  86       </ReturnValue>
  87       <Docs>
  88         <value>To be added.</value>
  89         <since version=".NET 2.0" />
  90         <remarks>
  91           <attribution license="cc4" from="Microsoft" modified="false" />
  92           <para>The values in the array returned by this property are numbers that range from 1 to the largest era number. The largest era number is returned in the first array element and the smallest era number is returned in the last element.</para>
  93         </remarks>
  94         <summary>
  95           <attribution license="cc4" from="Microsoft" modified="false" />
  96           <para>Gets the eras that are relevant to the current <see cref="T:System.Globalization.TaiwanLunisolarCalendar" /> object.</para>
  97         </summary>
  98       </Docs>
  99     </Member>
 100     <Member MemberName="GetEra">
 101       <MemberSignature Language="C#" Value="public override int GetEra (DateTime time);" />
 102       <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetEra(valuetype System.DateTime time) cil managed" />
 103       <MemberType>Method</MemberType>
 104       <AssemblyInfo>
 105         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 106         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 107       </AssemblyInfo>
 108       <ReturnValue>
 109         <ReturnType>System.Int32</ReturnType>
 110       </ReturnValue>
 111       <Parameters>
 112         <Parameter Name="time" Type="System.DateTime" />
 113       </Parameters>
 114       <Docs>
 115         <returns>To be added.</returns>
 116         <remarks>To be added.</remarks>
 117         <since version=".NET 2.0" />
 118         <summary>
 119           <attribution license="cc4" from="Microsoft" modified="false" />
 120           <para>Retrieves the era that corresponds to the specified <see cref="T:System.DateTime" />.</para>
 121         </summary>
 122         <param name="time">
 123           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.DateTime" /> to read. </param>
 124       </Docs>
 125     </Member>
 126     <Member MemberName="MaxSupportedDateTime">
 127       <MemberSignature Language="C#" Value="public override DateTime MaxSupportedDateTime { get; }" />
 128       <MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTime MaxSupportedDateTime" />
 129       <MemberType>Property</MemberType>
 130       <AssemblyInfo>
 131         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 132         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 133       </AssemblyInfo>
 134       <ReturnValue>
 135         <ReturnType>System.DateTime</ReturnType>
 136       </ReturnValue>
 137       <Docs>
 138         <value>To be added.</value>
 139         <remarks>To be added.</remarks>
 140         <since version=".NET 2.0" />
 141         <summary>
 142           <attribution license="cc4" from="Microsoft" modified="false" />
 143           <para>Gets the maximum date and time supported by the <see cref="T:System.Globalization.TaiwanLunisolarCalendar" /> class.</para>
 144         </summary>
 145       </Docs>
 146     </Member>
 147     <Member MemberName="MinSupportedDateTime">
 148       <MemberSignature Language="C#" Value="public override DateTime MinSupportedDateTime { get; }" />
 149       <MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTime MinSupportedDateTime" />
 150       <MemberType>Property</MemberType>
 151       <AssemblyInfo>
 152         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 153         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 154       </AssemblyInfo>
 155       <ReturnValue>
 156         <ReturnType>System.DateTime</ReturnType>
 157       </ReturnValue>
 158       <Docs>
 159         <value>To be added.</value>
 160         <remarks>To be added.</remarks>
 161         <since version=".NET 2.0" />
 162         <summary>
 163           <attribution license="cc4" from="Microsoft" modified="false" />
 164           <para>Gets the minimum date and time supported by the <see cref="T:System.Globalization.TaiwanLunisolarCalendar" /> class.</para>
 165         </summary>
 166       </Docs>
 167     </Member>
 168   </Members>
 169 </Type>