New to Telerik UI for WinForms? Start a free 30-day trial

SchedulerHolidays

Class

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.Scheduler.dll

Syntax:

public class SchedulerHolidays : IEnumerable

Inheritance: objectSchedulerHolidays

Implements: IEnumerable

Constructors

SchedulerHolidays(RadScheduler)

public SchedulerHolidays(RadScheduler scheduler)

Parameters:schedulerRadScheduler

Fields

holidayDateSeparator

char[]

protected char[] holidayDateSeparator

holidayLineSeparator

char[]

protected char[] holidayLineSeparator

Methods

AddHoliday(Holiday, bool)

Add holiday to the holidays collection.

public virtual void AddHoliday(Holiday holiday, bool createAppointment)

Parameters:holidayHoliday

the holiday object

createAppointmentbool

if true this will create an all day appointment

AddHolidays(IEnumerable<Holiday>, bool)

Add holiday to the holidays collection.

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

Parameters:holidaysIEnumerable<Holiday>

Collection with holidays

createAppointmentbool

if true this will create an all day appointment

Clear()

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

public void Clear()

GetAllLocations(Stream)

Get all location from the stream

public List<string> GetAllLocations(Stream stream)

Parameters:streamStream

The input stream

Returns:

List<string>

List with the locations

GetAllLocations(string)

Get all locations from the stream

public List<string> GetAllLocations(string fileName)

Parameters:fileNamestring

The input file

Returns:

List<string>

List with the locations

GetEnumerator()

public IEnumerator<Holiday> GetEnumerator()

Returns:

IEnumerator<Holiday>

GetHolidays(DateTime)

Return all holidays for the specific date (if any)

public virtual IEnumerable<Holiday> GetHolidays(DateTime dateTime)

Parameters:dateTimeDateTime

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.

public virtual bool IsHoliday(DateTime dateTime)

Parameters:dateTimeDateTime

Date to check.

Returns:

bool

true if holidays collection contains the date

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.

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

Parameters:streamStream

File name. File must be in HOL format.

createAppointmentbool

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

locationsIEnumerable<string>

Collection with locations.

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.

public void ReadHolidays(Stream stream, bool createAppointment)

Parameters:streamStream

stream must be in HOL format.

createAppointmentbool

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.

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

Parameters:fileNamestring

File name. File must be in HOL format.

createAppointmentbool

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

locationsIEnumerable<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.

public void ReadHolidays(string fileName, bool createAppointment)

Parameters:fileNamestring

File name. File must be in HOL format.

createAppointmentbool

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