Interface IField

The interface for Field.


public abstract interface IField

Interface Members

MemberDescription

SetFieldList

Adds the fields IDs in the specified array to FieldList.

public void SetFieldList(String[] fields);

AllowValues

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

AppearsInTables

A list of the tables this field appears to belong to.

Caption

The caption for the field as displayed in Stonefield Query dialogs.

Comments

Comments for the field.

ContentType

What type of content a field contains; one of the Stonefield.Query.DataDictionary.ContentTypes enum values.

DataSources

A set of data sources this field is avaiable in (empty if it's available in all data sources).

DataType

The ADO.Net data type of the field.

DefaultSummaryType

The default summary type to use in a report; one of the Stonefield.Query.ReportEngine.SummaryTypes enum values.

DisplayCaption

The caption as displayed to the user.

DisplayHeading

The default heading as displayed to the user.

EffectiveDataType

The data type for this field in the result set.

Favorite

True if this is a favorite field.

FieldList

A list of fields used to calculate the value of or value convert this field.

FieldName

The unaliased name of the field.

Filterable

True if the user can filter on this field.

Format

The format for this field; this can be an expression if surrounded with braces.

Heading

The default column heading for this field in a report.

IgnoreTimeComponent

True to ignore the time component of datetime values.

Order

The order for this field in the table.

OutputDataType

The data type for this field in the result set.

PluginData

Contains anything a plugin requires.

Reportable

True if the user can report on this field.

Roles

The roles that can access the field.

Sortable

True if the user can sort on this field.

Table

A reference to the Stonefield.Query.DataDictionary.ITable the field belongs to.

Tenant

The tenant the field belongs to.

ValueConverter

Specifies the name for a plugin value converter to convert values between what the user sees and what's actually in the database.

ValuesMethod

The name of the plugin used to retrieve distinct values for this field; empty to use a SQL statement.

Requirements

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