Class Field

Contains the properties for a field in the data dictionary.

Please note that any changes you make to this item will only be saved in Stonefield Query after you call the Dispose() method.

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

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.

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.

Comment

The comment for the 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.

Format

The format for this field.

Heading

The default column heading for this field in a report.

Length

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

Order

The order the field should appear in a list of fields.

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.

Roles

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

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.

Type

A single character representing the data type of the field:

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.

Requirements

Namespace: SFQWrapper
Assembly: sfqwrapper.dll