# GC.Spread.Sheets.SheetTabStyleManager

## Content

# Class: SheetTabStyleManager

[Spread](../modules/GC.Spread).[Sheets](../modules/GC.Spread.Sheets).SheetTabStyleManager

## Table of contents

### Constructors

- [constructor](GC.Spread.Sheets.SheetTabStyleManager#constructor)

### Methods

- [add](GC.Spread.Sheets.SheetTabStyleManager#add)
- [all](GC.Spread.Sheets.SheetTabStyleManager#all)
- [clear](GC.Spread.Sheets.SheetTabStyleManager#clear)
- [remove](GC.Spread.Sheets.SheetTabStyleManager#remove)

## Constructors

### <a id="constructor" name="constructor"></a> constructor

• **new SheetTabStyleManager**(`workbook`)

Represents the sheet tab style manager, which can manage the related styles of all sheet tabs.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `workbook` | [`Workbook`](GC.Spread.Sheets.Workbook) | The workbook. |

## Methods

### <a id="add" name="add"></a> add

▸ **add**(`state`, `style`, `sheetNames?`): `void`

Add the status style of some or all sheet tabs in the spreadsheet.

**`example`**
```javascript
spread.sheetTabStyles.add(GC.Spread.Sheets.SheetTabState.active, {foreColor: "red"}, ["Sheet1", "Sheet2"]);
spread.sheetTabStyles.add(GC.Spread.Sheets.SheetTabState.hover, {foreColor: "red"});
```

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `state` | [`SheetTabState`](../enums/GC.Spread.Sheets.SheetTabState) | Sheet tab state. |
| `style` | [`ISheetTabStyle`](../interfaces/GC.Spread.Sheets.ISheetTabStyle) | Sheet tab style. |
| `sheetNames?` | `string`[] | The array of sheet tab names to style. |

#### Returns

`void`

___

### <a id="all" name="all"></a> all

▸ **all**(`sheetNames?`): [`ISheetNameTabStyleMap`](../interfaces/GC.Spread.Sheets.ISheetNameTabStyleMap)

Get the status style of some or all sheet tabs in the spreadsheet.

**`example`**
```javascript
spread.sheetTabStyles.all(["Sheet1", "Sheet2"]);
spread.sheetTabStyles.all();
```

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `sheetNames?` | `string`[] | Array of names of sheet tabs to be queried. |

#### Returns

[`ISheetNameTabStyleMap`](../interfaces/GC.Spread.Sheets.ISheetNameTabStyleMap)

The status style of some or all sheet tabs.

___

### <a id="clear" name="clear"></a> clear

▸ **clear**(`sheetNames?`): `void`

Clear the status styles of some or all sheet tabs in the spreadsheet.

**`example`**
```javascript
spread.sheetTabStyles.clear(["Sheet1", "Sheet2"]);
spread.sheetTabStyles.clear();
```

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `sheetNames?` | `string`[] | The array of worksheet tab names whose status styles need to be cleared. |

#### Returns

`void`

___

### <a id="remove" name="remove"></a> remove

▸ **remove**(`state`, `sheetNames?`): `void`

Remove the status style of some or all sheet tabs in the spreadsheet.

**`example`**
```javascript
spread.sheetTabStyles.remove(GC.Spread.Sheets.SheetTabState.active, ["Sheet1", "Sheet2"]);
spread.sheetTabStyles.remove(GC.Spread.Sheets.SheetTabState.hover);
```

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `state` | [`SheetTabState`](../enums/GC.Spread.Sheets.SheetTabState) | Sheet tab state. |
| `sheetNames?` | `string`[] | The worksheet tab name array corresponding to the state style needs to be deleted. |

#### Returns

`void`