|
Macros |
Syntax:
<#macro name="macro name"/>
Macros let the application substitute some information in the place of macro.
Parameters of any macro:
length="0..x" // minimum length (default 0)
alignment="Left|Right|Center" // text alignment (default Left)
Parameters of any date and time macro:
datetype="Long|Short|Custom" // default Short
showdate="True|False" // default True. Used only if datetype <> "Custom".
showtime="True|False" // default True. Used only if datetype <> "Custom".
showseconds="True|False" // defaults to application settings. Used only if datetype <> "Custom".
format="XX" // Used only if datetype = "Custom". XX - Date/Time format strings control the formatting of dates and times.
Available names of macros:
| • | name="UserName" |
Inserts a name of the current user.
| • | name="TotalFirstDateTime" |
| • | name="TotalLastDateTime" |
The beginning and the end of the report interval.
| • | name="TotalTimeLength" |
Length of the report interval (in hours, minutes, seconds).
Parameters:
mode="Full|HideSeconds|DecimalsOfHour|RoundUp5Min|RoundUp10Min|RoundUp15Min|RoundUp20Min|RoundUp30Min|RoundUpHour"
| • | name="TotalProjects" |
Total of projects in the report.
| • | name="PageCount" |
Total of pages of the report.
| • | name="PageNumber" |
Page number. It is possible to get the number of the previous page by specifying offset="-1" or the following page by specifying offset="1". The returned number will always be between 1 and PageCount.
Parameters:
offset="XX" // XX - positive or the negative offset added to current page number.
| • | name="FileName" |
The filename the report is saved to.
By specifying the offset parameter, it is possible to get the name of the following or previous page.
Parameters:
offset="XX" // XX - positive or the negative offset added to the current page number.
Macros operational in Projects loop only:
| • | name="ProjectUID" |
Unique identifier of the current project.
| • | name="ProjectNumber" |
Serial number of the current project.
| • | name="ProjectName" |
Name of the current project.
| • | name="ProjectDesc" |
The description of the current project.
| • | name="ProjectFirstDateTime" |
| • | name="ProjectLastDateTime" |
The beginning and the end of the report interval.
| • | name="ProjectTimeLength" |
Length of the interval (in hours, minutes, seconds) of the report.
Parameters:
mode="Full|HideSeconds|DecimalsOfHour|RoundUp5Min|RoundUp10Min|RoundUp15Min|RoundUp20Min|RoundUp30Min|RoundUpHour"
| • | name="ProjectDuration" |
Project duration (in seconds).
Macros operational in Tasks loop only:
| • | name="TaskUID" |
Unique identifier of the current task.
| • | name="TaskOwnerUID" |
Unique identifier of the parent of the current task.
| • | name="TaskNumber" |
Serial number of the current task.
| • | name="TaskName" |
type="Short|Full" // default Full
Name of the current task.
| • | name="TaskDesc" |
The description of the current task.
| • | name="TaskFirstDateTime" |
| • | name="TaskLastDateTime" |
The beginning and the end of the task interval.
| • | name="TaskTimeLength" |
Length of the task interval (in hours, minutes, seconds).
Parameters:
mode="Full|HideSeconds|DecimalsOfHour|RoundUp5Min|RoundUp10Min|RoundUp15Min|RoundUp20Min|RoundUp30Min|RoundUpHour"
incchild="True|False" // default = TRUE
| • | name="TaskDuration" |
Task duration (in seconds).
Macros operational in Periods loop only:
| • | name="PeriodUID" |
Unique identifier of the current period.
| • | name="PeriodNumber" |
Serial number of the current period.
| • | name="PeriodDesc" |
The description of the current period.
| • | name="PeriodBeginDateTime" |
| • | name="PeriodEndDateTime" |
The beginning and the end of the period interval.
| • | name="PeriodLength" |
Period length (in hours, minutes, seconds).
Parameters:
showseconds="True|False" // defaults to application settings
| • | name="PeriodDuration" |
Period duration (in seconds).
For example:
<#macro name="PeriodLength" length="20" alignment="Center"/>
See also: