GetHeading

GetHeading is a text function that obtains text headings from a specified grid.

The function has two syntax:

<<GetHeading("GridName", Page, Reference, Offset)>>

<<GetHeading("GridName", Page, Reference, "Delimiter")>>

Argument	Description
GridName	The name of a grid containing the heading to extract. The Current keyword can also be used.
Page	The numeric value of the page containing the heading. The Current keyword can also be used.
Reference	Reference is a view time reference of the heading to obtain. The Current keyword can also be used. For further information on the Reference syntax see Row, Column, or Cell Reference Arguments.
Offset	Offset applies to a row or column heading with more than one dimension . It is a number representing the dimension in the heading. If you provide a numeric offset, you are returned a single dimension heading. For example, a row heading with 3 dimensions, you can specify (starting from left to right) “1” to return the first dimension, “2” to return the second dimension and “3” to return the third dimension.
"Delimiter"	"Delimiter" is a quoted string that separates all headings from the row or column. If you provide a delimiter, you obtain all headings in the reference, separated by the provided delimiter.

Examples:

Use GetHeading to return column and row headings.

		A(A)	A(B)	A(C)
		Actual	Actual	Actual
		Jan	Feb	Mar
1(1)	Georgia	112	67	73
1(2)	East	5,864	3,322	3,789
1(3)	Market	15,904	9,277	10,640

Type any of these lines for the previous sample grid:

GetHeading Example	Gets or Returns
GetHeading(“Grid1”,1,A,2)	Jan
GetHeading(“Grid1”,1,A(B),2)	Feb
GetHeading(“Grid1”,1,A(C),”-”)	Actual - Mar
GetHeading(“Grid1”,1,1,1)	Georgia
GetHeading(“Grid1”,1,1(2),1)	East
GetHeading(“Grid1”,1,1(2),2	<error> (it is an invalid reference)
GetHeading(“Grid1”,1,1(3),”-”)	Market

Note:

This function only supports the Current keyword when used in a grid cell; not in a text box object, header, footer or otherwise. For information and examples, see Current / Cur Keyword.