IFieldDescription Interface

Definition

Describe the information displayed about a field and its values.

public interface IFieldDescription
type IFieldDescription = interface
Public Interface IFieldDescription
Derived

Remarks

Throughout this class Description refers to the name of a field or a value whereas "terms" tell what people can type to match the field or terms in it. When generating terms it is a good idea to include anything that might be reasonable for someone to type. The form dialog itself will help clarify any ambiguity. One way to do this is to use MaxPhrase which ensures that GenerateTerms(String, Int32) is called on your base terms.

Properties

AllowDefault

Allow the default value as an option.

AllowNumbers

Allow user input to match numbers shown with enumerated choices.

AllowsMultiple

Are multiple matches allowed.

FieldDescription

Description of the field itself.

FieldTerms

Terms for matching this field.

Role

Role field plays in a form.

ValueDescriptions

Return all possible value descriptions in order to support enumeration.

Values

All possible values or null if it is a data type like number.

Methods

Terms(Object)

Given a value return terms that can be used in a dialog to match the object.

ValueDescription(Object)

Return the description of a specific value.

Applies to