Class ReportField

A field that is on a Report. This has all the properties of a Field item plus extra properties that only exist for fields that are on a Report.

System.Object
  SFQWrapper.SQBase
    SFQWrapper.SQItem
      SFQWrapper.Field
        SFQWrapper.ReportField
public class ReportField : Field

Class Members

MemberDescription

Alias

The name of the table the field belongs to.

AllowValues

True if the Values button in Stonefield Query is enabled for this field.

Autofit

True if the Auto-fit column option is turned on.

BackColor

The background color for the field. -1 means use the color of the template object.

Bookmark

True if the Create bookmarks on this field option is turned on.

Calculated

True if this is a calculated field. If the SQExpression property of a calculated field is False, set this property to False as well.

Caption

The caption for the field.

Chart

The location of the field in the chart: X = 0, Y = 1, Series = 2

ChartFormat

The format for the field in a chart.

ChartInputMask

The picture for the field in a chart.

ChartOrder

The order for this field in the chart. 1 is the first field, 2 the second, and so on.

ChartTotalType

The total type for the field in a chart:

Comment

The comment for the field.

CursorFieldName

The name of the field as it appears in the result set.

DataTrimming

The type of trimming for this field:

Decimals

The number of places after the decimal.

ErrorMessage

The message for any error that occurred.

Exact

If this property is True (which it is by default) and the user filters on this field, Stonefield Query adds blanks to the filter value when the "equals" operator is used so the search is exact.

Expression

The expression to determine the value of this field if it's a calculated field.

Favorite

True if this is a "favorite" field.

FieldList

A comma-delimited list of aliased field names used to calculate the value of this field if it's a calculated field. Leave this property blank if SQExpression is False.

FieldName

The aliased name of the field. You don't have to fill in this property because that's done automatically when you add the field to the collection.

Filterable

True if the user can filter on this field.

FontAlign

The alignment for the field:

FontBold

True if this field is bolded.

FontItalic

True if this field is italicized.

FontName

The font for this field in the report. This is blank if the default font for the report is used.

FontSize

The font size of the field. -1 means use the template font size.

FontUnderline

True if this field is underlined.

ForeColor

The foreground color for the field. -1 means use the color of the template object.

Format

The format for this field.

Group

The grouping position for the field: 0 means the field is not grouped, 1 means the first grouped field, and so on. Negative numbers means the field isn't grouped but appears in the group header for the specified positive field number.

GroupCount

True if the Show count in group footer option is turned on.

GroupOnOneLine

True if the Place all fields in group header on same line option is turned on.

Heading

The column heading for this field.

HPosition

The horizontal position for the field. -1 means use the next available position.

Length

The length of the field, including decimals and one place for the decimal character if there are any decimals.

NewPage

True if the Start each group on a new page option is turned on.

NoTotalsForOneRecord

True if the No group footer if only one record in group option is turned on.

Order

The order for this field in the report. 1 is the first field, 2 the second, and so on.

Other

Stores user-defined information for the field; Stonefield Query doesn't use this property for anything but your scripts could.

OutputLength

The output width of the field, including decimals and one place for the decimal character if there are any decimals. You don't have to fill in this property unless it's different than Length.

OutputType

The output data type of the field; see "Type" below for a list of valid data types. You don't have to fill in this property unless it's different than Type. Note setting this doesn't mean Stonefield Query converts the values in the data to the specified type; you are simply informing Stonefield Query what the data type of Expression is.

Picture

The picture for this field.

Reportable

True if the user can report on this field.

ResetPage

True if the Reset page number to 1 option is turned on.

Roles

A comma-delimited list of roles that can access the field (blank means everyone can access it).

ShowPercent

True if the Show percentage of total option is turned on.

Sortable

True if the user can sort on this field.

SQExpression

True if this calculated field uses a Stonefield Query expression; False if the expression is sent as is to the database engine.

Suppress

True if the Suppress repeating values option is turned on.

TotalType

The total type for the field:

Type

A single character representing the data type of the field:

UseDefaultFormat

True if the Use default format option is turned on.

UseDefaultFormatForChart

True if the Use default format option is turned on for this field in a chart.

UserDefined

Unless this field is defined as an enumerated field, this property can contain anything you want to place in it.

ValuesMethod

The expression to use to display the unique values for this field. This should normally be left alone unless you need to do some specific processing to display the list of values.

Version

The version number for the field.

VPosition

The vertical position for the field. -1 means use the next available position.

Width

The width of this field in the report.

WidthOnReport

The width of this field in the report.

Requirements

Namespace: SFQWrapper
Assembly: sfqwrapper.dll