C01 - Column Value (Reports & Settings Report Generator variable)

From Catalyst
Jump to: navigation, search

Syntax

C01{C/0-8 B/H/T 0-9999, xxx, N/T}

Description

Get the current value, or running total, of the cell specified by the variable number and parameters given.

The column number of the cell to take the value from is given by the variable number itself: C01 retrieves the value from column 1; C12 retrieves the value from column 12, etc.

C1{1}
Will get the running total for body cell column 1, row 1, since the last occurrence of group 1 totals.
C1{0}
Will get the running total for body cell column 1, row 1, since the report commenced.
C1 or C1{C}
Will get:
  • In a body cell; the current value of body cell column 1, row 1.
  • In a group 2 totals cell; the running total for the body cells in column 1, row 1, since the last occurrence of group 2 totals.
C1{3T}
Will get the running total for group 3 total cell column 1, row 1, since the last occurrence of group 2 totals.
C1{CT}
Will get the value of total cell column 1, row 1, within the current total block.
C1{CT,,T}
Will get the text value of total cell column 1, row 1, within the current total block.
C12{0T2,ABC}
Will get the grand total from cell column 12, row 2, from a preceding report, named "ABC".


Parameters

C/0-8
A text parameter that can be omitted (it defaults to "C").
Specifies the type of value to get.
C
Get the current value.
0-8
Get the running total in the given group number. The running total is the total in that group since the totals for that group were last output. Group 0 is the grand-totals group that is output only once, at the end of the report.
B/H/T
A text parameter that can be omitted (it defaults to "B").
Specifies the type of cell to get the value of.
B
Get the value from a body cell.
H
Get the value from a group-heading cell.
T
Get the value from a group-total cell.
0-9999
A numeric parameter that can be omitted (it defaults to "1").
Specifies the row number of the cell to get the value of.
0
Get the value from the current row.
1-9999
Get the value from the given row number.
xxx
A text parameter that can be omitted.
When a group of reports are being output together, this parameter can specify the three-character code of one of the preceding reports in the group, to get the value from that report.
Only the grand totals of a preceding report are available, therefore parameter C/0-8 must specify group 0.
N/T
A text parameter that can be omitted (it defaults to "N").
Specifies the type of value to get.
N
Get the numeric value.
T
Get the text value.
For text values, the group specified by parameter C/0-8 is ignored; only the current cell value can be retrieved.


Returns

A text or numeric (depending on the parameters) value whose typical size is 10 characters.