Reference > TDBHolidayX Object > TDBHolidayX Object Properties > ValueType Property (TDBHolidayX) |
ValueType Property (TDBHolidayX)
The ValueType property returns the day type of the date set in the Value property.
object.ValueType
Read-only at run time. Not available at design time.
Description |
Run Time |
-1 - Null |
dbiValueNull |
1 - Holiday/Workday |
dbiValueHolidayOrWorkday |
2 - Force Holiday or not |
dbiValueForceHoliday |
4 - Force Workday or not |
dbiValueForceWorkday |
8 - Overridden Holiday or not |
dbiValueOverriddenHoliday |
16 - Weekend or not |
dbiValueWeekend |
The ValueType property returns the day type of the date set in the Value property. in any of the following combination values:
-1 |
Null - No date specified in the Value property. |
1 |
Holiday/Workday (Bit 0) - 0 - workday, 1 - holiday One of the holidays specified in a holiday style. This is equal to setting the Type property in the Day object to "0- Holiday". If not a holiday, the day must be a workday. |
2 |
Force Holiday (Bit 1) - 0 - non-force holiday, 1- force holiday One of the holidays specified in a holiday style. This differs from the "1- Holiday" where the holidays is set specifically for that year only. Ex. Days like the Vernal Equinox Day where it may be different every year. This is equal to setting the Type property in the Day object to "1- Force Holiday". |
4 |
Force Workday (Bit 2) - 0 - non-force workday, 1 - force workday Originally the day may have been a holiday or weekend, but treat it as a workday just for that specific year only. This is equal to setting the Type property in the Day object to "2- Force Workday". |
8 |
Overriden Holiday (Bit 3) - 0 - non-override, 1 - overridden When a holiday lands on a weekend day that overrides to the next day, the overridden date will be of this type. |
16 |
Weekend (Bit 4) - 0 - non-weekend, 1 - weekend Days that are set as weekends for the weekdays. This is set using the WeekRests() property. |
When none of these combination values are returned, the day type of date will always be a workday.
Whether holidays should be overridden or not can be set using the WeekRests() property. When the overridden flag (8) is set, all holidays that land on that particular weekday, the holiday overridden to the next day.
To check to see if the Value property is null, the ValueIsNull property can be used. It is the same as that of the result returned by this property. (0- Null)
See Also