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

# TextViolationSettings

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

## Classes

### TextViolationSettings

#### Extends

#### Constructors

##### Constructor

```ts
new TextViolationSettings(defaultValue?): TextViolationSettings;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `defaultValue?` | `boolean` |

###### Returns

[`TextViolationSettings`](#textviolationsettings)

###### Overrides

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

#### Properties

##### allowBleedArea

```ts
allowBleedArea: boolean;
```

###### Inherited from

[`ShapeViolationSettings`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ShapeViolationSettings.md#shapeviolationsettings).[`allowBleedArea`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ShapeViolationSettings.md#allowbleedarea)

##### allowInPlaceText

```ts
allowInPlaceText: boolean;
```

##### allowRegion

```ts
allowRegion: boolean;
```

###### Inherited from

[`ShapeViolationSettings`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ShapeViolationSettings.md#shapeviolationsettings).[`allowRegion`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ShapeViolationSettings.md#allowregion)

##### allowSafetyLines

```ts
allowSafetyLines: boolean;
```

###### Inherited from

[`ShapeViolationSettings`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ShapeViolationSettings.md#shapeviolationsettings).[`allowSafetyLines`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ShapeViolationSettings.md#allowsafetylines)

##### allowShape

```ts
allowShape: boolean;
```

###### Inherited from

[`ShapeViolationSettings`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ShapeViolationSettings.md#shapeviolationsettings).[`allowShape`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ShapeViolationSettings.md#allowshape)

##### allowTextCrop

```ts
allowTextCrop: boolean;
```

##### id

```ts
id: string;
```

###### Inherited from

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

##### type

```ts
type: string = TextViolationSettings.type;
```

###### Overrides

[`ShapeViolationSettings`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ShapeViolationSettings.md#shapeviolationsettings).[`type`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ShapeViolationSettings.md#type)

##### type

```ts
static type: string = "TextViolationSettings";
```

###### Overrides

[`ShapeViolationSettings`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ShapeViolationSettings.md#shapeviolationsettings).[`type`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ShapeViolationSettings.md#type-1)

#### Accessors

##### name

###### Get Signature

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

###### Returns

`string`

###### Set Signature

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

###### Parameters

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

###### Returns

`void`

###### Inherited from

[`ShapeViolationSettings`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ShapeViolationSettings.md#shapeviolationsettings).[`name`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ShapeViolationSettings.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

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

##### version

###### Get Signature

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

###### Returns

`string`

###### Inherited from

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

#### Methods

##### addPropertyChanged()

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

###### Parameters

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

###### Returns

`void`

###### Inherited from

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

##### clone()

```ts
clone(): TextViolationSettings;
```

###### Returns

[`TextViolationSettings`](#textviolationsettings)

###### Overrides

[`ShapeViolationSettings`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ShapeViolationSettings.md#shapeviolationsettings).[`clone`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/ShapeViolationSettings.md#clone)

##### equals()

```ts
equals(p): boolean;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `p` | [`TextViolationSettings`](#textviolationsettings) |

###### Returns

`boolean`

###### Overrides

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

##### generateNewIds()

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

###### Returns

`void`

###### Inherited from

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

##### getSimplifiedObject()

```ts
getSimplifiedObject(omitProperties?): object;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `omitProperties?` | `string` \| `string`[] |

###### Returns

`object`

###### Inherited from

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

##### removePropertyChanged()

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

###### Parameters

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

###### Returns

`void`

###### Inherited from

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

##### toString()

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

Returns a string representation of an object.

###### Returns

`string`

###### Inherited from

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