TextValidationBuilder

A DataValidationBuilder for a `https://developers.google.com/apps-script/reference/forms/text-validation`.

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

### Methods

| Method | Return type | Brief description |
|---|---|---|
| `https://developers.google.com/apps-script/reference/forms/text-validation-builder#requireNumber()` | `https://developers.google.com/apps-script/reference/forms/text-validation-builder#` | Requires text item to be a number. |
| `https://developers.google.com/apps-script/reference/forms/text-validation-builder#requireNumberBetween(Number,Number)` | `https://developers.google.com/apps-script/reference/forms/text-validation-builder#` | Requires text item to be a number between start and end, inclusive. |
| `https://developers.google.com/apps-script/reference/forms/text-validation-builder#requireNumberEqualTo(Number)` | `https://developers.google.com/apps-script/reference/forms/text-validation-builder#` | Requires text item to be a number equal to value specified. |
| `https://developers.google.com/apps-script/reference/forms/text-validation-builder#requireNumberGreaterThan(Number)` | `https://developers.google.com/apps-script/reference/forms/text-validation-builder#` | Requires text item to be a number greater than the value specified. |
| `https://developers.google.com/apps-script/reference/forms/text-validation-builder#requireNumberGreaterThanOrEqualTo(Number)` | `https://developers.google.com/apps-script/reference/forms/text-validation-builder#` | Requires text item to be a number greater than or equal to the value specified. |
| `https://developers.google.com/apps-script/reference/forms/text-validation-builder#requireNumberLessThan(Number)` | `https://developers.google.com/apps-script/reference/forms/text-validation-builder#` | Requires text item to be a number less than the value specified. |
| `https://developers.google.com/apps-script/reference/forms/text-validation-builder#requireNumberLessThanOrEqualTo(Number)` | `https://developers.google.com/apps-script/reference/forms/text-validation-builder#` | Requires text item to be a number less than or equal to the value specified. |
| `https://developers.google.com/apps-script/reference/forms/text-validation-builder#requireNumberNotBetween(Number,Number)` | `https://developers.google.com/apps-script/reference/forms/text-validation-builder#` | Requires text item to be a number not between start and end, inclusive. |
| `https://developers.google.com/apps-script/reference/forms/text-validation-builder#requireNumberNotEqualTo(Number)` | `https://developers.google.com/apps-script/reference/forms/text-validation-builder#` | Requires text item to be a number not equal to the value specified. |
| `https://developers.google.com/apps-script/reference/forms/text-validation-builder#requireTextContainsPattern(String)` | `https://developers.google.com/apps-script/reference/forms/text-validation-builder#` | Requires response to contain pattern. |
| `https://developers.google.com/apps-script/reference/forms/text-validation-builder#requireTextDoesNotContainPattern(String)` | `https://developers.google.com/apps-script/reference/forms/text-validation-builder#` | Requires response to not contain pattern. |
| `https://developers.google.com/apps-script/reference/forms/text-validation-builder#requireTextDoesNotMatchPattern(String)` | `https://developers.google.com/apps-script/reference/forms/text-validation-builder#` | Requires response to not match pattern. |
| `https://developers.google.com/apps-script/reference/forms/text-validation-builder#requireTextIsEmail()` | `https://developers.google.com/apps-script/reference/forms/text-validation-builder#` | Requires text item to be an email address. |
| `https://developers.google.com/apps-script/reference/forms/text-validation-builder#requireTextIsUrl()` | `https://developers.google.com/apps-script/reference/forms/text-validation-builder#` | Requires text item to be a URL. |
| `https://developers.google.com/apps-script/reference/forms/text-validation-builder#requireTextLengthGreaterThanOrEqualTo(Integer)` | `https://developers.google.com/apps-script/reference/forms/text-validation-builder#` | Requires response length to be greater than or equal to value. |
| `https://developers.google.com/apps-script/reference/forms/text-validation-builder#requireTextLengthLessThanOrEqualTo(Integer)` | `https://developers.google.com/apps-script/reference/forms/text-validation-builder#` | Requires response length to be less than value. |
| `https://developers.google.com/apps-script/reference/forms/text-validation-builder#requireTextMatchesPattern(String)` | `https://developers.google.com/apps-script/reference/forms/text-validation-builder#` | Requires response to match pattern. |
| `https://developers.google.com/apps-script/reference/forms/text-validation-builder#requireWholeNumber()` | `https://developers.google.com/apps-script/reference/forms/text-validation-builder#` | Requires text item to be a whole number. |

## Detailed documentation

### `requireNumber()`

Requires text item to be a number.

#### Return


`https://developers.google.com/apps-script/reference/forms/text-validation-builder#` --- this `https://developers.google.com/apps-script/reference/forms/text-validation`, for chaining

*** ** * ** ***

### `requireNumberBetween(start, end)`

Requires text item to be a number between start and end, inclusive.

#### Parameters

| Name | Type | Description |
|---|---|---|
| `start` | `Number` | the lower bounds of the inclusive range |
| `end` | `Number` | the upper bounds of the inclusive range |

#### Return


`https://developers.google.com/apps-script/reference/forms/text-validation-builder#` --- this `https://developers.google.com/apps-script/reference/forms/text-validation`, for chaining

*** ** * ** ***

### `requireNumberEqualTo(number)`

Requires text item to be a number equal to value specified.

#### Parameters

| Name | Type | Description |
|---|---|---|
| `number` | `Number` | the value which the item must be equal to. |

#### Return


`https://developers.google.com/apps-script/reference/forms/text-validation-builder#` --- this `https://developers.google.com/apps-script/reference/forms/text-validation`, for chaining

*** ** * ** ***

### `requireNumberGreaterThan(number)`

Requires text item to be a number greater than the value specified.

#### Parameters

| Name | Type | Description |
|---|---|---|
| `number` | `Number` | the value which the item must be greater than. |

#### Return


`https://developers.google.com/apps-script/reference/forms/text-validation-builder#` --- this `https://developers.google.com/apps-script/reference/forms/text-validation`, for chaining

*** ** * ** ***

### `requireNumberGreaterThanOrEqualTo(number)`

Requires text item to be a number greater than or equal to the value specified.

#### Parameters

| Name | Type | Description |
|---|---|---|
| `number` | `Number` | the value which the item must be greater than or equal to. |

#### Return


`https://developers.google.com/apps-script/reference/forms/text-validation-builder#` --- this `https://developers.google.com/apps-script/reference/forms/text-validation`, for chaining

*** ** * ** ***

### `requireNumberLessThan(number)`

Requires text item to be a number less than the value specified.

#### Parameters

| Name | Type | Description |
|---|---|---|
| `number` | `Number` | the value which the item must be greater than. |

#### Return


`https://developers.google.com/apps-script/reference/forms/text-validation-builder#` --- this `https://developers.google.com/apps-script/reference/forms/text-validation`, for chaining

*** ** * ** ***

### `requireNumberLessThanOrEqualTo(number)`

Requires text item to be a number less than or equal to the value specified.

#### Parameters

| Name | Type | Description |
|---|---|---|
| `number` | `Number` | the value which the item must be less than or equal to. |

#### Return


`https://developers.google.com/apps-script/reference/forms/text-validation-builder#` --- this `https://developers.google.com/apps-script/reference/forms/text-validation`, for chaining

*** ** * ** ***

### `requireNumberNotBetween(start, end)`

Requires text item to be a number not between start and end, inclusive.

#### Parameters

| Name | Type | Description |
|---|---|---|
| `start` | `Number` | the lower bounds of the inclusive range |
| `end` | `Number` | the upper bounds of the inclusive range |

#### Return


`https://developers.google.com/apps-script/reference/forms/text-validation-builder#` --- this `https://developers.google.com/apps-script/reference/forms/text-validation`, for chaining

*** ** * ** ***

### `requireNumberNotEqualTo(number)`

Requires text item to be a number not equal to the value specified.

#### Parameters

| Name | Type | Description |
|---|---|---|
| `number` | `Number` | the value which the item must not be equal to. |

#### Return


`https://developers.google.com/apps-script/reference/forms/text-validation-builder#` --- this `https://developers.google.com/apps-script/reference/forms/text-validation`, for chaining

*** ** * ** ***

### `requireTextContainsPattern(pattern)`

Requires response to contain pattern.

#### Parameters

| Name | Type | Description |
|---|---|---|
| `pattern` | `String` | text must contain pattern |

#### Return


`https://developers.google.com/apps-script/reference/forms/text-validation-builder#` --- this for chaining

*** ** * ** ***

### `requireTextDoesNotContainPattern(pattern)`

Requires response to not contain pattern.

#### Parameters

| Name | Type | Description |
|---|---|---|
| `pattern` | `String` | text must not contain pattern |

#### Return


`https://developers.google.com/apps-script/reference/forms/text-validation-builder#` --- this for chaining

*** ** * ** ***

### `requireTextDoesNotMatchPattern(pattern)`

Requires response to not match pattern.

#### Parameters

| Name | Type | Description |
|---|---|---|
| `pattern` | `String` | text must not match pattern |

#### Return


`https://developers.google.com/apps-script/reference/forms/text-validation-builder#` --- this for chaining

*** ** * ** ***

### `requireTextIsEmail()`

Requires text item to be an email address.

#### Return


`https://developers.google.com/apps-script/reference/forms/text-validation-builder#` --- this `https://developers.google.com/apps-script/reference/forms/text-validation`, for chaining

*** ** * ** ***

### `requireTextIsUrl()`

Requires text item to be a URL.

#### Return


`https://developers.google.com/apps-script/reference/forms/text-validation-builder#` --- this `https://developers.google.com/apps-script/reference/forms/text-validation`, for chaining

*** ** * ** ***

### `requireTextLengthGreaterThanOrEqualTo(number)`

Requires response length to be greater than or equal to value.

#### Parameters

| Name | Type | Description |
|---|---|---|
| `number` | `Integer` | paragraph text length must be greater than this value |

#### Return


`https://developers.google.com/apps-script/reference/forms/text-validation-builder#` --- this for chaining

*** ** * ** ***

### `requireTextLengthLessThanOrEqualTo(number)`

Requires response length to be less than value.

#### Parameters

| Name | Type | Description |
|---|---|---|
| `number` | `Integer` | paragraph text length must be less than or equal to this value |

#### Return


`https://developers.google.com/apps-script/reference/forms/text-validation-builder#` --- this for chaining

*** ** * ** ***

### `requireTextMatchesPattern(pattern)`

Requires response to match pattern.

#### Parameters

| Name | Type | Description |
|---|---|---|
| `pattern` | `String` | text must match pattern |

#### Return


`https://developers.google.com/apps-script/reference/forms/text-validation-builder#` --- this for chaining

*** ** * ** ***

### `requireWholeNumber()`

Requires text item to be a whole number.

#### Return


`https://developers.google.com/apps-script/reference/forms/text-validation-builder#` --- this `https://developers.google.com/apps-script/reference/forms/text-validation`, for chaining