NGWS SDK Documentation  

This is preliminary documentation and subject to change.
To comment on this topic, please send us email at ngwssdk@microsoft.com. Thanks!

WeeklyPattern Constructor (DaysOfWeek, Int32, String, TimeSpan, TimeSpan, TimeSpan, DateTime, DateTime)

Initializes a new instance of the WeeklyPattern class with a set of days, the weekly execution interval, the pattern name, the start and end times for the event recurrence pattern, the event recurrence pattern repetition rate, and the dates when the event recurrence pattern starts and stops being valid specified.

[Visual Basic]
Overloads Public Sub New( _
   ByVal daysOfWeek As DaysOfWeek, _
   ByVal everyNthWeek As Integer, _
   ByVal patternName As String, _
   ByVal startTime As TimeSpan, _
   ByVal endTime As TimeSpan, _
   ByVal interval As TimeSpan, _
   ByVal validFrom As DateTime, _
   ByVal validUntil As DateTime _
)
[C#]
public WeeklyPattern(
   DaysOfWeek daysOfWeek,
   int everyNthWeek,
   string patternName,
   TimeSpan startTime,
   TimeSpan endTime,
   TimeSpan interval,
   DateTime validFrom,
   DateTime validUntil
);
[C++]
public: WeeklyPattern(
   DaysOfWeek daysOfWeek,
   int everyNthWeek,
   String* patternName,
   TimeSpan startTime,
   TimeSpan endTime,
   TimeSpan interval,
   DateTime validFrom,
   DateTime validUntil
);
[JScript]
public function WeeklyPattern(
   daysOfWeek : DaysOfWeek,
   everyNthWeek : int,
   patternName : String,
   startTime : TimeSpan,
   endTime : TimeSpan,
   interval : TimeSpan,
   validFrom : DateTime,
   validUntil : DateTime
);

Parameters

daysOfWeek
The set of days in the week during which the event should occur.
everyNthWeek
The weekly execution interval for the recurrence pattern.
patternName
The name of the class that identifies the recurrence pattern.
startTime
The time of a specific day when the recurrence pattern starts to occur.
endTime
The time of a specific day when the event stops being raised.
interval
The recurrence pattern repetition rate for a specific day.
validFrom
The date the recurrence pattern starts being valid.
validUntil
The date the recurrence pattern stops being valid.

Exceptions

Exception Type Condition
ArgumentException The endTime parameter value is less than 0 or greater than 23:59:59.

-or-

The interval parameter value is less than 0.

-or-

The patternName parameter value is greater than 255 characters.

-or-

The startTime parameter value is less than 0 or greater than 23:59:59.

-or-

The daysOfWeek parameter value is not a valid DaysOfWeek value.

-or-

The everyNthWeek parameter value is less than or equal to 0.

ArgumentNullException The patternName parameter value is a null reference (in Visual Basic Nothing).

Remarks

If the ValidFrom property is greater than the ValidUntil property, the values are switched.

See Also

WeeklyPattern Class | WeeklyPattern Members | System.Timers Namespace | WeeklyPattern Constructor Overload List