---

Macro Compatibility

---

Parameter	Type	Presence	Purpose	Options	Default
calculate	String	Optional	Post processing formula. Use {value} for the macro output, e.g. {value}/1024.	N/A	N/A
colorTableCell	Boolean	Optional	Whether to color table cells if thresholds are breached, rather than color the text.	true false	true
comment	String	Optional	Add a comment to make your document template more readable. The comment is discarded in the output document.	N/A	N/A
criticalAfter	DateTimeOffset	Optional	The macro is considered 'critical' if the output is after this DateTime UTC.	N/A	N/A
criticalBefore	DateTimeOffset	Optional	The macro is considered 'critical' if the output is before this DateTime UTC.	N/A	N/A
criticalEq	String	Optional	The macro is considered 'critical' if the output is equal to this value.	N/A	N/A
criticalFontBackgroundColor	Color	Optional	The critical font background color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
criticalFontBold	Boolean	Optional	Change the font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
criticalFontColor	Color	Optional	The critical font color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
criticalFontSize	Double	Optional	Change the critical font size in points. If omitted, no change is made.	From 2 to 200	N/A
criticalGe	String	Optional	The macro is considered 'critical' if the output is greater than or equal to this value.	N/A	N/A
criticalGt	String	Optional	The macro is considered 'critical' if the output is greater than this value.	N/A	N/A
criticalIf	String	Optional	The macro is considered 'critical' if the expression evaluates to true. Use 'value' as the macro output in the expression.	N/A	N/A
criticalLe	String	Optional	The macro is considered 'critical' if the output is less than or equal to this value.	N/A	N/A
criticalLt	String	Optional	The macro is considered 'critical' if the output is less than this value.	N/A	N/A
criticalNe	String	Optional	The macro is considered 'critical' if the output is not equal to this value.	N/A	N/A
criticalTableCellBackgroundColor	Color	Optional	The critical table cell background color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
delimiter	Char	Optional	When using selectDistinct or find/replaceWith or regexFind/regexReplaceWith, this specifies the delimiter character.	N/A	;
endTime	String	Optional	The end time of day.	N/A	17:00:00
errorAfter	DateTimeOffset	Optional	The macro is considered 'error' if the output is after this DateTime UTC.	N/A	N/A
errorBefore	DateTimeOffset	Optional	The macro is considered 'error' if the output is before this DateTime UTC.	N/A	N/A
errorEq	String	Optional	The macro is considered 'error' if the output is equal to this value.	N/A	N/A
errorFontBackgroundColor	Color	Optional	The error font background color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
errorFontBold	Boolean	Optional	Change the error font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
errorFontColor	Color	Optional	The error font color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
errorFontSize	Double	Optional	Change the error font size in points. If omitted, no change is made.	From 2 to 200	N/A
errorGe	String	Optional	The macro is considered 'error' if the output is greater than or equal to this value.	N/A	N/A
errorGt	String	Optional	The macro is considered 'error' if the output is greater than this value.	N/A	N/A
errorIf	String	Optional	The macro is considered 'error' if the expression evaluates to true. Use 'value' as the macro output in the expression.	N/A	N/A
errorLe	String	Optional	The macro is considered 'error' if the output is less than or equal to this value.	N/A	N/A
errorLt	String	Optional	The macro is considered 'error' if the output is less than this value.	N/A	N/A
errorNe	String	Optional	The macro is considered 'error' if the output is not equal to this value.	N/A	N/A
errorOnOverflow	Boolean	Optional	Should NCalc expression evaluation throw error on Overflow	true false	true
errorTableCellBackgroundColor	Color	Optional	The error table cell background color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
failureText	String	Optional	The text to display should the macro fail to execute. Note that a poorly-specified macro (e.g. omitting mandatory parameters) will still result in an error message.	N/A	N/A
fatalAfter	DateTimeOffset	Optional	The macro is considered 'fatal' if the output is after this DateTime UTC.	N/A	N/A
fatalBefore	DateTimeOffset	Optional	The macro is considered 'fatal' if the output is before this DateTime UTC.	N/A	N/A
fatalEq	String	Optional	The macro is considered 'fatal' if the output is equal to this value.	N/A	N/A
fatalFontBackgroundColor	Color	Optional	The fatal font background color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
fatalFontBold	Boolean	Optional	Change the fatal font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
fatalFontColor	Color	Optional	The fatal font color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
fatalFontSize	Double	Optional	Change the fatal font size in points. If omitted, no change is made.	From 2 to 200	N/A
fatalGe	String	Optional	The macro is considered 'fatal' if the output is greater than or equal to this value.	N/A	N/A
fatalGt	String	Optional	The macro is considered 'fatal' if the output is greater than this value.	N/A	N/A
fatalIf	String	Optional	The macro is considered 'fatal' if the expression evaluates to true. Use 'value' as the macro output in the expression.	N/A	N/A
fatalLe	String	Optional	The macro is considered 'fatal' if the output is less than or equal to this value.	N/A	N/A
fatalLt	String	Optional	The macro is considered 'fatal' if the output is less than this value.	N/A	N/A
fatalNe	String	Optional	The macro is considered 'fatal' if the output is not equal to this value.	N/A	N/A
fatalTableCellBackgroundColor	Color	Optional	The fatal table cell background color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
find	List<String>	Optional	The string value(s) to find in the value.	N/A	N/A
fontBackgroundColor	Color	Optional	The font background color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
fontBold	Boolean	Optional	Change the font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
fontColor	Color	Optional	The font color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
fontSize	Double	Optional	Change the font size in points. If omitted, no change is made.	From 2 to 200	N/A
format	String	Optional	The formatting to use for numbers. You can also specify 'format=string' to force numbers to be treated as strings.	N/A	N/A
hidden	Boolean	Optional	Whether to hide the macro output.	true false	false
if	String	Optional	The condition that must be true in order for the macro to be executed/evaluated. Must either evaluate to true or false, for example: "3+5=8" or "contains('abcd', 'z').	N/A	true
infoAfter	DateTimeOffset	Optional	The macro is considered 'info' if the output is after this DateTime UTC.	N/A	N/A
infoBefore	DateTimeOffset	Optional	The macro is considered 'info' if the output is before this DateTime UTC.	N/A	N/A
infoEq	String	Optional	The macro is considered 'info' if the output is equal to this value.	N/A	N/A
infoFontBackgroundColor	Color	Optional	The info font background color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
infoFontBold	Boolean	Optional	Change the info font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
infoFontColor	Color	Optional	The info font color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
infoFontSize	Double	Optional	Change the info font size in points. If omitted, no change is made.	From 2 to 200	N/A
infoGe	String	Optional	The macro is considered 'info' if the output is greater than or equal to this value.	N/A	N/A
infoGt	String	Optional	The macro is considered 'info' if the output is greater than this value.	N/A	N/A
infoIf	String	Optional	The macro is considered 'info' if the expression evaluates to true. Use 'value' as the macro output in the expression.	N/A	N/A
infoLe	String	Optional	The macro is considered 'info' if the output is less than or equal to this value.	N/A	N/A
infoLt	String	Optional	The macro is considered 'info' if the output is less than this value.	N/A	N/A
infoNe	String	Optional	The macro is considered 'info' if the output is not equal to this value.	N/A	N/A
infoTableCellBackgroundColor	Color	Optional	The info table cell background color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
mode	MacroMode	Optional	The mode in which variables are stored. In the legacy mode (default for Schedules), the variable created is a string and formatted. In the normal mode (default for Report Studio), the output variable is stored as a strongly-typed object, e.g. an Int32 or a List etc., rather than a formatted string.	Legacy Normal	Legacy
nonWorkDates	List<String>	Optional	Non-working dates, in the form: YYYY-MM-DD. For example, UK Bank Holidays.	N/A	N/A
normalFontBackgroundColor	Color	Optional	The normal font background color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
normalFontBold	Boolean	Optional	Change the normal font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
normalFontColor	Color	Optional	The normal font color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
normalFontSize	Double	Optional	Change the normal font size in points. If omitted, no change is made.	From 2 to 200	N/A
normalTableCellBackgroundColor	Color	Optional	The normal table cell background color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
obfuscation	ObfuscationType	Optional	Obfuscation type. Use obfuscation to write reports where sensitive data is hidden. When used, ReportMagic guarantees that the same input string will map to the same output string for the whole of the report (but the next time the report runs, it will most likely map to a different value). If you use obfuscation, the property in your macro will not show up and instead, you will see a fake item of the obfuscation type chosen.	None UkTown DeviceName Company IpAddress PrivateIpAddress	None
outputListsAsJarray Normal mode	Boolean	Optional	Any macros that output lists can optionally (in Normal mode) output a jArray instead.	true false	true
redact	Boolean	Optional	Whether substituted variables are hidden from macro results (and the word 'REDACTED' will appear in progress screens and elsewhere in the web UI).	true false	false
regexFind	List<String>	Optional	The Regex pattern(s) to find in the value.	N/A	N/A
regexReplaceWith	List<String>	Optional	The Regex string value(s) to use to replace the string specified in the regexFind parameter. Ignored if the regexFind parameter is not specified. Mandatory if the regexFind parameter is specified and the number of replacements must match the number of regexFinds.	N/A	N/A
replaceWith	List<String>	Optional	The string value(s) to use to replace the string specified in the find parameter. Ignored if the find parameter is not specified. Mandatory if the find parameter is specified and the number of replacements must match the number of finds.	N/A	N/A
selectDistinct	Boolean	Optional	Whether to select distinct values in a string list.	true false	false
singleValueList Normal mode	Boolean	Optional	In Normal Mode and for macros that output JArrays only, whether to convert a JArray of single-property jObjects into a flat JArray of values.	true false	false
startTime	String	Optional	The start time of day.	N/A	09:00:00
storeAs	String	Optional	The variable to store the result as.	N/A	N/A
storeAsHidden	String	Optional	The variable to store the result as, while hiding the output. Equivalent to 'storeAs=ThisValue, hidden=true'.	N/A	N/A
storeAsVariableDelimiter	Char	Optional	The delimiter used by storeAs to split the input (Legacy mode only), when there are multiple stored variables. For example, in this macro, we indicate that the value to be stored should be split by the asterisk when being stored: [String:value=a*b*c*d, storeAs=var1;var2;var3;var4, storeAsVariableDelimiter=*]	N/A	;
storeFormattedValueAs	String	Optional	The name of the STRING variable to store the result as and output (both will use the same format) into the report. Note that if you also use 'storeAsHidden' in the same macro, you should not expect the output to be hidden, as this parameter overrides that.	N/A	N/A
timeZone	String	Optional	The time zone. Supported values are: Australia/Darwin, Australia/Sydney, Australia/Melbourne, Asia/Kabul, America/Anchorage, America/Juneau, America/Metlakatla, America/Nome, America/Sitka, America/Yakutat, America/Adak, Asia/Barnaul, Asia/Riyadh, Asia/Bahrain, Asia/Kuwait, Asia/Qatar, Asia/Aden, Asia/Dubai, Asia/Muscat, Etc/GMT-4, Asia/Baghdad, America/Buenos_Aires, America/Argentina/La_Rioja, America/Argentina/Rio_Gallegos, America/Argentina/Salta, America/Argentina/San_Juan, America/Argentina/San_Luis, America/Argentina/Tucuman, America/Argentina/Ushuaia, America/Catamarca, America/Cordoba, America/Jujuy, America/Mendoza, Europe/Astrakhan, Europe/Ulyanovsk, America/Halifax, Atlantic/Bermuda, America/Glace_Bay, America/Goose_Bay, America/Moncton, America/Thule, Australia/Eucla, Asia/Baku, Atlantic/Azores, America/Scoresbysund, America/Bahia, Asia/Dhaka, Asia/Thimphu, Europe/Minsk, Pacific/Bougainville, America/Regina, America/Swift_Current, Atlantic/Cape_Verde, Etc/GMT+1, Asia/Yerevan, Australia/Adelaide, Australia/Broken_Hill, America/Guatemala, America/Belize, America/Costa_Rica, Pacific/Galapagos, America/Tegucigalpa, America/Managua, America/El_Salvador, Etc/GMT+6, Asia/Bishkek, Antarctica/Vostok, Asia/Urumqi, Indian/Chagos, Etc/GMT-6, America/Cuiaba, America/Campo_Grande, Europe/Budapest, Europe/Tirane, Europe/Prague, Europe/Podgorica, Europe/Belgrade, Europe/Ljubljana, Europe/Bratislava, Europe/Warsaw, Europe/Sarajevo, Europe/Zagreb, Europe/Skopje, Pacific/Guadalcanal, Antarctica/Casey, Pacific/Ponape, Pacific/Kosrae, Pacific/Noumea, Pacific/Efate, Etc/GMT-11, America/Mexico_City, America/Bahia_Banderas, America/Merida, America/Monterrey, America/Chihuahua, America/Chicago, America/Winnipeg, America/Rankin_Inlet, America/Resolute, America/Matamoros, America/Ojinaga, America/Indiana/Knox, America/Indiana/Tell_City, America/Menominee, America/North_Dakota/Beulah, America/North_Dakota/Center, America/North_Dakota/New_Salem, Pacific/Chatham, Asia/Shanghai, Asia/Hong_Kong, Asia/Macau, America/Havana, Etc/GMT+12, Africa/Nairobi, Antarctica/Syowa, Africa/Djibouti, Africa/Asmera, Africa/Addis_Ababa, Indian/Comoro, Indian/Antananarivo, Africa/Mogadishu, Africa/Dar_es_Salaam, Africa/Kampala, Indian/Mayotte, Etc/GMT-3, Australia/Brisbane, Australia/Lindeman, Europe/Chisinau, America/Sao_Paulo, Pacific/Easter, America/Cancun, America/New_York, America/Nassau, America/Toronto, America/Iqaluit, America/Detroit, America/Indiana/Petersburg, America/Indiana/Vincennes, America/Indiana/Winamac, America/Kentucky/Monticello, America/Louisville, Africa/Cairo, Asia/Yekaterinburg, Europe/Kiev, Europe/Mariehamn, Europe/Sofia, Europe/Tallinn, Europe/Helsinki, Europe/Vilnius, Europe/Riga, Pacific/Fiji, Europe/London, Atlantic/Canary, Atlantic/Faeroe, Europe/Guernsey, Europe/Dublin, Europe/Isle_of_Man, Europe/Jersey, Europe/Lisbon, Atlantic/Madeira, Europe/Bucharest, Asia/Nicosia, Asia/Famagusta, Europe/Athens, Asia/Tbilisi, America/Godthab, Atlantic/Reykjavik, Atlantic/St_Helena, Africa/Ouagadougou, Africa/Abidjan, Africa/Accra, America/Danmarkshavn, Africa/Banjul, Africa/Conakry, Africa/Bissau, Africa/Monrovia, Africa/Bamako, Africa/Nouakchott, Africa/Freetown, Africa/Dakar, Africa/Lome, America/Port-au-Prince, Pacific/Honolulu, Pacific/Rarotonga, Pacific/Tahiti, Etc/GMT+10, Asia/Calcutta, Asia/Tehran, Asia/Jerusalem, Asia/Amman, Europe/Kaliningrad, Asia/Seoul, Africa/Tripoli, Pacific/Kiritimati, Etc/GMT-14, Australia/Lord_Howe, Asia/Magadan, America/Punta_Arenas, Pacific/Marquesas, Indian/Mauritius, Indian/Reunion, Indian/Mahe, Asia/Beirut, America/Montevideo, Africa/Casablanca, Africa/El_Aaiun, America/Mazatlan, America/Denver, America/Edmonton, America/Cambridge_Bay, America/Inuvik, America/Ciudad_Juarez, America/Boise, Asia/Rangoon, Indian/Cocos, Asia/Novosibirsk, Africa/Windhoek, Asia/Katmandu, Pacific/Auckland, Antarctica/McMurdo, America/St_Johns, Pacific/Norfolk, Asia/Irkutsk, Asia/Krasnoyarsk, Asia/Novokuznetsk, Asia/Pyongyang, Asia/Omsk, America/Santiago, America/Tijuana, America/Los_Angeles, America/Vancouver, Asia/Karachi, America/Asuncion, Asia/Qyzylorda, Europe/Paris, Europe/Brussels, Europe/Copenhagen, Africa/Ceuta, Europe/Madrid, Asia/Srednekolymsk, Asia/Kamchatka, Asia/Anadyr, Europe/Samara, Europe/Moscow, Europe/Kirov, Europe/Simferopol, America/Cayenne, Antarctica/Rothera, Antarctica/Palmer, America/Fortaleza, America/Belem, America/Maceio, America/Recife, America/Santarem, Atlantic/Stanley, America/Paramaribo, Etc/GMT+3, America/Bogota, America/Rio_Branco, America/Eirunepe, America/Coral_Harbour, America/Guayaquil, America/Jamaica, America/Cayman, America/Panama, America/Lima, Etc/GMT+5, America/La_Paz, America/Antigua, America/Anguilla, America/Aruba, America/Barbados, America/St_Barthelemy, America/Kralendijk, America/Manaus, America/Boa_Vista, America/Porto_Velho, America/Blanc-Sablon, America/Curacao, America/Dominica, America/Santo_Domingo, America/Grenada, America/Guadeloupe, America/Guyana, America/St_Kitts, America/St_Lucia, America/Marigot, America/Martinique, America/Montserrat, America/Puerto_Rico, America/Lower_Princes, America/Port_of_Spain, America/St_Vincent, America/Tortola, America/St_Thomas, Etc/GMT+4, Asia/Bangkok, Antarctica/Davis, Indian/Christmas, Asia/Jakarta, Asia/Pontianak, Asia/Phnom_Penh, Asia/Vientiane, Asia/Saigon, Etc/GMT-7, America/Miquelon, Asia/Sakhalin, Pacific/Apia, Africa/Sao_Tome, Europe/Saratov, Asia/Singapore, Asia/Brunei, Asia/Makassar, Asia/Kuala_Lumpur, Asia/Kuching, Asia/Manila, Etc/GMT-8, Africa/Johannesburg, Africa/Bujumbura, Africa/Gaborone, Africa/Lubumbashi, Africa/Maseru, Africa/Blantyre, Africa/Maputo, Africa/Kigali, Africa/Mbabane, Africa/Lusaka, Africa/Harare, Etc/GMT-2, Africa/Juba, Asia/Colombo, Africa/Khartoum, Asia/Damascus, Asia/Taipei, Australia/Hobart, Antarctica/Macquarie, America/Araguaina, Asia/Tokyo, Asia/Jayapura, Pacific/Palau, Asia/Dili, Etc/GMT-9, Asia/Tomsk, Pacific/Tongatapu, Asia/Chita, Europe/Istanbul, America/Grand_Turk, America/Indianapolis, America/Indiana/Marengo, America/Indiana/Vevay, America/Phoenix, America/Creston, America/Dawson_Creek, America/Fort_Nelson, America/Hermosillo, Etc/GMT+7, Etc/GMT-12, Pacific/Tarawa, Pacific/Majuro, Pacific/Kwajalein, Pacific/Nauru, Pacific/Funafuti, Pacific/Wake, Pacific/Wallis, Etc/GMT-13, Pacific/Enderbury, Pacific/Fakaofo, Etc/UTC, Etc/GMT, Etc/GMT+2, America/Noronha, Atlantic/South_Georgia, Etc/GMT+8, Pacific/Pitcairn, Etc/GMT+9, Pacific/Gambier, Etc/GMT+11, Pacific/Pago_Pago, Pacific/Niue, Pacific/Midway, Asia/Ulaanbaatar, America/Caracas, Asia/Vladivostok, Asia/Ust-Nera, Europe/Volgograd, Australia/Perth, Africa/Lagos, Africa/Luanda, Africa/Porto-Novo, Africa/Kinshasa, Africa/Bangui, Africa/Brazzaville, Africa/Douala, Africa/Algiers, Africa/Libreville, Africa/Malabo, Africa/Niamey, Africa/Ndjamena, Africa/Tunis, Etc/GMT-1, Europe/Berlin, Europe/Andorra, Europe/Vienna, Europe/Zurich, Europe/Busingen, Europe/Gibraltar, Europe/Rome, Europe/Vaduz, Europe/Luxembourg, Europe/Monaco, Europe/Malta, Europe/Amsterdam, Europe/Oslo, Europe/Stockholm, Arctic/Longyearbyen, Europe/San_Marino, Europe/Vatican, Asia/Hovd, Asia/Tashkent, Antarctica/Mawson, Asia/Oral, Asia/Almaty, Asia/Aqtau, Asia/Aqtobe, Asia/Atyrau, Asia/Qostanay, Indian/Maldives, Indian/Kerguelen, Asia/Dushanbe, Asia/Ashgabat, Asia/Samarkand, Etc/GMT-5, Asia/Hebron, Asia/Gaza, Pacific/Port_Moresby, Antarctica/DumontDUrville, Pacific/Truk, Pacific/Guam, Pacific/Saipan, Etc/GMT-10, Asia/Yakutsk, Asia/Khandyga, America/Whitehorse, America/Dawson, Iceland, Africa/Timbuktu, Egypt, Africa/Asmara, Libya, America/Atka, US/Aleutian, US/Alaska, America/Argentina/Buenos_Aires, America/Argentina/Catamarca, America/Argentina/ComodRivadavia, America/Argentina/Cordoba, America/Rosario, America/Argentina/Jujuy, America/Argentina/Mendoza, US/Central, CST6CDT, America/Shiprock, Navajo, US/Mountain, MST7MDT, US/Michigan, Canada/Mountain, America/Yellowknife, Canada/Atlantic, Cuba, America/Indiana/Indianapolis, US/East-Indiana, America/Knox_IN, US/Indiana-Starke, America/Pangnirtung, Jamaica, America/Kentucky/Louisville, US/Pacific, PST8PDT, Brazil/West, Mexico/BajaSur, Mexico/General, US/Eastern, EST5EDT, Brazil/DeNoronha, America/Nuuk, America/Atikokan, EST, US/Arizona, MST, America/Virgin, Canada/Saskatchewan, America/Porto_Acre, Brazil/Acre, Chile/Continental, Brazil/East, Canada/Newfoundland, America/Ensenada, Mexico/BajaNorte, America/Santa_Isabel, America/Montreal, Canada/Eastern, America/Nipigon, America/Thunder_Bay, Canada/Pacific, Canada/Yukon, Canada/Central, America/Rainy_River, Asia/Ashkhabad, Asia/Dacca, Asia/Ho_Chi_Minh, Hongkong, Asia/Tel_Aviv, Israel, Asia/Kathmandu, Asia/Kolkata, Asia/Macao, Asia/Ujung_Pandang, Europe/Nicosia, ROK, Asia/Chongqing, Asia/Chungking, Asia/Harbin, PRC, Singapore, ROC, Iran, Asia/Thimbu, Japan, Asia/Ulan_Bator, Asia/Choibalsan, Asia/Kashgar, Asia/Yangon, Atlantic/Faroe, Australia/South, Australia/Queensland, Australia/Yancowinna, Australia/North, Australia/Tasmania, Australia/Currie, Australia/LHI, Australia/Victoria, Australia/West, Australia/ACT, Australia/Canberra, Australia/NSW, Etc/GMT+0, Etc/GMT-0, Etc/GMT0, Etc/Greenwich, GMT, GMT+0, GMT-0, GMT0, Greenwich, Etc/UCT, Etc/Universal, Etc/Zulu, UCT, UTC, Universal, Zulu, EET, Atlantic/Jan_Mayen, CET, MET, Europe/Tiraspol, Eire, Asia/Istanbul, Turkey, Europe/Kyiv, Europe/Zaporozhye, Europe/Uzhgorod, Portugal, WET, Europe/Belfast, GB, GB-Eire, W-SU, Poland, Antarctica/South_Pole, NZ, NZ-CHAT, Chile/EasterIsland, Pacific/Pohnpei, US/Hawaii, Pacific/Johnston, HST, Pacific/Kanton, Kwajalein, Pacific/Samoa, US/Samoa, Pacific/Chuuk, Pacific/Yap, America/Fort_Wayne, Antarctica/Troll, AUS Central Standard Time, AUS Eastern Standard Time, Afghanistan Standard Time, Alaskan Standard Time, Aleutian Standard Time, Altai Standard Time, Arab Standard Time, Arabian Standard Time, Arabic Standard Time, Argentina Standard Time, Astrakhan Standard Time, Atlantic Standard Time, Aus Central W. Standard Time, Azerbaijan Standard Time, Azores Standard Time, Bahia Standard Time, Bangladesh Standard Time, Belarus Standard Time, Bougainville Standard Time, Canada Central Standard Time, Cape Verde Standard Time, Caucasus Standard Time, Cen. Australia Standard Time, Central America Standard Time, Central Asia Standard Time, Central Brazilian Standard Time, Central Europe Standard Time, Central European Standard Time, Central Pacific Standard Time, Central Standard Time (Mexico), Central Standard Time, Chatham Islands Standard Time, China Standard Time, Cuba Standard Time, Dateline Standard Time, E. Africa Standard Time, E. Australia Standard Time, E. Europe Standard Time, E. South America Standard Time, Easter Island Standard Time, Eastern Standard Time (Mexico), Eastern Standard Time, Egypt Standard Time, Ekaterinburg Standard Time, FLE Standard Time, Fiji Standard Time, GMT Standard Time, GTB Standard Time, Georgian Standard Time, Greenland Standard Time, Greenwich Standard Time, Haiti Standard Time, Hawaiian Standard Time, India Standard Time, Iran Standard Time, Israel Standard Time, Jordan Standard Time, Kaliningrad Standard Time, Korea Standard Time, Libya Standard Time, Line Islands Standard Time, Lord Howe Standard Time, Magadan Standard Time, Magallanes Standard Time, Marquesas Standard Time, Mauritius Standard Time, Middle East Standard Time, Montevideo Standard Time, Morocco Standard Time, Mountain Standard Time (Mexico), Mountain Standard Time, Myanmar Standard Time, N. Central Asia Standard Time, Namibia Standard Time, Nepal Standard Time, New Zealand Standard Time, Newfoundland Standard Time, Norfolk Standard Time, North Asia East Standard Time, North Asia Standard Time, North Korea Standard Time, Omsk Standard Time, Pacific SA Standard Time, Pacific Standard Time (Mexico), Pacific Standard Time, Pakistan Standard Time, Paraguay Standard Time, Qyzylorda Standard Time, Romance Standard Time, Russia Time Zone 10, Russia Time Zone 11, Russia Time Zone 3, Russian Standard Time, SA Eastern Standard Time, SA Pacific Standard Time, SA Western Standard Time, SE Asia Standard Time, Saint Pierre Standard Time, Sakhalin Standard Time, Samoa Standard Time, Sao Tome Standard Time, Saratov Standard Time, Singapore Standard Time, South Africa Standard Time, South Sudan Standard Time, Sri Lanka Standard Time, Sudan Standard Time, Syria Standard Time, Taipei Standard Time, Tasmania Standard Time, Tocantins Standard Time, Tokyo Standard Time, Tomsk Standard Time, Tonga Standard Time, Transbaikal Standard Time, Turkey Standard Time, Turks And Caicos Standard Time, US Eastern Standard Time, US Mountain Standard Time, UTC+12, UTC+13, UTC-02, UTC-08, UTC-09, UTC-11, Ulaanbaatar Standard Time, Venezuela Standard Time, Vladivostok Standard Time, Volgograd Standard Time, W. Australia Standard Time, W. Central Africa Standard Time, W. Europe Standard Time, W. Mongolia Standard Time, West Asia Standard Time, West Bank Standard Time, West Pacific Standard Time, Yakutsk Standard Time, Yukon Standard Time, International Date Line West, Midway Island, American Samoa, Hawaii, Alaska, Pacific Time (US & Canada), Tijuana, Mountain Time (US & Canada), Chihuahua, Mazatlan, Central Time (US & Canada), Saskatchewan, Guadalajara, Mexico City, Monterrey, Central America, Eastern Time (US & Canada), Indiana (East), Bogota, Lima, Quito, Atlantic Time (Canada), Caracas, La Paz, Santiago, Newfoundland, Brasilia, Buenos Aires, Montevideo, Georgetown, Puerto Rico, Greenland, Mid-Atlantic, Azores, Cape Verde Is., Dublin, Edinburgh, Lisbon, London, Casablanca, Monrovia, Belgrade, Bratislava, Budapest, Ljubljana, Prague, Sarajevo, Skopje, Warsaw, Zagreb, Brussels, Copenhagen, Madrid, Paris, Amsterdam, Berlin, Bern, Zurich, Rome, Stockholm, Vienna, West Central Africa, Bucharest, Cairo, Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius, Athens, Istanbul, Minsk, Jerusalem, Harare, Pretoria, Kaliningrad, Moscow, St. Petersburg, Volgograd, Samara, Kuwait, Riyadh, Nairobi, Baghdad, Tehran, Abu Dhabi, Muscat, Baku, Tbilisi, Yerevan, Kabul, Ekaterinburg, Islamabad, Karachi, Tashkent, Chennai, Kolkata, Mumbai, New Delhi, Kathmandu, Dhaka, Sri Jayawardenepura, Almaty, Astana, Novosibirsk, Rangoon, Bangkok, Hanoi, Jakarta, Krasnoyarsk, Beijing, Chongqing, Hong Kong, Urumqi, Kuala Lumpur, Taipei, Perth, Irkutsk, Ulaanbaatar, Seoul, Osaka, Sapporo, Tokyo, Yakutsk, Darwin, Adelaide, Canberra, Melbourne, Sydney, Brisbane, Hobart, Vladivostok, Guam, Port Moresby, Magadan, Srednekolymsk, Solomon Is., New Caledonia, Fiji, Kamchatka, Marshall Is., Auckland, Wellington, Nuku'alofa, Tokelau Is., Chatham Is., Samoa, Arizona	N/A	UTC
value	String	Optional	The string value.	N/A	N/A
warning	String	Optional	If specified, adds a warning message for this macro. This is processed as an NCalc, and the warning message will ALWAYS be present and will be the value of the evaluated NCalc expression.	N/A	N/A
warningAfter	DateTimeOffset	Optional	The macro is considered 'warning' if the output is after this DateTime UTC.	N/A	N/A
warningBefore	DateTimeOffset	Optional	The macro is considered 'warning' if the output is before this DateTime UTC.	N/A	N/A
warningEq	String	Optional	The macro is considered 'warning' if the output is equal to this value.	N/A	N/A
warningFontBackgroundColor	Color	Optional	The warning font background color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
warningFontBold	Boolean	Optional	Change the warning font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
warningFontColor	Color	Optional	The warning font color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
warningFontSize	Double	Optional	Change the warning font size in points. If omitted, no change is made.	From 2 to 200	N/A
warningGe	String	Optional	The macro is considered 'warning' if the output is greater than or equal to this value.	N/A	N/A
warningGt	String	Optional	The macro is considered 'warning' if the output is greater than this value.	N/A	N/A
warningIf	String	Optional	The macro is considered 'warning' if the expression evaluates to true. Use 'value' as the macro output in the expression.	N/A	N/A
warningLe	String	Optional	The macro is considered 'warning' if the output is less than or equal to this value.	N/A	N/A
warningLt	String	Optional	The macro is considered 'warning' if the output is less than this value.	N/A	N/A
warningNe	String	Optional	The macro is considered 'warning' if the output is not equal to this value.	N/A	N/A
warningTableCellBackgroundColor	Color	Optional	The warning table cell background color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
weekDays	List<String>	Optional	The days of week considered working days.	N/A	Monday;​Tuesday;​Wednesday;​Thursday;​Friday

---

Examples (7)

Example 1:

Regular day

This example is in normal work hours, Is in work hours?
[DateTime.IsInWorkHours: value="2019-04-09 12:00:00"]

Outputs:

true

---

Example 2:

Weekend

This example is at a Weekend day, Is in work hours?
[DateTime.IsInWorkHours: value="2019-04-07 12:00:00"]

Outputs:

false

---

Example 3:

Midnight

This example is at midnight, Is in work hours?
[DateTime.IsInWorkHours: value="2019-04-09 00:00:00"]

Outputs:

false

---

Example 4:

Before work starts.

This example is before the startTime, Is in work hours?
[DateTime.IsInWorkHours: value="2019-04-09 06:00:00"]

Outputs:

false

---

Example 5:

Custom workday hours

This example uses custom workday hours, Is in work hours?
[DateTime.IsInWorkHours: value="2019-04-09 10:00:00", startTime=12:00, endTime=15:00]

Outputs:

false

---

Example 6:

Late night.

This example is after the default endTime, Is in work hours?
[DateTime.IsInWorkHours: value="2022-04-09 23:00:00", =>A] [String: value={A}][If:condition={A}=='false'] - not in work hours[Else:] - is in work hours[EndIf:]

Outputs:

false

---

Example 7:

This example sets 2 (weekday) vacation days then checks whether the date chosen falls inside. Note this still considers weekends as non-work days (the default).

This example sets 2 (weekday) vacation days then checks whether the date chosen falls inside. Note this still considers weekends as non-work days (the default).
On Vacation: [DateTime.IsInWorkHours: value=2019-05-29 12:00:00, nonWorkDates=2019-05-29;2019-05-30,storeAsHidden=IsWorking][If:condition={IsWorking}=='false']yes![Else:]no![EndIf:]

Outputs:

true