1072 lines
54 KiB
XML
1072 lines
54 KiB
XML
|
<?xml version="1.0"?>
|
||
|
|
<doc>
|
||
|
|
<assembly>
|
||
|
|
<name>FarsiLibrary</name>
|
||
|
|
</assembly>
|
||
|
|
<members>
|
||
|
|
<member name="M:FarsiLibrary.Internals.ReflectionHelper.GetField(System.Type,System.String)">
|
||
|
|
<summary>
|
||
|
|
Find and returns a FieldInfo by its name, on
|
||
|
|
the specified type.
|
||
|
|
</summary>
|
||
|
|
<param name="type"></param>
|
||
|
|
<param name="fieldName"></param>
|
||
|
|
<returns></returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.Internals.ReflectionHelper.SetField(System.Object,System.String,System.Object)">
|
||
|
|
<summary>
|
||
|
|
Sets a value to a field of the owner object
|
||
|
|
</summary>
|
||
|
|
<param name="owner"></param>
|
||
|
|
<param name="fieldName"></param>
|
||
|
|
<param name="value"></param>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.Internals.ReflectionHelper.GetField``1(System.Object,System.String)">
|
||
|
|
<summary>
|
||
|
|
Find and returns a FieldInfo by its name, on
|
||
|
|
the specified type.
|
||
|
|
</summary>
|
||
|
|
<param name="fieldName"></param>
|
||
|
|
<returns></returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.Internals.ReflectionHelper.GetField(System.Object,System.String)">
|
||
|
|
<summary>
|
||
|
|
returns value of a field in the owner object.
|
||
|
|
</summary>
|
||
|
|
<param name="owner"></param>
|
||
|
|
<param name="fieldName"></param>
|
||
|
|
<returns></returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.Internals.ReflectionHelper.GetProperty(System.Type,System.Object,System.String)">
|
||
|
|
<summary>
|
||
|
|
Returns ProprtyInfo of a
|
||
|
|
</summary>
|
||
|
|
<param name="type"></param>
|
||
|
|
<param name="owner"></param>
|
||
|
|
<param name="propName"></param>
|
||
|
|
<returns></returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.Internals.ReflectionHelper.GetProperty(System.Object,System.String)">
|
||
|
|
<summary>
|
||
|
|
Returns value of a property in the owner object.
|
||
|
|
</summary>
|
||
|
|
<param name="owner"></param>
|
||
|
|
<param name="propName"></param>
|
||
|
|
<returns></returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.Internals.ReflectionHelper.GetProperty``1(System.Object,System.String)">
|
||
|
|
<summary>
|
||
|
|
Returns value of a property in the owner object.
|
||
|
|
</summary>
|
||
|
|
<typeparam name="TResult"></typeparam>
|
||
|
|
<param name="owner"></param>
|
||
|
|
<param name="propName"></param>
|
||
|
|
<returns></returns>
|
||
|
|
</member>
|
||
|
|
<member name="P:FarsiLibrary.Formatter.ITimeUnit.MillisPerUnit">
|
||
|
|
<summary>
|
||
|
|
The number of milliseconds represented by each
|
||
|
|
instance of this TimeUnit.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="P:FarsiLibrary.Formatter.ITimeUnit.MaxQuantity">
|
||
|
|
<summary>
|
||
|
|
The maximum quantity of this Unit to be used as a threshold for the next
|
||
|
|
largest Unit (e.g. if one <code>Second</code> represents 1000ms, and
|
||
|
|
<code>Second</code> has a maxQuantity of 5, then if the difference
|
||
|
|
between compared timestamps is larger than 5000ms, PrettyTime will move
|
||
|
|
on to the next smallest TimeUnit for calculation; <code>Minute</code>, by
|
||
|
|
default)
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="P:FarsiLibrary.Formatter.ITimeUnit.Name">
|
||
|
|
<summary>
|
||
|
|
The grammatically singular name for this unit of time. (e.g. one "second")
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="P:FarsiLibrary.Formatter.ITimeUnit.PluralName">
|
||
|
|
<summary>
|
||
|
|
The grammatically plural name for this unit of time. (e.g. many "seconds")
|
||
|
|
</summary>
|
||
|
|
<returns></returns>
|
||
|
|
</member>
|
||
|
|
<member name="T:FarsiLibrary.Resources.FALocalizer">
|
||
|
|
<summary>
|
||
|
|
Farsi Localizer
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="T:FarsiLibrary.toEnglish">
|
||
|
|
<summary>
|
||
|
|
Helper class to convert numbers to it's farsi equivalent. Use this class' methods to overcome a problem in displaying farsi numeric values.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.toEnglish.Convert(System.String)">
|
||
|
|
<summary>
|
||
|
|
Converts a Farsi number to it's English numeric values.
|
||
|
|
</summary>
|
||
|
|
<remarks>This method only converts the numbers in a string, and does not convert any non-numeric characters.</remarks>
|
||
|
|
<param name="num"></param>
|
||
|
|
<returns></returns>
|
||
|
|
</member>
|
||
|
|
<member name="T:FarsiLibrary.PersianDateConverter">
|
||
|
|
<summary>Class to convert PersianDate into normal DateTime value and vice versa.
|
||
|
|
<seealso cref="T:FarsiLibrary.PersianDate"/>
|
||
|
|
</summary>
|
||
|
|
<remarks>
|
||
|
|
You can use <c>FarsiLibrary.Utils.FarsiDate.Now</c> property to access current Date.
|
||
|
|
</remarks>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianDateConverter.JLeap(System.Int32)">
|
||
|
|
<summary>
|
||
|
|
Checks if a specified Persian year is a leap one.
|
||
|
|
</summary>
|
||
|
|
<param name="jyear"></param>
|
||
|
|
<returns>returns 1 if the year is leap, otherwise returns 0.</returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianDateConverter.IsJLeapYear(System.Int32)">
|
||
|
|
<summary>
|
||
|
|
Checks if a year is a leap one.
|
||
|
|
</summary>
|
||
|
|
<param name="jyear">Year to check</param>
|
||
|
|
<returns>true if the year is leap</returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianDateConverter.GLeap(System.Int32)">
|
||
|
|
<summary>
|
||
|
|
Checks if a specified Gregorian year is a leap one.
|
||
|
|
</summary>
|
||
|
|
<param name="gyear"></param>
|
||
|
|
<returns>returns 1 if the year is leap, otherwise returns 0.</returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianDateConverter.ToPersianDate(System.String)">
|
||
|
|
<summary>Converts a Gregorian Date of type <c>System.DateTime</c> class to Persian Date.</summary>
|
||
|
|
<param name="date">DateTime to evaluate</param>
|
||
|
|
<returns>string representation of Jalali Date</returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianDateConverter.ToPersianDate(System.String,System.TimeSpan)">
|
||
|
|
<summary>
|
||
|
|
Converts a Gregorian Date of type <c>String</c> and a <c>TimeSpan</c> into a Persian Date.
|
||
|
|
</summary>
|
||
|
|
<param name="date"></param>
|
||
|
|
<param name="time"></param>
|
||
|
|
<returns></returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianDateConverter.ToPersianDate(System.DateTime)">
|
||
|
|
<summary>
|
||
|
|
Converts a Gregorian Date of type <c>String</c> class to Persian Date.
|
||
|
|
</summary>
|
||
|
|
<param name="dt">Date to evaluate</param>
|
||
|
|
<returns>string representation of Jalali Date.</returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianDateConverter.ToGregorianDateTime(System.String)">
|
||
|
|
<summary>
|
||
|
|
Converts a Persian Date of type <c>String</c> to Gregorian Date of type <c>DateTime</c> class.
|
||
|
|
</summary>
|
||
|
|
<param name="date">Date to evaluate</param>
|
||
|
|
<returns>Gregorian DateTime representation of evaluated Jalali Date.</returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianDateConverter.ToGregorianDate(FarsiLibrary.PersianDate)">
|
||
|
|
<summary>
|
||
|
|
Converts a Persian Date of type <c>String</c> to Gregorian Date of type <c>String</c>.
|
||
|
|
</summary>
|
||
|
|
<param name="date"></param>
|
||
|
|
<returns>Gregorian DateTime representation in string format of evaluated Jalali Date.</returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianDateConverter.DayOfWeek(System.DateTime)">
|
||
|
|
<summary>
|
||
|
|
Gets Persian Weekday name from specified Gregorian Date.
|
||
|
|
</summary>
|
||
|
|
<param name="date"></param>
|
||
|
|
<returns></returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianDateConverter.MonthDays(System.Int32)">
|
||
|
|
<summary>
|
||
|
|
Returns number of days in specified month number.
|
||
|
|
</summary>
|
||
|
|
<param name="MonthNo">Month no to evaluate in integer</param>
|
||
|
|
<returns>number of days in the evaluated month</returns>
|
||
|
|
</member>
|
||
|
|
<member name="T:FarsiLibrary.Internals.ThemeWrapper">
|
||
|
|
<summary>
|
||
|
|
A wrapper around Win32 Theming. Return which theme is
|
||
|
|
currently active.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.Formatter.ITimeFormat.Format(FarsiLibrary.Formatter.Duration)">
|
||
|
|
<summary>
|
||
|
|
Formats a duration
|
||
|
|
</summary>
|
||
|
|
<param name="duration"></param>
|
||
|
|
<returns></returns>
|
||
|
|
</member>
|
||
|
|
<member name="T:FarsiLibrary.toFarsi">
|
||
|
|
<summary>
|
||
|
|
Helper class to convert numbers to it's farsi equivalent. Use this class' methods to overcome a problem in displaying farsi numeric values.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.toFarsi.Convert(System.String,System.Globalization.CultureInfo)">
|
||
|
|
<summary>
|
||
|
|
Converts a number in string format e.g. 14500 to its localized version, if <c>Localized</c> value is set to <c>true</c>.
|
||
|
|
</summary>
|
||
|
|
<param name="num"></param>
|
||
|
|
<param name="culture"></param>
|
||
|
|
<returns></returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.toFarsi.Convert(System.String)">
|
||
|
|
<summary>
|
||
|
|
Converts an English number to it's Farsi value.
|
||
|
|
</summary>
|
||
|
|
<remarks>This method only converts the numbers in a string, and does not convert any non-numeric characters.</remarks>
|
||
|
|
<param name="num"></param>
|
||
|
|
<returns></returns>
|
||
|
|
</member>
|
||
|
|
<member name="T:FarsiLibrary.PersianCalendar">
|
||
|
|
<summary>
|
||
|
|
PersianCalendar calendar. Persian calendar, also named Jalaali calendar, was first based on Solar year by Omar Khayyam, the great Iranian poet, astrologer and scientist.
|
||
|
|
Jalaali calendar is approximately 365 days. Each of the first six months in the Jalaali calendar has 31 days, each of the next five months has 30 days, and the last month has 29 days in a common year and 30 days in a leap year. A leap year is a year that, when divided by 33, has a remainder of 1, 5, 9, 13, 17, 22, 26, or 30. For example, the year 1370 is a leap year because dividing it by 33 yields a remainder of 17. There are approximately 8 leap years in every 33 year cycle.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="F:FarsiLibrary.PersianCalendar.MaxMonthDifference">
|
||
|
|
<summary>
|
||
|
|
Maximum amount of month that can be added or
|
||
|
|
removed to / from a DateTime instance.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="F:FarsiLibrary.PersianCalendar.PersianEra">
|
||
|
|
<summary>
|
||
|
|
Represents the current era.
|
||
|
|
</summary>
|
||
|
|
<remarks>The Persian calendar recognizes only A.P (Anno Persarum) era.</remarks>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianCalendar.AddMonths(System.DateTime,System.Int32)">
|
||
|
|
<summary>
|
||
|
|
Returns a DateTime that is the specified number of months away from the specified DateTime.
|
||
|
|
</summary>
|
||
|
|
<param name="time">The DateTime instance to add.</param>
|
||
|
|
<param name="months">The number of months to add.</param>
|
||
|
|
<returns>The DateTime that results from adding the specified number of months to the specified DateTime.</returns>
|
||
|
|
<remarks>
|
||
|
|
The year part of the resulting DateTime is affected if the resulting month is beyond the last month of the current year. The day part of the resulting DateTime is also affected if the resulting day is not a valid day in the resulting month of the resulting year; it is changed to the last valid day in the resulting month of the resulting year. The time-of-day part of the resulting DateTime remains the same as the specified DateTime.
|
||
|
|
|
||
|
|
For example, if the specified month is Ordibehesht, which is the 2nd month and has 31 days, the specified day is the 31th day of that month, and the value of the months parameter is -3, the resulting year is one less than the specified year, the resulting month is Bahman, and the resulting day is the 30th day, which is the last day in Bahman.
|
||
|
|
|
||
|
|
If the value of the months parameter is negative, the resulting DateTime would be earlier than the specified DateTime.
|
||
|
|
</remarks>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianCalendar.AddYears(System.DateTime,System.Int32)">
|
||
|
|
<summary>
|
||
|
|
Returns a DateTime that is the specified number of years away from the specified DateTime.
|
||
|
|
</summary>
|
||
|
|
<param name="time">The DateTime instance to add.</param>
|
||
|
|
<param name="years">The number of years to add.</param>
|
||
|
|
<returns>The DateTime that results from adding the specified number of years to the specified DateTime.</returns>
|
||
|
|
<remarks>
|
||
|
|
The day part of the resulting DateTime is affected if the resulting day is not a valid day in the resulting month of the resulting year; it is changed to the last valid day in the resulting month of the resulting year. The time-of-day part of the resulting DateTime remains the same as the specified DateTime.
|
||
|
|
|
||
|
|
For example, Esfand has 29 days, except during leap years when it has 30 days. If the specified Date is the 30th day of Esfand in a leap year and the value of years is 1, the resulting Date will be the 29th day of Esfand in the following year.
|
||
|
|
|
||
|
|
If years is negative, the resulting DateTime would be earlier than the specified DateTime.
|
||
|
|
</remarks>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianCalendar.GetDayOfMonth(System.DateTime)">
|
||
|
|
<summary>
|
||
|
|
Gets the day of the month in the specified DateTime.
|
||
|
|
</summary>
|
||
|
|
<param name="time">The DateTime instance to read.</param>
|
||
|
|
<returns>An integer from 1 to 31 that represents the day of the month in time.</returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianCalendar.GetDayOfWeek(System.DateTime)">
|
||
|
|
<summary>
|
||
|
|
Gets the day of the week in the specified DateTime.
|
||
|
|
</summary>
|
||
|
|
<param name="time">The DateTime instance to read.</param>
|
||
|
|
<returns>A DayOfWeek value that represents the day of the week in time.</returns>
|
||
|
|
<remarks>The DayOfWeek values are Sunday which indicates YekShanbe', Monday which indicates DoShanbe', Tuesday which indicates SeShanbe', Wednesday which indicates ChaharShanbe', Thursday which indicates PanjShanbe', Friday which indicates Jom'e, and Saturday which indicates Shanbe'.</remarks>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianCalendar.GetDayOfYear(System.DateTime)">
|
||
|
|
<summary>
|
||
|
|
Gets the day of the year in the specified DateTime.
|
||
|
|
</summary>
|
||
|
|
<param name="time">The DateTime instance to read.</param>
|
||
|
|
<returns>An integer from 1 to 366 that represents the day of the year in time.</returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianCalendar.GetDaysInMonth(System.Int32,System.Int32,System.Int32)">
|
||
|
|
<summary>
|
||
|
|
Gets the number of days in the specified month.
|
||
|
|
</summary>
|
||
|
|
<param name="year">An integer that represents the year.</param>
|
||
|
|
<param name="month">An integer that represents the month.</param>
|
||
|
|
<param name="era">An integer that represents the era.</param>
|
||
|
|
<returns>The number of days in the specified month in the specified year in the specified era.</returns>
|
||
|
|
<remarks>For example, this method might return 29 or 30 for Esfand (month = 12), depending on whether year is a leap year.</remarks>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianCalendar.GetDaysInYear(System.Int32,System.Int32)">
|
||
|
|
<summary>
|
||
|
|
Gets the number of days in the year specified by the year and era parameters.
|
||
|
|
</summary>
|
||
|
|
<param name="year">An integer that represents the year.</param>
|
||
|
|
<param name="era">An integer that represents the era.</param>
|
||
|
|
<returns>The number of days in the specified year in the specified era.</returns>
|
||
|
|
<remarks>For example, this method might return 365 or 366, depending on whether year is a leap year.</remarks>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianCalendar.GetEra(System.DateTime)">
|
||
|
|
<summary>
|
||
|
|
Gets the era in the specified DateTime.
|
||
|
|
</summary>
|
||
|
|
<param name="time">The DateTime instance to read.</param>
|
||
|
|
<returns>An integer that represents the era in time.</returns>
|
||
|
|
<remarks>The Persian calendar recognizes one era: A.P. (Latin "Anno Persarum", which means "the year of/for Persians").</remarks>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianCalendar.GetMonth(System.DateTime)">
|
||
|
|
<summary>
|
||
|
|
Gets the month in the specified DateTime.
|
||
|
|
</summary>
|
||
|
|
<param name="time">The DateTime instance to read.</param>
|
||
|
|
<returns>An integer between 1 and 12 that represents the month in time.</returns>
|
||
|
|
<remarks>Month 1 indicates Farvardin, month 2 indicates Ordibehesht, month 3 indicates Khordad, month 4 indicates Tir, month 5 indicates Amordad, month 6 indicates Shahrivar, month 7 indicates Mehr, month 8 indicates Aban, month 9 indicates Azar, month 10 indicates Dey, month 11 indicates Bahman, and month 12 indicates Esfand.</remarks>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianCalendar.GetMonthsInYear(System.Int32,System.Int32)">
|
||
|
|
<summary>
|
||
|
|
Gets the number of months in the year specified by the year and era parameters.
|
||
|
|
</summary>
|
||
|
|
<param name="year">An integer that represents the year.</param>
|
||
|
|
<param name="era">An integer that represents the era.</param>
|
||
|
|
<returns>The number of months in the specified year in the specified era.</returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianCalendar.GetYear(System.DateTime)">
|
||
|
|
<summary>
|
||
|
|
Gets the year in the specified DateTime.
|
||
|
|
</summary>
|
||
|
|
<param name="time">The DateTime instance to read.</param>
|
||
|
|
<returns>An integer between 1 and 9378 that represents the year in time.</returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianCalendar.IsLeapDay(System.Int32,System.Int32,System.Int32,System.Int32)">
|
||
|
|
<summary>
|
||
|
|
Determines whether the Date specified by the year, month, day, and era parameters is a leap day.
|
||
|
|
</summary>
|
||
|
|
<param name="year">An integer that represents the year.</param>
|
||
|
|
<param name="month">An integer that represents the month.</param>
|
||
|
|
<param name="day">An integer that represents the day.</param>
|
||
|
|
<param name="era">An integer that represents the era.</param>
|
||
|
|
<returns>true if the specified day is a leap day; otherwise, false.</returns>
|
||
|
|
<remarks>
|
||
|
|
In the Persian calendar leap years are applied every 4 or 5 years according to a certain pattern that iterates in a 2820-year cycle. A common year has 365 days and a leap year has 366 days.
|
||
|
|
|
||
|
|
A leap day is a day that occurs only in a leap year. In the Persian calendar, the 30th day of Esfand (month 12) is the only leap day.
|
||
|
|
</remarks>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianCalendar.IsLeapMonth(System.Int32,System.Int32,System.Int32)">
|
||
|
|
<summary>
|
||
|
|
Determines whether the month specified by the year, month, and era parameters is a leap month.
|
||
|
|
</summary>
|
||
|
|
<param name="year">An integer that represents the year.</param>
|
||
|
|
<param name="month">An integer that represents the month.</param>
|
||
|
|
<param name="era">An integer that represents the era.</param>
|
||
|
|
<returns>This method always returns false, unless overridden by a derived class.</returns>
|
||
|
|
<remarks>
|
||
|
|
In the Persian calendar leap years are applied every 4 or 5 years according to a certain pattern that iterates in a 2820-year cycle. A common year has 365 days and a leap year has 366 days.
|
||
|
|
|
||
|
|
A leap month is an entire month that occurs only in a leap year. The Persian calendar does not have any leap months.
|
||
|
|
</remarks>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianCalendar.IsLeapMonth(System.Int32,System.Int32)">
|
||
|
|
<summary>
|
||
|
|
Determines whether the month specified by the year, month, and era parameters is a leap month.
|
||
|
|
</summary>
|
||
|
|
<param name="year">An integer that represents the year.</param>
|
||
|
|
<param name="month">An integer that represents the month.</param>
|
||
|
|
<returns>This method always returns false, unless overridden by a derived class.</returns>
|
||
|
|
<remarks>
|
||
|
|
In the Persian calendar leap years are applied every 4 or 5 years according to a certain pattern that iterates in a 2820-year cycle. A common year has 365 days and a leap year has 366 days.
|
||
|
|
|
||
|
|
A leap month is an entire month that occurs only in a leap year. The Persian calendar does not have any leap months.
|
||
|
|
</remarks>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianCalendar.IsLeapYear(System.Int32,System.Int32)">
|
||
|
|
<summary>
|
||
|
|
Determines whether the year specified by the year and era parameters is a leap year.
|
||
|
|
</summary>
|
||
|
|
<param name="year">An integer that represents the year.</param>
|
||
|
|
<param name="era">An integer that represents the era.</param>
|
||
|
|
<returns>true if the specified year is a leap year; otherwise, false.</returns>
|
||
|
|
<remarks>In the Persian calendar leap years are applied every 4 or 5 years according to a certain pattern that iterates in a 2820-year cycle. A common year has 365 days and a leap year has 366 days.</remarks>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianCalendar.ToDateTime(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
|
||
|
|
<summary>
|
||
|
|
Returns a DateTime that is set to the specified Date and time in the specified era.
|
||
|
|
</summary>
|
||
|
|
<param name="year">An integer that represents the year.</param>
|
||
|
|
<param name="month">An integer that represents the month.</param>
|
||
|
|
<param name="day">An integer that represents the day.</param>
|
||
|
|
<param name="hour">An integer that represents the hour.</param>
|
||
|
|
<param name="minute">An integer that represents the minute.</param>
|
||
|
|
<param name="second">An integer that represents the second.</param>
|
||
|
|
<param name="millisecond">An integer that represents the millisecond.</param>
|
||
|
|
<param name="era">An integer that represents the era.</param>
|
||
|
|
<returns>The DateTime instance set to the specified Date and time in the current era.</returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianCalendar.ToFourDigitYear(System.Int32)">
|
||
|
|
<summary>
|
||
|
|
Converts the specified two-digit year to a four-digit year by using the Globalization.PersianCalendar.TwoDigitYearMax property to determine the appropriate century.
|
||
|
|
</summary>
|
||
|
|
<param name="year">A two-digit integer that represents the year to convert.</param>
|
||
|
|
<returns>An integer that contains the four-digit representation of year.</returns>
|
||
|
|
<remarks>TwoDigitYearMax is the last year in the 100-year
|
||
|
|
range that can be represented by a two-digit year. The century is determined by finding the sole occurrence of the two-digit year within that 100-year range. For example, if TwoDigitYearMax is set to 1429, the 100-year range is from 1330 to 1429; therefore, a 2-digit value of 30 is interpreted as 1330, while a 2-digit value of 29 is interpreted as 1429.</remarks>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianCalendar.GetCentury(System.DateTime)">
|
||
|
|
<summary>
|
||
|
|
Gets the century of the specified DateTime.
|
||
|
|
</summary>
|
||
|
|
<param name="time">An instance of the DateTime class to read.</param>
|
||
|
|
<returns>An integer from 1 to 94 that represents the century.</returns>
|
||
|
|
<remarks>A century is a whole 100-year period. So the century 14 for example, represents years 1301 through 1400.</remarks>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianCalendar.NumberOfLeapYearsUntil(System.Int32)">
|
||
|
|
<summary>
|
||
|
|
Calculates the number of leap years until -but not including- the specified year.
|
||
|
|
</summary>
|
||
|
|
<param name="year">An integer between 1 and 9378</param>
|
||
|
|
<returns>An integer representing the number of leap years that have occured by the year specified.</returns>
|
||
|
|
<remarks>In the Persian calendar leap years are applied every 4 or 5 years according to a certain pattern that iterates in a 2820-year cycle. A common year has 365 days and a leap year has 366 days.</remarks>
|
||
|
|
</member>
|
||
|
|
<member name="P:FarsiLibrary.PersianCalendar.AlgorithmType">
|
||
|
|
<summary>
|
||
|
|
Algorithm Type
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="P:FarsiLibrary.PersianCalendar.MaxSupportedDateTime">
|
||
|
|
<summary>
|
||
|
|
Maximum supported date time by this calendar.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="P:FarsiLibrary.PersianCalendar.MinSupportedDateTime">
|
||
|
|
<summary>
|
||
|
|
Minimum supported date time by this calendar.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="P:FarsiLibrary.PersianCalendar.Eras">
|
||
|
|
<summary>
|
||
|
|
Gets the list of eras in the PersianCalendar.
|
||
|
|
</summary>
|
||
|
|
<remarks>The Persian calendar recognizes one era: A.P. (Latin "Anno Persarum", which means "the year of/for Persians").</remarks>
|
||
|
|
</member>
|
||
|
|
<member name="P:FarsiLibrary.PersianCalendar.TwoDigitYearMax">
|
||
|
|
<summary>
|
||
|
|
Gets and sets the last year of a 100-year range that can be represented by a 2-digit year.
|
||
|
|
</summary>
|
||
|
|
<property_value>The last year of a 100-year range that can be represented by a 2-digit year.</property_value>
|
||
|
|
<remarks>This property allows a 2-digit year to be properly translated to a 4-digit year. For example, if this property is set to 1429, the 100-year range is from 1330 to 1429; therefore, a 2-digit value of 30 is interpreted as 1330, while a 2-digit value of 29 is interpreted as 1429.</remarks>
|
||
|
|
</member>
|
||
|
|
<member name="T:FarsiLibrary.PersianDate">
|
||
|
|
<summary>
|
||
|
|
PersianDate class to work with dates in Jalali calendar transparently.
|
||
|
|
<example>An example on how to convert current System.DateTime to PersianDate.
|
||
|
|
<code>
|
||
|
|
class MyClass
|
||
|
|
{
|
||
|
|
public static void Main()
|
||
|
|
{
|
||
|
|
Console.WriteLine("Current Persian Date Is : " + PersianDate.Now.ToString());
|
||
|
|
}
|
||
|
|
}
|
||
|
|
</code>
|
||
|
|
You can alternatively create a specified date/time based on specific <c>DateTime</c> value. To do this
|
||
|
|
you need to use <value>PersianDateConverter</value> class.
|
||
|
|
</example>
|
||
|
|
<seealso cref="T:FarsiLibrary.PersianDateConverter"/>
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianDate.#cctor">
|
||
|
|
<summary>
|
||
|
|
Static constructor initializes Now property of PersianDate and Min/Max values.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianDate.#ctor(System.String,System.TimeSpan)">
|
||
|
|
<summary>
|
||
|
|
Constructs a PersianDate instance with values provided in datetime string. You should
|
||
|
|
include Date part only in <c>Date</c> and set the Time of the instance as a <c>TimeSpan</c>.
|
||
|
|
</summary>
|
||
|
|
<exception cref="T:FarsiLibrary.Exceptions.InvalidPersianDateException"></exception>
|
||
|
|
<param name="Date"></param>
|
||
|
|
<param name="time"></param>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianDate.#ctor(System.String)">
|
||
|
|
<summary>
|
||
|
|
Constructs a PersianDate instance with values provided as a string. The provided string should be in format 'yyyy/mm/dd'.
|
||
|
|
</summary>
|
||
|
|
<exception cref="T:FarsiLibrary.Exceptions.InvalidPersianDateException"></exception>
|
||
|
|
<param name="Date"></param>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianDate.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
|
||
|
|
<summary>
|
||
|
|
Constructs a PersianDate instance with values specified as <c>Integer</c> and default second and millisecond set to zero.
|
||
|
|
</summary>
|
||
|
|
<param name="year"></param>
|
||
|
|
<param name="month"></param>
|
||
|
|
<param name="day"></param>
|
||
|
|
<param name="hour"></param>
|
||
|
|
<param name="minute"></param>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianDate.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
|
||
|
|
<summary>
|
||
|
|
Constructs a PersianDate instance with values specified as <c>Integer</c> and default millisecond set to zero.
|
||
|
|
</summary>
|
||
|
|
<param name="year"></param>
|
||
|
|
<param name="month"></param>
|
||
|
|
<param name="day"></param>
|
||
|
|
<param name="hour"></param>
|
||
|
|
<param name="minute"></param>
|
||
|
|
<param name="second"></param>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianDate.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
|
||
|
|
<summary>
|
||
|
|
Constructs a PersianDate instance with values specified as <c>Integer</c>.
|
||
|
|
</summary>
|
||
|
|
<exception cref="T:FarsiLibrary.Exceptions.InvalidPersianDateException"></exception>
|
||
|
|
<param name="year"></param>
|
||
|
|
<param name="month"></param>
|
||
|
|
<param name="day"></param>
|
||
|
|
<param name="hour"></param>
|
||
|
|
<param name="minute"></param>
|
||
|
|
<param name="second"></param>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianDate.#ctor(System.Int32,System.Int32,System.Int32)">
|
||
|
|
<summary>
|
||
|
|
Constructs a PersianDate instance with values specified as <c>Integer</c>. Time value of this instance is set to <c>DateTime.Now</c>.
|
||
|
|
</summary>
|
||
|
|
<param name="year"></param>
|
||
|
|
<param name="month"></param>
|
||
|
|
<param name="day"></param>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianDate.Assign(FarsiLibrary.PersianDate)">
|
||
|
|
<summary>
|
||
|
|
Assigns an instance of PersianDate's values to this instance.
|
||
|
|
</summary>
|
||
|
|
<param name="pd"></param>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianDate.ToWritten">
|
||
|
|
<summary>
|
||
|
|
Returns a string representation of current PersianDate value.
|
||
|
|
</summary>
|
||
|
|
<returns></returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianDate.ToPrettyDate">
|
||
|
|
<summary>
|
||
|
|
Returns a pretty representation of this date instance
|
||
|
|
</summary>
|
||
|
|
<returns></returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianDate.TryParse(System.String,FarsiLibrary.PersianDate@)">
|
||
|
|
<summary>
|
||
|
|
Tries to parse a string value into a PersianDate instance.
|
||
|
|
Value can only be in 'yyyy/mm/dd' format.
|
||
|
|
</summary>
|
||
|
|
<param name="value"></param>
|
||
|
|
<param name="persianDate"></param>
|
||
|
|
<returns></returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianDate.Parse(System.String)">
|
||
|
|
<summary>
|
||
|
|
Parse a string value into a PersianDate instance.
|
||
|
|
</summary>
|
||
|
|
<param name="value"></param>
|
||
|
|
<returns></returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianDate.ToString">
|
||
|
|
<summary>
|
||
|
|
Returns Date in 'yyyy/mm/dd' string format.
|
||
|
|
</summary>
|
||
|
|
<returns>string representation of evaluated Date.</returns>
|
||
|
|
<example>An example on how to get the written form of a Date.
|
||
|
|
<code>
|
||
|
|
class MyClass {
|
||
|
|
public static void Main()
|
||
|
|
{
|
||
|
|
Console.WriteLine(PersianDate.Now.ToString());
|
||
|
|
}
|
||
|
|
}
|
||
|
|
</code>
|
||
|
|
</example>
|
||
|
|
<seealso cref="M:FarsiLibrary.PersianDate.ToWritten"/>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianDate.op_Equality(FarsiLibrary.PersianDate,FarsiLibrary.PersianDate)">
|
||
|
|
<summary>
|
||
|
|
Compares two instance of the PersianDate for the specified operator.
|
||
|
|
</summary>
|
||
|
|
<param name="date1"></param>
|
||
|
|
<param name="date2"></param>
|
||
|
|
<returns></returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianDate.op_Inequality(FarsiLibrary.PersianDate,FarsiLibrary.PersianDate)">
|
||
|
|
<summary>
|
||
|
|
Compares two instance of the PersianDate for the specified operator.
|
||
|
|
</summary>
|
||
|
|
<param name="date1"></param>
|
||
|
|
<param name="date2"></param>
|
||
|
|
<returns></returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianDate.op_GreaterThan(FarsiLibrary.PersianDate,FarsiLibrary.PersianDate)">
|
||
|
|
<summary>
|
||
|
|
Compares two instance of the PersianDate for the specified operator.
|
||
|
|
</summary>
|
||
|
|
<param name="date1"></param>
|
||
|
|
<param name="date2"></param>
|
||
|
|
<returns></returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianDate.op_LessThan(FarsiLibrary.PersianDate,FarsiLibrary.PersianDate)">
|
||
|
|
<summary>
|
||
|
|
Compares two instance of the PersianDate for the specified operator.
|
||
|
|
</summary>
|
||
|
|
<param name="date1"></param>
|
||
|
|
<param name="date2"></param>
|
||
|
|
<returns></returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianDate.op_LessThanOrEqual(FarsiLibrary.PersianDate,FarsiLibrary.PersianDate)">
|
||
|
|
<summary>
|
||
|
|
Compares two instance of the PersianDate for the specified operator.
|
||
|
|
</summary>
|
||
|
|
<param name="date1"></param>
|
||
|
|
<param name="date2"></param>
|
||
|
|
<returns></returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianDate.op_GreaterThanOrEqual(FarsiLibrary.PersianDate,FarsiLibrary.PersianDate)">
|
||
|
|
<summary>
|
||
|
|
Compares two instance of the PersianDate for the specified operator.
|
||
|
|
</summary>
|
||
|
|
<param name="date1"></param>
|
||
|
|
<param name="date2"></param>
|
||
|
|
<returns></returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianDate.GetHashCode">
|
||
|
|
<summary>
|
||
|
|
Serves as a hash function for a particular type. System.Object.GetHashCode() is suitable for use in hashing algorithms and data structures like a hash table.
|
||
|
|
</summary>
|
||
|
|
<returns></returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianDate.Equals(System.Object)">
|
||
|
|
<summary>
|
||
|
|
Determines whether the specified System.Object instances are considered equal.
|
||
|
|
</summary>
|
||
|
|
<param name="obj"></param>
|
||
|
|
<returns></returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianDate.op_Implicit(System.Nullable{System.DateTime})~FarsiLibrary.PersianDate">
|
||
|
|
<summary>
|
||
|
|
Converts a nullable DateTime to PersianDate.
|
||
|
|
</summary>
|
||
|
|
<param name="dt"></param>
|
||
|
|
<returns></returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianDate.System#IComparable#CompareTo(System.Object)">
|
||
|
|
<summary>
|
||
|
|
Compares the current instance with another object of the same type.
|
||
|
|
</summary>
|
||
|
|
|
||
|
|
<returns>
|
||
|
|
A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than zero This instance is less than obj. Zero This instance is equal to obj. Greater than zero This instance is greater than obj.
|
||
|
|
</returns>
|
||
|
|
|
||
|
|
<param name="obj">An object to compare with this instance. </param>
|
||
|
|
<exception cref="T:System.ArgumentException">obj is not the same type as this instance. </exception><filterpriority>2</filterpriority>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianDate.System#Collections#IComparer#Compare(System.Object,System.Object)">
|
||
|
|
<summary>
|
||
|
|
Compares two objects and returns a value indicating whether one is less than, equal to, or greater than the other.
|
||
|
|
</summary>
|
||
|
|
|
||
|
|
<returns>
|
||
|
|
Value Condition Less than zero x is less than y. Zero x equals y. Greater than zero x is greater than y.
|
||
|
|
</returns>
|
||
|
|
|
||
|
|
<param name="y">The second object to compare. </param>
|
||
|
|
<param name="x">The first object to compare. </param>
|
||
|
|
<exception cref="T:System.ArgumentException">Neither x nor y implements the <see cref="T:System.IComparable"></see> interface.-or- x and y are of different types and neither one can handle comparisons with the other. </exception><filterpriority>2</filterpriority>
|
||
|
|
<exception cref="T:System.ApplicationException">Either x or y is a null reference</exception>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianDate.CompareTo(FarsiLibrary.PersianDate)">
|
||
|
|
<summary>
|
||
|
|
Compares the current object with another object of the same type.
|
||
|
|
</summary>
|
||
|
|
|
||
|
|
<returns>
|
||
|
|
A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has the following meanings: Value Meaning Less than zero This object is less than the other parameter.Zero This object is equal to other. Greater than zero This object is greater than other.
|
||
|
|
</returns>
|
||
|
|
|
||
|
|
<param name="other">An object to compare with this object.</param>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianDate.Compare(FarsiLibrary.PersianDate,FarsiLibrary.PersianDate)">
|
||
|
|
<summary>
|
||
|
|
Compares two objects and returns a value indicating whether one is less than, equal to, or greater than the other.
|
||
|
|
</summary>
|
||
|
|
|
||
|
|
<returns>
|
||
|
|
Value Condition Less than zerox is less than y.Zerox equals y.Greater than zero x is greater than y.
|
||
|
|
</returns>
|
||
|
|
|
||
|
|
<param name="y">The second object to compare.</param>
|
||
|
|
<param name="x">The first object to compare.</param>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianDate.Equals(FarsiLibrary.PersianDate)">
|
||
|
|
<summary>
|
||
|
|
Indicates whether the current object is equal to another object of the same type.
|
||
|
|
</summary>
|
||
|
|
|
||
|
|
<returns>
|
||
|
|
true if the current object is equal to the other parameter; otherwise, false.
|
||
|
|
</returns>
|
||
|
|
|
||
|
|
<param name="other">An object to compare with this object.</param>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianDate.ToString(System.String)">
|
||
|
|
<summary>
|
||
|
|
Returns string representation of this instance in default format.
|
||
|
|
</summary>
|
||
|
|
<param name="format"></param>
|
||
|
|
<returns></returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianDate.ToString(System.IFormatProvider)">
|
||
|
|
<summary>
|
||
|
|
Returns string representation of this instance and format it using the <see cref="T:System.IFormatProvider"/> instance.
|
||
|
|
</summary>
|
||
|
|
<param name="formatProvider"></param>
|
||
|
|
<returns></returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianDate.ToString(System.String,System.IFormatProvider)">
|
||
|
|
<summary>
|
||
|
|
Returns string representation of this instance in desired format, or using provided <see cref="T:System.IFormatProvider"/> instance.
|
||
|
|
</summary>
|
||
|
|
<param name="format"></param>
|
||
|
|
<param name="formatProvider"></param>
|
||
|
|
<returns></returns>
|
||
|
|
</member>
|
||
|
|
<member name="P:FarsiLibrary.PersianDate.Now">
|
||
|
|
<summary>
|
||
|
|
Current date/time in PersianDate format.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="P:FarsiLibrary.PersianDate.Year">
|
||
|
|
<summary>
|
||
|
|
Year value of PersianDate.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="P:FarsiLibrary.PersianDate.Month">
|
||
|
|
<summary>
|
||
|
|
Month value of PersianDate.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="P:FarsiLibrary.PersianDate.Day">
|
||
|
|
<summary>
|
||
|
|
Day value of PersianDate.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="P:FarsiLibrary.PersianDate.Hour">
|
||
|
|
<summary>
|
||
|
|
Hour value of PersianDate.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="P:FarsiLibrary.PersianDate.Minute">
|
||
|
|
<summary>
|
||
|
|
Minute value of PersianDate.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="P:FarsiLibrary.PersianDate.Second">
|
||
|
|
<summary>
|
||
|
|
Second value of PersianDate.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="P:FarsiLibrary.PersianDate.Millisecond">
|
||
|
|
<summary>
|
||
|
|
Millisecond value of PersianDate.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="P:FarsiLibrary.PersianDate.Time">
|
||
|
|
<summary>
|
||
|
|
Time value of PersianDate in TimeSpan format.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="P:FarsiLibrary.PersianDate.DayOfWeek">
|
||
|
|
<summary>
|
||
|
|
Returns the DayOfWeek of the date instance
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="P:FarsiLibrary.PersianDate.LocalizedMonthName">
|
||
|
|
<summary>
|
||
|
|
Localized name of PersianDate months.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="P:FarsiLibrary.PersianDate.LocalizedWeekDayName">
|
||
|
|
<summary>
|
||
|
|
Weekday names of this instance in localized format.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="P:FarsiLibrary.PersianDate.MonthDays">
|
||
|
|
<summary>
|
||
|
|
Number of days in this month.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="T:FarsiLibrary.Internals.Guard">
|
||
|
|
<summary>
|
||
|
|
Helper class for guard statements, which allow prettier
|
||
|
|
code for guard clauses
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.Internals.Guard.Against(System.Boolean,System.String)">
|
||
|
|
<summary>
|
||
|
|
Will throw a <see cref="T:System.InvalidOperationException"/> if the assertion
|
||
|
|
is true, with the specificied message.
|
||
|
|
</summary>
|
||
|
|
<param name="assertion">if set to <c>true</c> [assertion].</param>
|
||
|
|
<param name="message">The message.</param>
|
||
|
|
<example>
|
||
|
|
Sample usage:
|
||
|
|
<code>
|
||
|
|
Guard.Against(string.IsNullOrEmpty(name), "Name must have a value");
|
||
|
|
</code>
|
||
|
|
</example>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.Internals.Guard.Against``1(System.Boolean,System.String)">
|
||
|
|
<summary>
|
||
|
|
Will throw exception of type <typeparamref name="TException"/>
|
||
|
|
with the specified message if the assertion is true
|
||
|
|
</summary>
|
||
|
|
<typeparam name="TException"></typeparam>
|
||
|
|
<param name="assertion">if set to <c>true</c> [assertion].</param>
|
||
|
|
<param name="message">The message.</param>
|
||
|
|
<example>
|
||
|
|
Sample usage:
|
||
|
|
<code>
|
||
|
|
<![CDATA[
|
||
|
|
Guard.Against<ArgumentException>(string.IsNullOrEmpty(name), "Name must have a value");
|
||
|
|
]]>
|
||
|
|
</code>
|
||
|
|
</example>
|
||
|
|
</member>
|
||
|
|
<member name="T:FarsiLibrary.ToWords">
|
||
|
|
<summary>
|
||
|
|
Classes to convert a number to its persian written form. It accepts both an Integer or Long as input parameter.
|
||
|
|
</summary>
|
||
|
|
<exception>Thrown when input number is larger than 999999999999</exception>
|
||
|
|
<example>
|
||
|
|
An example on how to convert a Integer number to words.
|
||
|
|
<code>
|
||
|
|
class MyClass
|
||
|
|
{
|
||
|
|
public static void Main()
|
||
|
|
{
|
||
|
|
Console.WriteLine(FarsiLibrary.Utils.ToWords.ToString(1452));
|
||
|
|
}
|
||
|
|
}
|
||
|
|
</code>
|
||
|
|
</example>
|
||
|
|
<exception cref="T:System.ArgumentOutOfRangeException"></exception>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.ToWords.ToString(System.Int32)">
|
||
|
|
<overloads>Has two overloads.</overloads>
|
||
|
|
<summary>Converts an integer number to its written form in Persian</summary>
|
||
|
|
<param name="x"></param>
|
||
|
|
<returns></returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.ToWords.ToString(System.Int64)">
|
||
|
|
<summary>Converts a long number to its written form in Persian</summary>
|
||
|
|
<param name="x"></param>
|
||
|
|
<returns></returns>
|
||
|
|
<exception cref="T:System.ArgumentOutOfRangeException"></exception>
|
||
|
|
</member>
|
||
|
|
<member name="T:FarsiLibrary.Resources.ARLocalizer">
|
||
|
|
<summary>
|
||
|
|
Localizer class used to get string values of Arabic language.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.Resources.ARLocalizer.GetLocalizedString(FarsiLibrary.Resources.StringID)">
|
||
|
|
<summary>
|
||
|
|
Gets a localized string for Arabic culture, for specified <see cref="T:FarsiLibrary.Resources.StringID"/>.
|
||
|
|
</summary>
|
||
|
|
<param name="id"></param>
|
||
|
|
<returns></returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.Internals.Util.toDouble(System.Int32)">
|
||
|
|
<summary>
|
||
|
|
Adds a preceding zero to single day or months
|
||
|
|
</summary>
|
||
|
|
<param name="i"></param>
|
||
|
|
<returns></returns>
|
||
|
|
</member>
|
||
|
|
<member name="T:FarsiLibrary.PersianCultureInfo">
|
||
|
|
<summary>
|
||
|
|
CultureInfo for "FA-IR" culture, which has correct calendar information.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianCultureInfo.#ctor">
|
||
|
|
<summary>
|
||
|
|
Initializes a new instance of the <see cref="T:FarsiLibrary.PersianCultureInfo"/> class.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.PersianCultureInfo.Clone">
|
||
|
|
<summary>
|
||
|
|
Creates a copy of the current <see cref="T:System.Globalization.CultureInfo"/>.
|
||
|
|
</summary>
|
||
|
|
<returns>
|
||
|
|
A copy of the current <see cref="T:System.Globalization.CultureInfo"/>.
|
||
|
|
</returns>
|
||
|
|
</member>
|
||
|
|
<member name="P:FarsiLibrary.PersianCultureInfo.Calendar">
|
||
|
|
<summary>
|
||
|
|
Gets the default calendar used by the culture.
|
||
|
|
</summary>
|
||
|
|
<value></value>
|
||
|
|
<returns>
|
||
|
|
A <see cref="T:System.Globalization.Calendar"/> that represents the default calendar used by the culture.
|
||
|
|
</returns>
|
||
|
|
</member>
|
||
|
|
<member name="P:FarsiLibrary.PersianCultureInfo.OptionalCalendars">
|
||
|
|
<summary>
|
||
|
|
Gets the list of calendars that can be used by the culture.
|
||
|
|
</summary>
|
||
|
|
<value></value>
|
||
|
|
<returns>
|
||
|
|
An array of type <see cref="T:System.Globalization.Calendar"/> that represents the calendars that can be used by the culture represented by the current <see cref="T:System.Globalization.CultureInfo"/>.
|
||
|
|
</returns>
|
||
|
|
</member>
|
||
|
|
<member name="P:FarsiLibrary.PersianCultureInfo.DateTimeFormat">
|
||
|
|
<summary>
|
||
|
|
Gets or sets a <see cref="T:System.Globalization.DateTimeFormatInfo"/> that defines the culturally appropriate format of displaying dates and times.
|
||
|
|
</summary>
|
||
|
|
<value></value>
|
||
|
|
<returns>
|
||
|
|
A <see cref="T:System.Globalization.DateTimeFormatInfo"/> that defines the culturally appropriate format of displaying dates and times.
|
||
|
|
</returns>
|
||
|
|
<exception cref="T:System.ArgumentNullException">
|
||
|
|
The property is set to null.
|
||
|
|
</exception>
|
||
|
|
</member>
|
||
|
|
<member name="T:FarsiLibrary.Internals.CultureHelper">
|
||
|
|
<summary>
|
||
|
|
Base culture information
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.Internals.CultureHelper.GetDayOfWeek(System.DateTime,System.Globalization.Calendar)">
|
||
|
|
<summary>
|
||
|
|
Returns the day of week based on calendar.
|
||
|
|
</summary>
|
||
|
|
<param name="dt"></param>
|
||
|
|
<param name="calendar"></param>
|
||
|
|
<returns></returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.Internals.CultureHelper.GetCultureDayOfWeek(System.Int32,System.Globalization.CultureInfo)">
|
||
|
|
<summary>
|
||
|
|
Finds the corresponding DayOfWeek in specified culture
|
||
|
|
</summary>
|
||
|
|
<param name="day"></param>
|
||
|
|
<param name="culture"></param>
|
||
|
|
<returns></returns>
|
||
|
|
</member>
|
||
|
|
<member name="P:FarsiLibrary.Internals.CultureHelper.CurrentCulture">
|
||
|
|
<summary>
|
||
|
|
Currently selected UICulture
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="P:FarsiLibrary.Internals.CultureHelper.ArabicCulture">
|
||
|
|
<summary>
|
||
|
|
Instance of Arabic culture
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="P:FarsiLibrary.Internals.CultureHelper.FarsiCulture">
|
||
|
|
<summary>
|
||
|
|
Instance of Farsi culture
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="P:FarsiLibrary.Internals.CultureHelper.PersianCulture">
|
||
|
|
<summary>
|
||
|
|
Instance of Persian Culture with correct date formatting.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="P:FarsiLibrary.Internals.CultureHelper.NeutralCulture">
|
||
|
|
<summary>
|
||
|
|
Instance of Neutral culture
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="P:FarsiLibrary.Internals.CultureHelper.CurrentCalendar">
|
||
|
|
<summary>
|
||
|
|
Returns the default calendar for the current culture.
|
||
|
|
</summary>
|
||
|
|
<returns></returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.DateTimeExtensions.ToPersianDate(System.DateTime)">
|
||
|
|
<summary>
|
||
|
|
Converts the DateTime to a PersianDate equivalant.
|
||
|
|
</summary>
|
||
|
|
<param name="dateTime"></param>
|
||
|
|
<returns></returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.DateTimeExtensions.ToDateTime(FarsiLibrary.PersianDate)">
|
||
|
|
<summary>
|
||
|
|
Converts the PersianDate to a DateTime equivalant.
|
||
|
|
</summary>
|
||
|
|
<param name="persianDate"></param>
|
||
|
|
<returns></returns>
|
||
|
|
</member>
|
||
|
|
<member name="T:FarsiLibrary.Resources.StringID">
|
||
|
|
<summary>
|
||
|
|
Various Strings that could be translater in Localizers.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="T:FarsiLibrary.Resources.FALocalizeManager">
|
||
|
|
<summary>
|
||
|
|
Localizer class to work with internal localized strings.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.Resources.FALocalizeManager.GetLocalizer">
|
||
|
|
<summary>
|
||
|
|
Returns an instance of the localized based on CurrentUICulture of the thread.
|
||
|
|
</summary>
|
||
|
|
<returns></returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.Resources.FALocalizeManager.GetLocalizerByCulture(System.Globalization.CultureInfo)">
|
||
|
|
<summary>
|
||
|
|
Returns a localizer instance based on the culture.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="M:FarsiLibrary.Resources.FALocalizeManager.OnLocalizerChanged(System.EventArgs)">
|
||
|
|
<summary>
|
||
|
|
Fires the LocalizerChanged event.
|
||
|
|
</summary>
|
||
|
|
<param name="e"></param>
|
||
|
|
</member>
|
||
|
|
<member name="E:FarsiLibrary.Resources.FALocalizeManager.LocalizerChanged">
|
||
|
|
<summary>
|
||
|
|
Fired when Localizer has changed.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="P:FarsiLibrary.Resources.FALocalizeManager.Instance">
|
||
|
|
<summary>
|
||
|
|
Singleton Instance of FALocalizeManager.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="P:FarsiLibrary.Resources.FALocalizeManager.CustomCulture">
|
||
|
|
<summary>
|
||
|
|
Custom culture, when set , is used across all controls.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="P:FarsiLibrary.Resources.FALocalizeManager.FarsiCulture">
|
||
|
|
<summary>
|
||
|
|
Farsi Culture
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="P:FarsiLibrary.Resources.FALocalizeManager.ArabicCulture">
|
||
|
|
<summary>
|
||
|
|
Arabic Culture
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="P:FarsiLibrary.Resources.FALocalizeManager.InvariantCulture">
|
||
|
|
<summary>
|
||
|
|
Invariant Culture
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="P:FarsiLibrary.Resources.FALocalizeManager.CustomLocalizer">
|
||
|
|
<summary>
|
||
|
|
Gets or Sets a new instance of Localizer. If this value is initialized (default is null), Localize Manager class will use the custom class provided, to interpret localized strings.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
</members>
|
||
|
|
</doc>
|