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

# IListService

> Service for performing basic operations with lists.

## Interfaces

### IListService

#### Extended by

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

#### Methods

##### actualizeStyleManager()

```ts
actualizeStyleManager(): void;
```

Actualize all list styles (by name) in the style sheet manager.

###### Returns

`void`

###### Remarks

The actual list styles are the styles in TextWhizz.

##### addListItem()

```ts
addListItem(newListItemIndex, existingListItemIndex): void;
```

Adds a new list item to an existing list by the paragraph index.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `newListItemIndex` | `number` | index of the new list item. |
| `existingListItemIndex` | `number` | the index of the existing (previous) list item. |

###### Returns

`void`

###### Remarks

there must be no other items of the same list between the current index and the index of the previous list item.

##### applyListType()

```ts
applyListType(paragraphIndexes, listType): void;
```

Applies a list type to paragraphs by their indexes.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `paragraphIndexes` | `number`[] | paragraph indexes. |
| `listType` | [`ListType`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ListType.md#listtype) | list type. |

###### Returns

`void`

##### createBulletedListItem()

```ts
createBulletedListItem(paragraphIndex, bulletCharCode): void;
```

Creates a new top-level bulleted list item.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `paragraphIndex` | `number` | paragraph index. |
| `bulletCharCode` | `number` | character code used as 'bullet' (e.g., code 8225 used for “‡“). |

###### Returns

`void`

##### createNumberedListItem()

```ts
createNumberedListItem(paragraphIndex, format): void;
```

Creates a new top-level numbered list item.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `paragraphIndex` | `number` | paragraph index. |
| `format` | [`NumberingFormatType`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/NumberingFormatType.md#numberingformattype) | numbering format. |

###### Returns

`void`

##### decreaseListItemIndent()

```ts
decreaseListItemIndent(paragraphIndex): void;
```

Decreases the nesting level of the list item by the paragraph index.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `paragraphIndex` | `number` | paragraph index. |

###### Returns

`void`

##### deleteListItem()

```ts
deleteListItem(paragraphIndex): void;
```

Removes the existing list item by the paragraph index.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `paragraphIndex` | `number` | the paragraph index of the list item to remove. |

###### Returns

`void`

###### Remarks

only list item is removed, paragraph text is not removed.

##### findItemToContinueBulletedList()

```ts
findItemToContinueBulletedList(paragraphIndex, bulletCharCode): number;
```

Finds the previous list item to continue bulleted list.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `paragraphIndex` | `number` | index of the current paragraph. |
| `bulletCharCode` | `number` | character code used as 'bullet' (e.g., code 8225 used for “‡“). |

###### Returns

`number`

the paragraph index of the found list item (if it was found).

##### findItemToContinueNumberedList()

```ts
findItemToContinueNumberedList(
   paragraphIndex, 
   format, 
   itemNumber): number;
```

Finds the previous list item to continue bulleted list.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `paragraphIndex` | `number` | index of the current paragraph. |
| `format` | [`NumberingFormatType`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/NumberingFormatType.md#numberingformattype) | numbering format. |
| `itemNumber` | `number` | list item number (from 1). |

###### Returns

`number`

the paragraph index of the found list item (if it was found).

##### getListItemStyle()

```ts
getListItemStyle(paragraphIndex): IListStyle;
```

Returns the style of the list item by the paragraph index.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `paragraphIndex` | `number` | paragraph index. |

###### Returns

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

###### Remarks

if the list item is not found, null is returned.

##### increaseListItemIndent()

```ts
increaseListItemIndent(paragraphIndex): void;
```

Increases the nesting level of the list item by the paragraph index.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `paragraphIndex` | `number` | paragraph index. |

###### Returns

`void`

##### isParagraphAListItem()

```ts
isParagraphAListItem(paragraphIndex): boolean;
```

Indicates if a paragraph is a list item.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `paragraphIndex` | `number` | paragraph index. |

###### Returns

`boolean`

returns true if the paragraph is a list item, false otherwise.

##### isParagraphsTheSameList()

```ts
isParagraphsTheSameList(paragraphIndexes): boolean;
```

Indicates if the paragraphs are the same list.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `paragraphIndexes` | `number`[] | paragraph indexes. |

###### Returns

`boolean`