Share via


WorkPeriodTemplateLine.periodDescription Method

Replaces all placeholders in the periodDescription text field to actual text.

Syntax

public Description periodDescription(
    date _startDate, 
    date _endDate, 
    date _startDateOrEndDate)

Run On

Called

Parameters

  • _startDate
    Type: date
    A date that contains a start date.
  • _endDate
    Type: date
    A date that contains an end date.
  • _startDateOrEndDate
    Type: date

Return Value

Type: Description Extended Data Type
A string with all of the placeholders converted to real values.

Remarks

Example: The field periodDescription contains the text "Week %3". The placeholder %3 will be replaced with the actual week number based on the start date. If the week number is 33 then this method will return the string "Week 33".

See Also

Reference

WorkPeriodTemplateLine Table