Skip to main content

Custom Function: Year to Date Check

  • Updated

Custom Function: Year to Date Check

This Custom Function must be implemented by a system administrator before it can be used in a report. Contact the System Administrator for more information.

Returns true if the provided date value is within this year to date, otherwise returns false.

light bulb

This function is intended to be used for conditional aggregates. If one wanted to calculate the sum of one data field within the bounds of this year to date, they would use this structure:

=AggSum( If( YTDCheck( {dateField} ), {fieldToSum}, 0))

Arguments

1. dateValue – A date, dateTime, or date string that will be inspected to see if it is within this year to date.

Program Code

//create return value and grab user input
bool retVal = false;
DateTime myDate = DateTime.Parse(args[0].ToString());

//return true if input date is within this YTD
DateTime firstDay = new DateTime(DateTime.Today.Year, 1, 1);
if(myDate >= firstDay && myDate <= DateTime.Today)
{
  retVal = true;
}
return retVal;

Related articles