# GC.Spread.Sheets.InputMask

## Content

# Namespace: InputMask

[Spread](GC.Spread).[Sheets](GC.Spread.Sheets).InputMask

## Table of contents

### Interfaces

- [INamedPattern](../interfaces/GC.Spread.Sheets.InputMask.INamedPattern)
- [IValidatePatternResult](../interfaces/GC.Spread.Sheets.InputMask.IValidatePatternResult)

### Functions

- [getNamedPatterns](GC.Spread.Sheets.InputMask#getnamedpatterns)
- [namedPattern](GC.Spread.Sheets.InputMask#namedpattern)
- [validatePattern](GC.Spread.Sheets.InputMask#validatepattern)

## Functions

### <a id="getnamedpatterns" name="getnamedpatterns"></a> getNamedPatterns

▸ **getNamedPatterns**(): [`INamedPattern`](../interfaces/GC.Spread.Sheets.InputMask.INamedPattern)[]

Get all named patterns.

**`static`**

#### Returns

[`INamedPattern`](../interfaces/GC.Spread.Sheets.InputMask.INamedPattern)[]

returns all the named patterns.

___

### <a id="namedpattern" name="namedpattern"></a> namedPattern

▸ **namedPattern**(`name`, `pattern?`): `string` \| `void`

Set or get named pattern.

**`static`**

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `name` | `string` | The name of pattern string. |
| `pattern?` | ``null`` \| `string` | - |

#### Returns

`string` \| `void`

if no pattern is set, returns the pattern string of the name, otherwise returns void.

___

### <a id="validatepattern" name="validatepattern"></a> validatePattern

▸ **validatePattern**(`pattern`): [`IValidatePatternResult`](../interfaces/GC.Spread.Sheets.InputMask.IValidatePatternResult)

Verify whether the pattern is valid.

**`static`**

**`example`**
```javascript
let verifyResult = GC.Spread.Sheets.InputMask.validatePattern('[a0_]{8}');
```

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `pattern` | `string` | The pattern string. |

#### Returns

[`IValidatePatternResult`](../interfaces/GC.Spread.Sheets.InputMask.IValidatePatternResult)

returns the verified result.