Class
SchedulerHolidays

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.Scheduler.dll

Syntax:

cs-api-definition

public class SchedulerHolidays : IEnumerable

Inheritance: objectSchedulerHolidays

Implements: IEnumerable

Constructors

SchedulerHolidays(RadScheduler)

Declaration

cs-api-definition

public SchedulerHolidays(RadScheduler scheduler)

Parameters

scheduler

RadScheduler

Fields

holidayDateSeparator

Declaration

cs-api-definition

protected char[] holidayDateSeparator

Field Value

char[]

holidayLineSeparator

Declaration

cs-api-definition

protected char[] holidayLineSeparator

Field Value

char[]

Methods

AddHoliday(Holiday, bool)

Add holiday to the holidays collection.

Declaration

cs-api-definition

public virtual void AddHoliday(Holiday holiday, bool createAppointment)

Parameters

holiday

Holiday

the holiday object

createAppointment

bool

if true this will create an all day appointment

AddHolidays(IEnumerable<Holiday>, bool)

Add holiday to the holidays collection.

Declaration

cs-api-definition

public virtual void AddHolidays(IEnumerable<Holiday> holidays, bool createAppointment)

Parameters

holidays

IEnumerable<Holiday>

Collection with holidays

createAppointment

bool

if true this will create an all day appointment

Clear()

Clear the Holidays collections. This does not affect already created appointments.

Declaration

cs-api-definition

public void Clear()

GetAllLocations(Stream)

Get all location from the stream

Declaration

cs-api-definition

public List<string> GetAllLocations(Stream stream)

Parameters

stream

Stream

The input stream

Returns

List<string>

List with the locations

GetAllLocations(string)

Get all locations from the stream

Declaration

cs-api-definition

public List<string> GetAllLocations(string fileName)

Parameters

fileName

string

The input file

Returns

List<string>

List with the locations

GetEnumerator()

Declaration

cs-api-definition

public IEnumerator<Holiday> GetEnumerator()

Returns

IEnumerator<Holiday>

GetHolidays(DateTime)

Return all holidays for the specific date (if any)

Declaration

cs-api-definition

public virtual IEnumerable<Holiday> GetHolidays(DateTime dateTime)

Parameters

dateTime

DateTime

Date to check

Returns

IEnumerable<Holiday>

Collection with holidays - may be null if there is not holidays for this date

IsHoliday(DateTime)

Check if the specific date is contained in the Holidays collection.

Declaration

cs-api-definition

public virtual bool IsHoliday(DateTime dateTime)

Parameters

dateTime

DateTime

Date to check.

Returns

bool

true if holidays collection contains the date

ReadHolidays(Stream, bool)

Read the holidays information and create Holidays objects in the holidays collection. Optionally can create also and all day appointments for the holidays.

Declaration

cs-api-definition

public void ReadHolidays(Stream stream, bool createAppointment)

Parameters

stream

Stream

stream must be in HOL format.

createAppointment

bool

If true this will be create an appointments for each holidays.

ReadHolidays(Stream, bool, IEnumerable<string>)

Read the holidays information and create Holidays objects in the holidays collection only for holidays in the specific locations. Optionally can create also and all day appointments for the holidays.

Declaration

cs-api-definition

public void ReadHolidays(Stream stream, bool createAppointment, IEnumerable<string> locations)

Parameters

stream

Stream

File name. File must be in HOL format.

createAppointment

bool

If true this will be create an appointments for each holidays.

locations

IEnumerable<string>

Collection with locations.

ReadHolidays(string, bool)

Read the holidays information and create Holidays objects in the holidays collection. Optionally can create also and all day appointments for the holidays.

Declaration

cs-api-definition

public void ReadHolidays(string fileName, bool createAppointment)

Parameters

fileName

string

File name. File must be in HOL format.

createAppointment

bool

If true this will be create an appointments for each holidays.

ReadHolidays(string, bool, IEnumerable<string>)

Read the holidays information and create Holidays objects in the holidays collection only for holidays in the specific locations. Optionally can create also and all day appointments for the holidays.

Declaration

cs-api-definition

public void ReadHolidays(string fileName, bool createAppointment, IEnumerable<string> locations)

Parameters

fileName

string

File name. File must be in HOL format.

createAppointment

bool

If true this will be create an appointments for each holidays.

locations

IEnumerable<string>

Collection with locations.

ClassSchedulerHolidays

Class
SchedulerHolidays