ResultListDisplayColumn

<< Click to Display Table of Contents >>

Navigation:  Support > Reconfigurable Rulebook > Definition Objects >

ResultListDisplayColumn

Description

A ResultListFormatDetail is a child object of ResultListFormatDetail.

Defines one column within a Result List Format table. Which includes the header, body, and footer values. Also includes logic to dynamically determine when the column is shown, or not shown.

Field Interpolation

An Field Interpolated string is a string that contains field name interpolation expressions. When an interpolated string is resolved to a result string, the compiler replaces items with field name interpolation expressions by the string values.

A field name interpolation expression is a field name surrounded by curly brackets. For example "{DisplayName}" or "{Prone}."

Definition

Property Name

Type

Description

Header

String

The text to display in the header cell of this column. Text is not interpolated.

Not required. Recommended. Default value is an empty string.

BodyValues

List of ResultListCellValues

Specifies the text, specific class set, and link to options in each line in this column.

Each item in the list defines a new line.

Most Columns only define a single line to display.

ChildValues

List of ResultListCellValues

Specifies the text, specific class set, and link to options in each line in this column's child cells.

Each item in the list, represents a different line.

Most Columns only define a single line to display.

If ChildValues are not specified .BodyValues is used instead.

Footer

String

The text to display in the header cell of this column. Text is not interpolated.

Not required. Recommended. Default value is an empty string.

ShowWhen

ShowWhen

Logic to determine when this column should be shown.

Default is to always show the column.

ClassSet

List of ClassSet objects

A list of Name (css class) to decorate each cell within this column, and ShowWhen objects to determine when it should be included.

While any css class value may be used, the common values are:

rlf-col-event

rlf-col-gap

rlf-col-matchinfo

rlf-col-participant

rlf-col-rank

rlf-col-remark

rlf-col-round

rlf-col-stage

rlf-col-string

rlf-col-series

rlf-col-shot

rlf-col-spanning

rlf-col-squadding

Not required. Default value is an empty list.

Spanning

ResultListCellValue

Text, with field interpolation, to display accress multiple columns, starting at this column.

Only one ResultListDisplayColumn may have a value for Spanning.

ShowSpanningWhen

ShowWhen

Logic to determine when the Spanning text is displayed.

In order for the Spanning text to be displayed, both this columns .ShowWhen and .ShowSpanningWhen must evaluate to true.

Default is to always show the Spanning text.

Body

Use BodyValues instead.

String

The default text to display, with field interpolation, in each cell.

The value of Body will always be displayed in a body row. If Child is null, the value of Body is always displayed in the child rows.

Interpolation fields are defined in the ResultListFormat's Fields section.

Not required. Recommended. Default value is an empty string.

BodyLinkTo

Use BodyValues instead.

String enum LinkToOption

What, if anything, the text in this cell should link to.

Not required, default value is None.

Child

Use ChildValues instead.

String

Text, with field interpolation, to display in each cell in a child row.

If Child is null or an empty string, the value of Body is displayed in its place.

Interpolation fields are defined in the ResultListFormat's Fields section.

Not required. Default value is an empty string.