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

# TextWhizzRange

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

## Classes

### TextWhizzRange

#### Implements

#### Constructors

##### Constructor

```ts
new TextWhizzRange(textRange): TextWhizzRange;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `textRange` | `TextRange` |

###### Returns

[`TextWhizzRange`](#textwhizzrange)

#### Accessors

##### isEmpty

###### Get Signature

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

Indicates that the text range is empty (starting position is the same as ending position).

###### Returns

`boolean`

Indicates that the text range is empty (starting position is the same as ending position).

###### Implementation of

[`ITextRange`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextRange.md#itextrange).[`isEmpty`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextRange.md#isempty)

##### isValid

###### Get Signature

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

Indicates that the original text still exists and was not modified.

###### Returns

`boolean`

Indicates that the original text still exists and was not modified.

###### Implementation of

[`ITextRange`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextRange.md#itextrange).[`isValid`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextRange.md#isvalid)

#### Methods

##### getEndPosition()

```ts
getEndPosition(): IPositionInText;
```

Returns the end position of text range.

###### Returns

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

###### Implementation of

[`ITextRange`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextRange.md#itextrange).[`getEndPosition`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextRange.md#getendposition)

##### getEntry()

```ts
getEntry(): TextRange;
```

###### Returns

`TextRange`

##### getFormattedText()

```ts
getFormattedText(): string;
```

Returns the formatted text of text range.

###### Returns

`string`

###### Implementation of

[`ITextRange`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextRange.md#itextrange).[`getFormattedText`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextRange.md#getformattedtext)

##### getLeftPosition()

```ts
getLeftPosition(): IPositionInText;
```

Returns the left position of text range.

###### Returns

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

###### Implementation of

[`ITextRange`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextRange.md#itextrange).[`getLeftPosition`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextRange.md#getleftposition)

##### getParagraphIndexes()

```ts
getParagraphIndexes(): number[];
```

Returns the indexes of paragraphs within a text range.

###### Returns

`number`[]

###### Remarks

Indexes are ordered from lowest to highest.

###### Implementation of

[`ITextRange`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextRange.md#itextrange).[`getParagraphIndexes`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextRange.md#getparagraphindexes)

##### getPlainText()

```ts
getPlainText(): string;
```

Returns the plain text (without formatting) of text range.

###### Returns

`string`

###### Implementation of

[`ITextRange`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextRange.md#itextrange).[`getPlainText`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextRange.md#getplaintext)

##### getRightPosition()

```ts
getRightPosition(): IPositionInText;
```

Returns the right position of text range.

###### Returns

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

###### Implementation of

[`ITextRange`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextRange.md#itextrange).[`getRightPosition`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextRange.md#getrightposition)

##### getStartPosition()

```ts
getStartPosition(): IPositionInText;
```

Returns the start position of text range.

###### Returns

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

###### Implementation of

[`ITextRange`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextRange.md#itextrange).[`getStartPosition`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextRange.md#getstartposition)

##### isEqualTo()

```ts
isEqualTo(anotherRange): boolean;
```

Compares the current text range with another.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `anotherRange` | [`ITextRange`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextRange.md#itextrange) | another text range. |

###### Returns

`boolean`

true if the ranges match, false otherwise.

###### Implementation of

[`ITextRange`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextRange.md#itextrange).[`isEqualTo`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextRange.md#isequalto)

##### createEntry()

```ts
static createEntry(
   textWhizz, 
   start, 
   end): TextWhizzRange;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `textWhizz` | `any` |
| `start` | `TextPosition` |
| `end` | `TextPosition` |

###### Returns

[`TextWhizzRange`](#textwhizzrange)