A Field object contains the properties for a field in the data dictionary. This object has no methods.
Properties
All properties are read-write.
Name | Data Type | Description |
---|---|---|
AllowValues | Boolean | True if the Values button in Stonefield Query is enabled for this field. |
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. |
Comment | String | The comment for the field. |
Decimals | Numeric | The number of places after the decimal. |
DefaultSummary | String | The default summary type for the field. The values are blank (none), "C" (count), "B" (count distinct), "S" (sum), "A" (average), "L" (lowest), and "H" (highest). |
DisplayExpression | String | The expression used to display the value for the field. |
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. |
Format | String | The format for this field. |
Heading | String | The default column heading for this field in a report. |
Length | Numeric | The width of the field, including decimals and one place for the decimal character if there are any decimals. |
Order | Integer | The order for this field in the table: 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. |
Roles | String | A comma-delimited list of roles that can access the field (blank means everyone can access it). |
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. |
Type | String | A single character representing the data type of the field:
|
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. |
See also
Fields Collection | Field Properties© Stonefield Software Inc., 2024 • Updated: 12/21/18
Comment or report problem with topic