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

# TextWhizzWrapper

> A text engine wrapper for editing and measuring text.

## Classes

### TextWhizzWrapper

#### Remarks

The TextWhizz is used as a text engine.

#### Implements

- [`ITextEngineWrapper`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextEngineWrapper.md#itextenginewrapper)
- [`ITextWhizzHolder`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextWhizzHolder.md#itextwhizzholder)

#### Constructors

##### Constructor

```ts
new TextWhizzWrapper(
   engine, 
   fontRegistry, 
   listStyleSheetManager, 
   colorPreviewService, 
   colorParser, 
   dpi?): TextWhizzWrapper;
```

###### Parameters

| Parameter | Type | Default value |
| ------ | ------ | ------ |
| `engine` | `any` | `undefined` |
| `fontRegistry` | `FontRegistry` | `undefined` |
| `listStyleSheetManager` | [`IListStyleSheetManager`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/IListStyleSheetManager.md#iliststylesheetmanager) | `undefined` |
| `colorPreviewService` | [`IColorPreviewService`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/IColorPreviewService.md#icolorpreviewservice) | `undefined` |
| `colorParser` | [`IColorParser`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/IColorParser.md#icolorparser) | `undefined` |
| `dpi` | `number` | `72` |

###### Returns

[`TextWhizzWrapper`](#textwhizzwrapper)

#### Accessors

##### colorPalette

###### Get Signature

```ts
get colorPalette(): IColorPalette;
```

Color palette.

###### Returns

[`IColorPalette`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/IColorPalette-1.md#icolorpalette)

Color palette.

###### Implementation of

[`ITextEngineWrapper`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextEngineWrapper.md#itextenginewrapper).[`colorPalette`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextEngineWrapper.md#colorpalette)

##### cursorHandler

###### Get Signature

```ts
get cursorHandler(): ICursorHandler;
```

Handler for performing simple operations with the cursor.

###### Returns

[`ICursorHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ICursorHandler.md#icursorhandler)

Handler for performing simple operations with the cursor.

###### Implementation of

[`ITextEngineWrapper`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextEngineWrapper.md#itextenginewrapper).[`cursorHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextEngineWrapper.md#cursorhandler)

##### engine

###### Get Signature

```ts
get engine(): any;
```

Text engine.

###### Returns

`any`

Text engine.

###### Implementation of

[`ITextWhizzHolder`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextWhizzHolder.md#itextwhizzholder).[`engine`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextWhizzHolder.md#engine)

##### engineHandler

###### Get Signature

```ts
get engineHandler(): TextHandler;
```

The engine's text handler.

###### Returns

`TextHandler`

The engine's text handler.

###### Implementation of

[`ITextWhizzHolder`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextWhizzHolder.md#itextwhizzholder).[`engineHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextWhizzHolder.md#enginehandler)

##### initData

###### Get Signature

```ts
get initData(): ITextWhizzInitData;
```

Text item data for initialization.

###### Returns

[`ITextWhizzInitData`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextWhizzInitData.md#itextwhizzinitdata)

Text item data for initialization.

###### Implementation of

[`ITextWhizzHolder`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextWhizzHolder.md#itextwhizzholder).[`initData`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextWhizzHolder.md#initdata)

##### isInitialized

###### Get Signature

```ts
get isInitialized(): boolean;
```

Indicates if the text engine wrapper is initialized and ready to work.

###### Returns

`boolean`

##### metadataHandler

###### Get Signature

```ts
get metadataHandler(): IMetadataHandler;
```

Handler for performing simple operations with text metadata.

###### Returns

[`IMetadataHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/IMetadataHandler.md#imetadatahandler)

Handler for performing simple operations with text metadata.

###### Implementation of

[`ITextEngineWrapper`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextEngineWrapper.md#itextenginewrapper).[`metadataHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextEngineWrapper.md#metadatahandler)

##### selectionHandler

###### Get Signature

```ts
get selectionHandler(): ISelectionHandler;
```

Handler for performing simple operations with text selection.

###### Returns

[`ISelectionHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ISelectionHandler.md#iselectionhandler)

Handler for performing simple operations with text selection.

###### Implementation of

[`ITextEngineWrapper`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextEngineWrapper.md#itextenginewrapper).[`selectionHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextEngineWrapper.md#selectionhandler)

##### styleHandler

###### Get Signature

```ts
get styleHandler(): IStyleHandler;
```

Handler for performing simple operations with paragraph and character styles.

###### Returns

[`IStyleHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/IStyleHandler.md#istylehandler)

Handler for performing simple operations with paragraph and character styles.

###### Implementation of

[`ITextEngineWrapper`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextEngineWrapper.md#itextenginewrapper).[`styleHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextEngineWrapper.md#stylehandler)

##### textHandler

###### Get Signature

```ts
get textHandler(): ITextHandler;
```

Handler for performing simple operations with text content.

###### Returns

[`ITextHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextHandler.md#itexthandler)

Handler for performing simple operations with text content.

###### Implementation of

[`ITextEngineWrapper`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextEngineWrapper.md#itextenginewrapper).[`textHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextEngineWrapper.md#texthandler)

##### textMeasurer

###### Get Signature

```ts
get textMeasurer(): ITextMeasurer;
```

Handler for measuring text.

###### Returns

[`ITextMeasurer`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextMeasurer.md#itextmeasurer)

Handler for measuring text.

###### Implementation of

[`ITextEngineWrapper`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextEngineWrapper.md#itextenginewrapper).[`textMeasurer`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextEngineWrapper.md#textmeasurer)

##### undoRedoHandler

###### Get Signature

```ts
get undoRedoHandler(): IUndoRedoHandler;
```

Handler for performing operations with redoing and undoing of actions.

###### Returns

[`IUndoRedoHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/IUndoRedoHandler.md#iundoredohandler)

Handler for performing operations with redoing and undoing of actions.

###### Implementation of

[`ITextEngineWrapper`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextEngineWrapper.md#itextenginewrapper).[`undoRedoHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextEngineWrapper.md#undoredohandler)

#### Methods

##### clone()

```ts
clone(text): ITextWhizzHolder;
```

Clones an existing TextWhizz wrapper using custom text.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `text` | `string` | custom text. |

###### Returns

[`ITextWhizzHolder`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextWhizzHolder.md#itextwhizzholder)

###### Implementation of

[`ITextWhizzHolder`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextWhizzHolder.md#itextwhizzholder).[`clone`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextWhizzHolder.md#clone)

##### initialize()

```ts
initialize(itemData): void;
```

Initializes the text engine wrapper.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `itemData` | [`ITextWhizzInitData`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextWhizzInitData.md#itextwhizzinitdata) | text item data for initialization. |

###### Returns

`void`

##### createException()

```ts
static createException(engine, e): Exception;
```

Handles the exception of TextWhizz.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `engine` | `any` | text engine. |
| `e` | `number` | number of TextWhizz exception. |

###### Returns

`Exception`

a handled exception with a name and description.