---
title: "InStringPlaceholder | Customer's Canvas On-Premises"
canonical: "https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/InStringPlaceholder/"
---

# InStringPlaceholder

> - [`ModelComponent`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#abstract-modelcomponent)

## Classes

### InStringPlaceholder

#### Extends

#### Implements

- [`IInStringPlaceholder`](#iinstringplaceholder)
- [`IEqualsReady`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Utils-2.md#iequalsready)

#### Constructors

##### Constructor

```ts
new InStringPlaceholder(
   id?, 
   name?, 
   mask?, 
   value?, 
   values?): InStringPlaceholder;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `id?` | `string` |
| `name?` | `string` |
| `mask?` | `string` |
| `value?` | `string` |
| `values?` | `string`[] |

###### Returns

[`InStringPlaceholder`](#instringplaceholder)

###### Overrides

[`ModelComponent`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#abstract-modelcomponent).[`constructor`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#constructor)

#### Properties

##### id

```ts
id: string;
```

###### Implementation of

[`IInStringPlaceholder`](#iinstringplaceholder).[`id`](#id-1)

###### Inherited from

[`ModelComponent`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#abstract-modelcomponent).[`id`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#id)

#### Accessors

##### mask

###### Get Signature

```ts
get mask(): string;
```

###### Returns

`string`

###### Set Signature

```ts
set mask(value): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `value` | `string` |

###### Returns

`void`

###### Implementation of

[`IInStringPlaceholder`](#iinstringplaceholder).[`mask`](#mask-1)

##### name

###### Get Signature

```ts
get name(): string;
```

###### Returns

`string`

###### Set Signature

```ts
set name(value): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `value` | `string` |

###### Returns

`void`

###### Implementation of

[`IInStringPlaceholder`](#iinstringplaceholder).[`name`](#name-1)

###### Inherited from

[`ModelComponent`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#abstract-modelcomponent).[`name`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#name)

##### tags

###### Get Signature

```ts
get tags(): object;
```

###### Returns

`object`

###### Set Signature

```ts
set tags(value): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `value` | \{ \[`key`: `string`\]: `any`; \} |

###### Returns

`void`

###### Inherited from

[`ModelComponent`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#abstract-modelcomponent).[`tags`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#tags)

##### value

###### Get Signature

```ts
get value(): string;
```

###### Returns

`string`

###### Set Signature

```ts
set value(value): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `value` | `string` |

###### Returns

`void`

###### Implementation of

[`IInStringPlaceholder`](#iinstringplaceholder).[`value`](#value-1)

##### values

###### Get Signature

```ts
get values(): string[];
```

###### Returns

`string`[]

###### Set Signature

```ts
set values(values): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `values` | `string`[] |

###### Returns

`void`

###### Implementation of

[`IInStringPlaceholder`](#iinstringplaceholder).[`values`](#values-1)

##### version

###### Get Signature

```ts
get version(): string;
```

###### Returns

`string`

###### Inherited from

[`ModelComponent`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#abstract-modelcomponent).[`version`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#version)

#### Methods

##### addPropertyChanged()

```ts
addPropertyChanged(listener): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `listener` | (`sender`, `eventArgs`) => `void` |

###### Returns

`void`

###### Inherited from

[`ModelComponent`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#abstract-modelcomponent).[`addPropertyChanged`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#addpropertychanged)

##### clone()

```ts
clone(generateNewIds?): InStringPlaceholder;
```

###### Parameters

| Parameter | Type | Default value |
| ------ | ------ | ------ |
| `generateNewIds` | `boolean` | `false` |

###### Returns

[`InStringPlaceholder`](#instringplaceholder)

##### equals()

```ts
equals(other): any;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `other` | [`InStringPlaceholder`](#instringplaceholder) |

###### Returns

`any`

###### Implementation of

[`IEqualsReady`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Utils-2.md#iequalsready).[`equals`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Utils-2.md#equals)

###### Overrides

[`ModelComponent`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#abstract-modelcomponent).[`equals`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#equals)

##### generateNewIds()

```ts
generateNewIds(): void;
```

###### Returns

`void`

###### Overrides

[`ModelComponent`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#abstract-modelcomponent).[`generateNewIds`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#generatenewids)

##### getSimplifiedObject()

```ts
getSimplifiedObject(): IInStringPlaceholder;
```

###### Returns

[`IInStringPlaceholder`](#iinstringplaceholder)

###### Overrides

[`ModelComponent`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#abstract-modelcomponent).[`getSimplifiedObject`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#getsimplifiedobject)

##### removePropertyChanged()

```ts
removePropertyChanged(listener): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `listener` | (`sender`, `eventArgs`) => `void` |

###### Returns

`void`

###### Inherited from

[`ModelComponent`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#abstract-modelcomponent).[`removePropertyChanged`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#removepropertychanged)

##### toString()

```ts
toString(): string;
```

Returns a string representation of an object.

###### Returns

`string`

###### Inherited from

[`ModelComponent`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#abstract-modelcomponent).[`toString`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ModelComponent.md#tostring)

## Interfaces

### IInStringPlaceholder

#### Properties

##### id

```ts
id: string;
```

##### mask

```ts
mask: string;
```

##### name

```ts
name: string;
```

##### value

```ts
value: string;
```

##### values

```ts
values: string[];
```