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

# ITextEditorController

> Manages a text editor (TextWhizz or mobile versions).

## Interfaces

### ITextEditorController

#### Properties

##### activeTextEditor

```ts
activeTextEditor: ITextEditor;
```

##### canRedo

```ts
canRedo: boolean;
```

##### canUndo

```ts
canUndo: boolean;
```

##### enteredEditModeEvent

```ts
enteredEditModeEvent: EventWithSenderArg<TextEditorController, unknown>;
```

##### exitedEditModeEvent

```ts
exitedEditModeEvent: EventWithSenderArg<TextEditorController, unknown>;
```

##### failed

```ts
failed: boolean;
```

##### isActive

```ts
isActive: boolean;
```

##### isCropped

```ts
isCropped: boolean;
```

##### isInEdit

```ts
isInEdit: boolean;
```

##### isMobile

```ts
isMobile: boolean;
```

##### isStatic

```ts
isStatic: boolean;
```

##### ready

```ts
ready: boolean;
```

#### Methods

##### bindToCanvas()

```ts
bindToCanvas(canvas): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `canvas` | [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas) |

###### Returns

`void`

##### clearText()

```ts
clearText(): void;
```

###### Returns

`void`

##### dispose()

```ts
dispose(): any;
```

###### Returns

`any`

##### enterEditMode()

```ts
enterEditMode(x, y): Promise<void>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `x` | `number` |
| `y` | `number` |

###### Returns

[`Promise`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/finally.md#promise)\<`void`\>

##### exitEditMode()

```ts
exitEditMode(isStayActive): Promise<void>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `isStayActive` | `boolean` |

###### Returns

[`Promise`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/finally.md#promise)\<`void`\>

##### initialize()

```ts
initialize(): Promise<void>;
```

###### Returns

[`Promise`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/finally.md#promise)\<`void`\>

##### measureText()

```ts
measureText(extendToBlackBox?): RectangleF;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `extendToBlackBox?` | `boolean` |

###### Returns

`RectangleF`

##### measureTextFrame()

```ts
measureTextFrame(): RectangleF;
```

###### Returns

`RectangleF`

##### processKeyEvent()

```ts
processKeyEvent(e): Promise<boolean>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `e` | [`IKeyboardEventParams`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IInputManager.md#ikeyboardeventparams) |

###### Returns

[`Promise`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/finally.md#promise)\<`boolean`\>

##### processMouseEvent()

```ts
processMouseEvent(e, mouseOverCurrent): Promise<boolean>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `e` | [`IPointerParams`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IInputManager.md#ipointerparams) |
| `mouseOverCurrent` | `boolean` |

###### Returns

[`Promise`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/finally.md#promise)\<`boolean`\>

##### redo()

```ts
redo(): void;
```

###### Returns

`void`

##### redrawActiveText()

```ts
redrawActiveText(): any;
```

###### Returns

`any`

##### redrawText()

```ts
redrawText(): any;
```

###### Returns

`any`

##### staticTextImageChanged()

```ts
staticTextImageChanged(handler): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `handler` | [`StaticTextChangedHandler`](#statictextchangedhandler) |

###### Returns

`void`

##### staticTextImageChanged()

```ts
staticTextImageChanged(handler): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `handler` | [`StaticTextChangedHandler`](#statictextchangedhandler) |

###### Returns

`void`

##### transformText()

```ts
transformText(transform): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `transform` | `Transform` |

###### Returns

`void`

##### unbindFromCanvas()

```ts
unbindFromCanvas(): void;
```

###### Returns

`void`

##### undo()

```ts
undo(): void;
```

###### Returns

`void`

##### updateItemHandler()

```ts
updateItemHandler(newFrame?): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `newFrame?` | `RectangleF` |

###### Returns

`void`

##### updateText()

```ts
updateText(source, force?): Promise<void>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `source` | `string` |
| `force?` | `boolean` |

###### Returns

[`Promise`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/finally.md#promise)\<`void`\>

##### waitUpdate()

```ts
waitUpdate(): Promise<void>;
```

###### Returns

[`Promise`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/finally.md#promise)\<`void`\>

## Type Aliases

### StaticTextChangedEventData

```ts
type StaticTextChangedEventData = object;
```

#### Properties

##### canvas

```ts
canvas: HTMLCanvasElement;
```

##### rect

```ts
rect: MultiSelectMode;
```

***

### StaticTextChangedHandler

```ts
type StaticTextChangedHandler = (data) => void;
```

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `data` | [`StaticTextChangedEventData`](#statictextchangedeventdata) |

#### Returns

`void`