Interface IReportField

This represents a field in a report.


public abstract interface IReportField

Interface Members

MemberDescription

BackgroundColor

The background color for the field. If it's null, the background color of the template for the report is used.

Display

True if this field appears in the report; false if it’s only in the result set.

DisplayHeading

The column heading as displayed in the report.

DynamicFormat

True if the effective format for the field is an expression.

EffectiveFormat

The effective format to use for the field.

Field

A reference to the field in the data dictionary.

Font

Specifies the font setting for the field. If it's null, the font for the report template is used.

ForegroundColor

The foreground color for the field. If it's null, the foreground color of the template for the report is used.

Format

The format expression for the field. This is ignored if UseDefaultFormat is true, in which case Field.Format is used instead.

Group

The grouping order for this field.

Heading

The column heading for the field.

ID

The internal ID for the field.

ResultSetFieldName

The name of the field in the result set. It may be different that Field.Name; for example, if there are two fields with the same name.

SelectedTable

The table the field was selected from (may not be the real table but one of AppearsInTable tables).

SortDirection

The sort direction for this field. The default is Ascending.

SortOrder

The sort order for this field; 0 means not sorted.

SummaryType

The type of summarization to do on this field. The default is None.

Tag

This property can contain anything.

UseDefaultFormat

True (the default) to use the formatting of the field in the data dictionary. If false, Format is used.

Requirements

Namespace: Stonefield.Query.ReportEngine
Assembly: interfaces.dll