A Field object contains the properties for a field in a report. Since this is a subclass of the Field object, many of the properties are inherited from Field (those that describe the structure of the field). This object has no methods.

Properties

NameData TypeDescription
AllowValues Boolean True if the Values button in Stonefield Query is enabled for this field.
Autofit Boolean True if the Auto-fit column option is turned on.
BackColor Integer The background color for the field; -1 means use the color of the template object.
Bookmark Boolean True if the Create bookmarks on this field option is turned on.
Calculated Boolean 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 String The caption for the field.
Chart Integer The location of the field in the chart: 0 = X axis, 1 = Y axis, 2= Series.
ChartFormat String The format for this field in a chart.
ChartInputMask String The picture for this field in a chart.
ChartOrder Integer The order for this field in the chart: 1 is the first field, 2 the second, and so on.
ChartTotalType String The total type for the field in a chart: "N" = no totaling, "S" = sum, "C" = count, "B" = count distinct, "A" = average, "L" = lowest, "H" = highest, "D" = standard deviation, and "V" = variance.
Comment String The comment for the field.
CursorFieldName String The name of the field as it appears in the result set.
DataTrimming Integer The type of trimming for this field: 0 = default, 1 = trim at the nearest character, 2 = trim at the nearest word, 3 = add an ellipsis at the nearest character, 4 = add an ellipsis at the nearest word, and 5 = add an ellipsis in the middle of the text.
Decimals Numeric The number of places after the decimal.
Exact Boolean 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 String The expression to determine the value of this field if it's a calculated field.
Favorite Boolean True if this is a "favorite" field.
FieldList String 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 String 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 Boolean True if the user can filter on this field.
FontAlign Integer The alignment for the field: 0 = left, 1 = right, and 2 = center.
FontBold Boolean True if this field is bolded.
FontItalic Boolean True if this field is italicized.
FontName String The font for this field in the report; blank means use the template font.
FontSize Integer The font size of the field; -1 means use the template font size.
FontUnderline Boolean True if this field is underlined.
ForeColor Integer The foreground color for the field; -1 means use the color of the template object.
Format String The format for this field.
Group Integer 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 Boolean True if the Show count in group footer option is turned on.
GroupOnOneLine Boolean True if the Place all fields in group header on same line option is turned on.
Heading String The column heading for this field in the report.
HPosition Integer The horizontal position for the field; -1 means use the next available position.
Length Numeric The width of the field, including decimals and one place for the decimal character if there are any decimals.
NewPage Boolean True if the Start each group on a new page option is turned on.
NoGroupFooter Boolean True if the No group footer option is turned on.
NoTotalsForOneRecord Boolean True if the No group footer if only one record in group option is turned on.
Order Integer The order for this field in the report: 1 is the first field, 2 the second, and so on.
Other String Stores user-defined information for the field; Stonefield Query doesn't use this property for anything but your scripts could.
OutputLength Numeric 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 String 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 String The picture for this field.
Reportable Boolean True if the user can report on this field.
ResetPage Boolean True if the Reset page number to 1 option is turned on.
Roles String A comma-delimited list of roles that can access the field (blank means everyone can access it).
ShowPercent Boolean True if the Show percentage of total option is turned on.
Sortable Boolean True if the user can sort on this field.
SQExpression Boolean True if this calculated field uses a Stonefield Query expression; False if the expression is sent as is to the database engine.
Suppress Boolean True if the Suppress repeating values option is turned on.
TotalType String The total type for the field: "N" = no totaling, "S" = sum, "C" = count, "B" = count distinct, "A" = average, "L" = lowest, "H" = highest, "D" = standard deviation, and "V" = variance.
Type String A single character representing the data type of the field:
  • W: Blob
  • C: Character
  • Y: Currency
  • D: Date
  • T: DateTime
  • B: Double
  • G: General
  • I: Integer
  • L: Logical
  • M: Memo
  • N: Numeric
  • V: Varchar
  • Q: Varbinary
UseDefaultFormat Boolean True if the Use default format option is turned on.
UseDefaultFormatForChart Boolean True if the Use default format option is turned on for this field in a chart.
UserDefined String Unless this field is defined as an enumerated field, this property can contain anything you want to place in it.
ValuesMethod String 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 String The version number for the field.
VPosition Integer The vertical position for the field; -1 means use the next available position.
WidthOnReport Integer The width of this field in the report.

See also

Field Object | Field Properties | ReportFields Collection