Class DataValidation

  • DataValidation objects define requirements for user input in Google Forms, such as specific data types or value ranges.

  • These validations can be applied to form items like text fields to ensure data integrity and guide user responses.

  • getHelpText() retrieves the message displayed to the user when input fails validation, aiding in understanding errors.

DataValidation

The base DataValidation that contains properties common to all validations, such as help text. Validations can be added to certain Form items.

 // Add a text item to a form and require it to be a number within a range.
 var textItem = form.addTextItem().setTitle('Pick a number between 1 and 100?');
 var textValidation = FormApp.createTextValidation()
   .setHelpText(Input was not a number between 1 and 100.)
   .requireNumberBetween(1, 100);
 textItem.setValidation(textValidation);
 

Methods

MethodReturn typeBrief description
getHelpText()StringGets the DataValidation's help text.

Detailed documentation

getHelpText()

Gets the DataValidation's help text. This text is shown to the user if the input fails validation.

Return

String — the DataValidation's help text