ig.scheduler.DateRecurrence
備考
DateRecurrence クラスは数式パターンに基づいて日付を作成するために使用されます。
このクラスのインスタンスは、DateRecurrence.fromICalendarString メソッドを使用して繰り返しルール (iCalendar RRULE 式を参照) を表す iCalendar 文字列から作成できます。
両方向シリアル化サポートを提供するには、DateRecurrence.toICalendarString メソッドを使用してこのクラスのインスタンスから iCalendar 文字列を生成できます。
Appointment などのアクティビティを繰り返すには、iCalendar 文字列を ActivityBase.recurrence プロパティに割り当てます。
依存関係
-
ig.scheduler.DateRecurrence
コンストラクター- new $.ig.scheduler.DateRecurrence( );
デフォルト値で新しいインスタンスを作成します。
-
ig.scheduler.DateRecurrence
コンストラクター- new $.ig.scheduler.DateRecurrence( frequency:ig.scheduler.DateRecurrenceFrequency );
デフォルト値で新しいインスタンスを作成します。
- frequency
- タイプ:ig.scheduler.DateRecurrenceFrequency
- DateRecurrence.frequency プロパティの値がインスタンスの生成間隔を指定します。つまり、毎日、毎週、毎月など。
-
count
- .count( );
このインスタンスが生成する発生の最大数を指定します。
備考
DateRecurrence が発生の指定数、その後に発生を生成されない終了日に基づいて制限できます。
指定した日付によって生成された発生を制限するには DateRecurrence.until プロパティを使用します。
Count プロパティおよび DateRecurrence.until プロパティは相互に排他的です。両方のプロパティを設定すると、未定義の動作を発生します。
-
count
- .count( value:number );
このインスタンスが生成する発生の最大数を指定します。
- value
- タイプ:number
備考
DateRecurrence が発生の指定数、その後に発生を生成されない終了日に基づいて制限できます。
指定した日付によって生成された発生を制限するには DateRecurrence.until プロパティを使用します。
Count プロパティおよび DateRecurrence.until プロパティは相互に排他的です。両方のプロパティを設定すると、未定義の動作を発生します。
-
equals
- .equals( obj:object );
- 返却型:
- boolean
- 返却型の説明:
- 指定されたオブジェクトがこのオブジェクトと等しい場合は True。それ以外の場合は False。
オーバーライド。指定したオブジェクトがこのオブジェクトに等しい場合 True を返します。
- obj
- タイプ:object
- 比較するオブジェクト。
-
frequency
- .frequency( );
- 返却型:
- ig.scheduler.DateRecurrenceFrequency
- 返却型の説明:
- DateRecurrenceFrequency を返します。
インスタンスの生成間隔を指定します。つまり、毎日、毎週、毎月など。
-
frequency
- .frequency( value:ig.scheduler.DateRecurrenceFrequency );
- 返却型:
- ig.scheduler.DateRecurrenceFrequency
- 返却型の説明:
- DateRecurrenceFrequency を返します。
インスタンスの生成間隔を指定します。つまり、毎日、毎週、毎月など。
- value
- タイプ:ig.scheduler.DateRecurrenceFrequency
-
fromICalendarString
- .fromICalendarString( recurrence:string );
- 返却型:
- ig.scheduler.DateRecurrence
- 返却型の説明:
- DateRecurrence インスタンス。
iCalendar 繰り返し仕様に合わせる指定した文字列を DateRecurrence インスタンスに解析します。
- recurrence
- タイプ:string
- iCalendar 繰り返し書式設定にある文字列。
備考
指定した文字列が無効な場合、無効な文字列の部分についての情報を含む例外は発生されます。
-
getHashCode
- .getHashCode( );
- 返却型:
- number
- 返却型の説明:
- このオブジェクトのハッシュ コード。
オーバーライド。このオブジェクトのハッシュ コードを返します。
-
interval
- .interval( );
派生が設定される間隔を指定します。 1 の値 (デフォルト) は DateRecurrence.frequency プロパティのみが派生生成を決定することを示します。
備考
Interval プロパティは、発生がスキップされたとして表示されることを許可する方法を提供します。たとえば、このプロパティの値に 2 を割り当てると、1 つおきに生成される発生をスキップします。3 の値は 2 つおきの発生をスキップします。
-
interval
- .interval( value:number );
派生が設定される間隔を指定します。 1 の値 (デフォルト) は DateRecurrence.frequency プロパティのみが派生生成を決定することを示します。
- value
- タイプ:number
備考
Interval プロパティは、発生がスキップされたとして表示されることを許可する方法を提供します。たとえば、このプロパティの値に 2 を割り当てると、1 つおきに生成される発生をスキップします。3 の値は 2 つおきの発生をスキップします。
-
raisePropertyChangedEvent
- .raisePropertyChangedEvent( propertyName:string );
DateRecurrence.propertyChanged イベントを発生させます。
- propertyName
- タイプ:string
- 値が変更されたプロパティの名前。
-
rules
- .rules( );
- 返却型:
- ig.scheduler.RulesCollection
- 返却型の説明:
- RulesCollection を返します。
発生の生成に影響する追加のルールを指定します。
備考
繰り返しルールで発生を生成する追加条件を指定できます。 たとえば、発生生成が特定の月、週、曜日などに制限するルールを 1 つ以上指定できます。
組み合わせに基づいて、繰り返しルールが発生を制限するか、拡張できます。関連項目
-
rules
- .rules( index:number );
- 返却型:
- ig.scheduler.DateRecurrenceRuleBase
- 返却型の説明:
- RulesCollection を返します。
発生の生成に影響する追加のルールを指定します。
- index
- タイプ:number
-
rules
- .rules( index:number, value:ig.scheduler.DateRecurrenceRuleBase );
- 返却型:
- ig.scheduler.DateRecurrenceRuleBase
- 返却型の説明:
- RulesCollection を返します。
発生の生成に影響する追加のルールを指定します。
- index
- タイプ:number
- value
- タイプ:ig.scheduler.DateRecurrenceRuleBase
-
toICalendarString
- .toICalendarString( );
- 返却型:
- string
- 返却型の説明:
- この DateRecurrence を説明する文字列。
この DateRecurrence を iCalendar 文字列形式に変換します。
-
toICalendarString
- .toICalendarString( recurrence:ig.scheduler.DateRecurrence );
- 返却型:
- string
- 返却型の説明:
- この DateRecurrence を説明する文字列。
この DateRecurrence を iCalendar 文字列形式に変換します。
- recurrence
- タイプ:ig.scheduler.DateRecurrence
- 文字列形式に変換する DateRecurrence インスタンス。
-
toString
- .toString( );
- 返却型:
- string
- 返却型の説明:
- 繰り返しを説明するテキスト。
この繰り返しの人間が認識できる説明を返します。
-
toStringWithStartDate
- .toStringWithStartDate( startDate:ig.Date, [cultureName:string] );
- 返却型:
- string
- 返却型の説明:
- 定期的なパターンの人間が認識できる説明。
指定される開始日付に基づいた繰り返しの文字列形式を返します。
- startDate
- タイプ:ig.Date
- 繰り返しの開始日付。
- cultureName
- タイプ:string
- オプション
- オプションです。言語カルチャを識別する ISO-639 準拠する言語コード。たとえば、米国の英語は 'en-US’、日本語は 'ja-JP'、フランス語は 'fr-FR' など。ローカル コンピューターの現在言語カルチャを使用するために null を指定します。
-
toStringWithStartDateAndTimes
- .toStringWithStartDateAndTimes( startDate:ig.Date, startTime:ig.Date, endTime:ig.Date, [cultureName:string] );
- 返却型:
- string
- 返却型の説明:
- 定期的なパターンの人間が認識できる説明。
指定される開始日付に基づいた繰り返しの文字列形式を返します。
- startDate
- タイプ:ig.Date
- 繰り返しの開始日付または null 値。
- startTime
- タイプ:ig.Date
- 繰り返しの各インスタンスの開始時または null 値。
- endTime
- タイプ:ig.Date
- 繰り返しの各インスタンスの終了時または null 値。
- cultureName
- タイプ:string
- オプション
- オプションです。言語カルチャを識別する ISO-639 準拠する言語コード。たとえば、米国の英語は 'en-US' です。日本語は 'ja-JP' です。フランス語は 'fr-FR' など。ローカル コンピューターの現在言語カルチャを使用するために null を指定します。
-
until
- .until( );
発生の生成を終了する最大日を指定します。
備考
DateRecurrence が発生の指定数、その後に発生を生成されない終了日に基づいて制限できます。
DateRecurrence.count プロパティを使用すると、生成する発生の最大数を制限します。
Count プロパティおよび DateRecurrence.until プロパティは相互に排他的です。両方のプロパティを設定すると、未定義の動作を発生します。
-
until
- .until( value:ig.Date );
発生の生成を終了する最大日を指定します。
- value
- タイプ:ig.Date
備考
DateRecurrence が発生の指定数、その後に発生を生成されない終了日に基づいて制限できます。
DateRecurrence.count プロパティを使用すると、生成する発生の最大数を制限します。
Count プロパティおよび DateRecurrence.until プロパティは相互に排他的です。両方のプロパティを設定すると、未定義の動作を発生します。
-
weekStart
- .weekStart( );
この定期的なパターンの最初の曜日を指定します。
備考
このプロパティには、1 年の最初の週がいつ始まるかについての WeekOfYearRecurrenceRule などの特定のルールがいつ適用されるかの実装が含まれています。その年で 4 日以上ある最初の週をその年の最初の週と見なします。 このプロパティのデフォルト値は Monday である点に注意してください。 -
weekStart
- .weekStart( value:ig.DayOfWeek );
この定期的なパターンの最初の曜日を指定します。
- value
- タイプ:ig.DayOfWeek
備考
このプロパティには、1 年の最初の週がいつ始まるかについての WeekOfYearRecurrenceRule などの特定のルールがいつ適用されるかの実装が含まれています。その年で 4 日以上ある最初の週をその年の最初の週と見なします。 このプロパティのデフォルト値は Monday である点に注意してください。