Set Custom Table Header Cell    

Sets a header for one or more consecutive columns in a table.

 

Input Arguments

 

0

Collection Object Name

Table Name

The name of the table to which a header cell should be added.

1

Integer

Row

The row for the header cell.

2

Integer

Column

The column for the header cell.

3

String

Header Text

The text to place in the header cell.

4

Alignment Type

Alignment

The alignment for the text in the cell.

5

Integer

Span

The number of columns the cell should span.

 

Return Arguments

None.

 

Returned Status

 

SUCCESS

The cell was set successfully.

FAILURE

The specified table was not found.

 

Remarks

Unlike Set Custom Table Header Row, this command is intended to be used to define the header for a single column and the width of the text is considered in determining the resulting width of the column. The step can also be used to span the entire width of the table. To do so enter (-1) in the A5 (Span).

The header will be repeated on successive pages of the table when viewed in an SA Report. Multiple consecutive rows of headers are allowed.

If a row of table headers is added to a table that is not contiguous with a previous header, that row becomes the new header for the remainder of the table.