Simple fields

Note: In this section, the variable fieldName corresponds, in the case of a tag, to the value of its identifier. If this is the component class, use Class.

Some examples:

• Modification of a EndDate tag of type TIMESTAMP:

  // Set value from a Date object
  formAPI.setObjectValue("EndDate",new Date(2016,11,04));
  // Definition based on a timestamp (number of milliseconds elapsed since 01/01/1970)
  formAPI.setObjectValue("EndDate", 0);
  

• Modification of a Received tag of type BOOLEAN:

  // Set the value from a Boolean
  formAPI.setObjectValue("Received",true);
  

• Modification of class identifier:

  formAPI.setObjectValue("Class", "Document");
  

Suggestion of values

To suggest values for a field to the user, you can use the function suggest(fieldName, suggestions).

The suggestions to be passed as parameters are composed of a symbolic name (setValue(symbolicName)) and a label (setName(displayName)). So if the user selects one of the suggestions, the form will be submitted with the symbolic name.

function buildSuggestion(name, value){
	var suggestion = new LookupResult();
	suggestion.setName(name);
	suggestion.setValue(value);
	return suggestion;
}

var suggestions = new Array();	
suggestions[0] = buildSuggestion("name1", "value1");
suggestions[1] = buildSuggestion("name2", "value2");
formAPI.suggest("MailObject", suggestions);

Choice lists

function buildAllowedValue(symbolicName, label) {
	var language = new Language("EN");

	var allowedValue = new AllowedValueDefinition();
	allowedValue.setSymbolicName(symbolicName);

	var displayNames = new I18NLabel()
	displayNames.setLabel(language, label);
	allowedValue.setDisplayNames(displayNames);
	return allowedValue;
}

var restrictedAllowedValues = new Array();
restrictedAllowedValues[0] = buildAllowedValue("symbolicName1", "firstLabel");
restrictedAllowedValues[1] = buildAllowedValue("symbolicName2", "secondLabel");

formAPI.setAllowedValues("BillType", restrictedAllowedValues);

Field status

Several functions can be used to change the status of a field within a form. They are used with the parameters:

• fieldName corresponding to the field identifier
• boolean corresponding to state activation

Example: Changing the visibility of a field in an indexing form

formAPI.setVisible("BillType", false);

Form validity change subscription

Various functions allow you to subscribe to changes in the validity of a form, depending on your needs:

• Validity of the complete form, i.e. fields and content:

  formAPI.registerForValidity(function(isValid, invalidFields, invalidTypes){
  	console.log("Component is valid=" + isValid + ", invalidFields=" + invalidFields + ", invalidTypes=" + invalidTypes);
  })
  

• Partial validity of the form:

This function allows you to subscribe only to the validity of a part of the form, either the fields (FIELDS), or the content (CONTENT).
In the following example, we only subscribe to changes in field validity.

formAPI.registerForPartialValidity("FIELDS", function(isValid, type, invalidFields){
	console.log("Component is valid=" + isValid + ", invalidFields=" + invalidFields + ", type=" + type);
})

The following functions are also available to find out the status of the current form:

List form fields

The formAPI.getFields() function on a form retrieves the list of field identifiers present in the form.

Value change

To provide your users with interactive forms, it is possible to subscribe to changes in the value of a field in order to modify its status or modify another field.

  formAPI.registerForFieldChange("Amount", function(fieldName, fieldValue){
	// Use the new value of a field
  });