Class RecurrenceRule

Represents a base class that the actual recurrence rules extend.
The recurrence rule is passed as a string in the form of semicolon delimited list of key=value pairs.

Examples

Daily execution:
"RecurrenceRule":"FREQ=DAILY"

Every second day with a limit of 10 executions:
"RecurrenceRule":"FREQ=DAILY;INTERVAL=2;COUNT=10"

Daily execution with a limit until the provided date in JSON format:
"RecurrenceRule":"FREQ=DAILY;UNTIL=20181009T205959Z"

Inheritance
System.Object
RecurrenceRule
DailyRecurrenceRule
HourlyRecurrenceRule
MinutelyRecurrenceRule
WeeklyRecurrenceRule
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.ReportServer.Services.Models.RecurrenceRules
Assembly: Telerik.ReportServer.Services.Models.dll

Syntax

public abstract class RecurrenceRule : ICloneable, IEquatable<RecurrenceRule>

Constructors

RecurrenceRule()

Initializes a new instance of the RecurrenceRule class.

Declaration
public RecurrenceRule()

Properties

Count

Gets or sets the maximum number of occurrences.

Declaration
public int Count { get; set; }
Property Value
System.Int32

The count.

End

Specifies the end date of the recurrence rule.

Declaration
public DateTime End { get; set; }
Property Value
System.DateTime

Frequency

Gets the type of the recurrence rule.

Declaration
public abstract RecurrenceType Frequency { get; }
Property Value
RecurrenceType

The type of the recurrence rule.

Interval

Gets or sets the interval of the recurrence rule.

Declaration
public int Interval { get; set; }
Property Value
System.Int32

The interval.

Start

Specifies the start date of the recurrence rule.

Declaration
public DateTime? Start { get; set; }
Property Value
System.Nullable<System.DateTime>

Methods

Clone()

Creates a new object that is a copy of the current RecurrenceRule instance.

Declaration
public RecurrenceRule Clone()
Returns
RecurrenceRule

A new object that is a copy of this RecurrenceRule instance.

CreateRule(RecurrenceType)

Creates a rule given its type.

Declaration
public static RecurrenceRule CreateRule(RecurrenceType type)
Parameters
RecurrenceType type

The type of the recurrence rule.
Returns
RecurrenceRule

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
System.Object obj

Returns
System.Boolean

Overrides
System.Object.Equals(System.Object)

Equals(RecurrenceRule)

Indicates whether this RecurrenceRule instance and the specified object are equal.

Declaration
public virtual bool Equals(RecurrenceRule other)
Parameters
RecurrenceRule other

Another object to compare to.
Returns
System.Boolean

true if obj is equal to this instance; otherwise, false.
Implements
System.IEquatable<T>.Equals(T)

GetHashCode()

Returns the hash code of the instance.

Declaration
public override int GetHashCode()
Returns
System.Int32

Overrides
System.Object.GetHashCode()

GetOccurrenceStart(Int32, DateTimeFormatInfo)

Gets the occurrence start given a occurrence index.

Declaration
public abstract DateTime GetOccurrenceStart(int index, DateTimeFormatInfo dateTimeFormat)
Parameters
System.Int32 index

The index.
System.Globalization.DateTimeFormatInfo dateTimeFormat

The date time format.
Returns
System.DateTime

ToString()

Converts the RecurrenceRule to a string.

Declaration
public override string ToString()
Returns
System.String

Returns the string representation of the RecurrenceRule.
Overrides
System.Object.ToString()

Explicit Interface Implementations

ICloneable.Clone()

Declaration
object ICloneable.Clone()
Returns
System.Object

Implements
System.ICloneable.Clone()