tsc_EntityFeatures AttributeForm

A class which allows developers to access the internal Survey Core attribute entry forms.

This will use the current job's feature library and allow the user to enter the attribute information for a given set of features.  Existing values can be specified in the constructor which takes an independent copy for later use.

The user will be prompted to enter the attribute information according to the feature library's definitions.  The caller can optionally ask to have the features automatically populated where possible.  It is quite common for no UI to be shown if there is sufficient information already in place.  The user can cancel the operation in which case no changes are returned to the caller.

Public constructors

tsc_EntityFeatures_AttributeForm();

Constructs the form with only default values.

tsc_EntityFeatures_AttributeForm(const tsc_EntityFeatures& existingValues);

Constructs a form with attribute values preset according to the features passed in. These could be from a previous edit or retrieved from a database entity.

Public methods

bool GenerateFromFeatureCodeString(const char* codeString, bool attemptToAutoComplete, tsc_EntityFeatures& result);

Runs the form to generate a new tsc_EntityFeatures that represents the features (and accompanying attributes) contained in the space-delimited list in codeString.

Returns true if all information was retrieved, updating the local copy of existingValues and updating result; if aborted false is returned and result is unchanged.

The existing values passed into the constructor are used wherever possible.

Note that where the attribute information cannot be found in the current library then the form becomes read-only with an error message, and the user can only view the existing values.  true is returned in this special case.