tsc_AttributeEntryMode

This enumeration is present in each attribute member of a Feature Library.  It controls whether a value should or may be entered by the user.

These behaviours are implemented by the standard Survey Core attribute entry form.  If a plugin implements its own attribute entry fields which are under control of a feature library, then the entry mode should be enforced as described below.

enum tsc_AttributeEntryMode

{

    tsc_AttributeOptional,

    tsc_AttributeRequired,

    tsc_AttributeOfficeUseOnly,

    tsc_AttributeAutoGenerate

};

Members

tsc_AttributeOptional

The entry of the attribute value is optional.  If the user does not enter a value, the attribute's default value will be used.

tsc_AttributeRequired

The entry of the attribute value is required.  The entry field should be initialised with the default value from the library attribute.

tsc_AttributeOfficeUseOnly

The entry of the attribute value is not permitted, although it may be displayed to the user.  The attribute's value should be set to the default value from the library attribute.

tsc_AttributeAutoGenerate

The value of the attribute is automatically generated and displayed to the user.  Whether or not the value may be modified by the user is controlled by the plugin.  The API will handle the auto-generation part; the DefaultValue method of the subclass of tsc_LibraryAttribute will supply the correct value.