Skip to main content

TcxSchedulerHolidays.PopulateHolidayDates(TcxSchedulerDateList,TDate,TDate,Boolean,Boolean) Method

Populates a list with holidays available within the specified time period.

Declaration

procedure PopulateHolidayDates(AList: TcxSchedulerDateList; const AStart: TDate; const AFinish: TDate; AOnlyVisible: Boolean = True; AClearList: Boolean = True); virtual;

Parameters

Name Type
AList TcxSchedulerDateList
AStart TDate
AFinish TDate
AOnlyVisible Boolean
AClearList Boolean

Remarks

AStart and AFinish specify the time frame.

AOnlyVisible specifies which holidays are to be written to AList. Set AOnlyVisible to True, to populate AList with only holidays that are available to the scheduler (the TcxSchedulerHolidaysLocation.Visible and TcxSchedulerHolidaysLocationHoliday.Visible properties are True). Otherwise, all holidays stored in the TcxSchedulerHolidays component will be added to the list.

AClearList specifies whether AList is to be cleared prior to writing new items.

All the holiday reference duplicates are automatically deleted, if linked storages are connected to the same TcxSchedulerHolidays component.

See Also