playbook/docs/tsl/codegen/dotnet/document/excel_txls.md

# 文档处理 / Excel处理函数-txlsreadwrite版

## `excelDeleteSheetOrChartSheet2(excel_file_name, excel_sheet_name)`

删除Excel中的Sheet或Chartsheet 注：此函数无需依赖office/wps，但需要关闭文件。

| 参数               | 类型   | 说明                                 |
| ------------------ | ------ | ------------------------------------ |
| `excel_file_name`  | string | 字符串,Excel文件名                   |
| `excel_sheet_name` | string | 字符串,指定的Sheet名或者Chartsheet名 |

返回：int

## `excelGetCell2(excel_file_name, excel_sheet_name, row, col, value)`

获得指定的Excel中的指定的Sheet的行列的数据值, 注：此函数无需依赖office/wps，但需要关闭文件。

| 参数               | 类型   | 说明                      |
| ------------------ | ------ | ------------------------- |
| `excel_file_name`  | string | 字符串,Excel文件名        |
| `excel_sheet_name` | string | 字符串,Sheet名            |
| `row`              | int    | 整数,指定行               |
| `col`              | int    | 整数,指定列               |
| `value`            | any    | 任意类型,返回指定行列的值 |

返回：int

## `excelGetCells2(excel_file_name, excel_sheet_name, row, col, row2, col2, value)`

获得指定的Excel中的指定的Sheet的区域的数据值 注：此函数无需依赖office/wps，但需要关闭文件。

| 参数               | 类型   | 说明                  |
| ------------------ | ------ | --------------------- |
| `excel_file_name`  | string | 字符串,Excel文件名    |
| `excel_sheet_name` | string | 字符串,Sheet名        |
| `row`              | int    | 整数,指定行           |
| `col`              | int    | 整数,指定列           |
| `row2`             | int    | 整数,指定行           |
| `col2`             | int    | 整数,指定列           |
| `value`            | array  | 数组,返回指定区域的值 |

返回：int

## `excelGetChartSheetCount2(excel_file_name, value)`

得到指定的Excel中ChartSheet的个数 注：此函数无需依赖office/wps，但需要关闭文件。

| 参数              | 类型   | 说明                      |
| ----------------- | ------ | ------------------------- |
| `excel_file_name` | string | 字符串,Excel文件名        |
| `value`           | int    | 整数,返回ChartSheet的个数 |

返回：int

## `excelGetChartSheetNameByIndex2(excel_file_name, index, value)`

得到指定的Excel中指定索引的ChartSheet名称 注：此函数无需依赖office/wps，但需要关闭文件。

| 参数              | 类型   | 说明                              |
| ----------------- | ------ | --------------------------------- |
| `excel_file_name` | string | 字符串,Excel文件名                |
| `index`           | int    | 整数,需要获得的ChartSheet的索引号 |
| `value`           | string | 字符串,返回Sheet的名称            |

返回：int

## `excelGetDataRange2(excel_file_name, excel_sheet_name, start_row, start_col, end_row, end_col)`

获得指定的Excel中的指定的Sheet包含有数据的区域 注：此函数无需依赖office/wps，但需要关闭文件。

| 参数               | 类型   | 说明                |
| ------------------ | ------ | ------------------- |
| `excel_file_name`  | string | 字符串,Excel文件名  |
| `excel_sheet_name` | string | 字符串,Sheet名      |
| `start_row`        | int    | 整数,有数据的开始行 |
| `start_col`        | int    | 整数,有数据的开始列 |
| `end_row`          | int    | 整数,有数据的结束行 |
| `end_col`          | int    | 整数,有数据的结束列 |

返回：int

## `excelGetSheetCount2(excel_file_name, value)`

得到指定的Excel中Sheet的个数 注：此函数无需依赖office/wps，但需要关闭文件。

| 参数              | 类型   | 说明                   |
| ----------------- | ------ | ---------------------- |
| `excel_file_name` | string | 字符串,Excel文件名     |
| `value`           | int    | 整数,返回Sheet的个数。 |

返回：int

## `excelGetSheetNameByIndex2(excel_file_name, index, value)`

得到指定的Excel中指定索引的Sheet名称 注：此函数无需依赖office/wps，但需要关闭文件。

| 参数              | 类型   | 说明                         |
| ----------------- | ------ | ---------------------------- |
| `excel_file_name` | string | 字符串,Excel文件名           |
| `index`           | int    | 整数,需要获得的Sheet的索引号 |
| `value`           | string | 字符串,返回Sheet的名称       |

返回：int

## `excelMerge2(excel_file_name, excel_sheet_name, start_row, start_col, end_row, end_col)`

合并指定区域的属性 注：此函数无需依赖office/wps，但需要关闭文件。

| 参数               | 类型   | 说明               |
| ------------------ | ------ | ------------------ |
| `excel_file_name`  | string | 字符串,Excel文件名 |
| `excel_sheet_name` | string | 字符串,Sheet名     |
| `start_row`        | int    | 整数,数据的开始行  |
| `start_col`        | int    | 整数,数据的开始列  |
| `end_row`          | int    | 整数,数据的结束行  |
| `end_col`          | int    | 整数,数据的结束列  |

返回：int

## `excelNewSheet2(excel_file_name, excel_sheet_name)`

新建一个Sheet 注：此函数无需依赖office/wps，但需要关闭文件。

| 参数               | 类型   | 说明               |
| ------------------ | ------ | ------------------ |
| `excel_file_name`  | string | 字符串,Excel文件名 |
| `excel_sheet_name` | string | 字符串,Sheet名     |

返回：int

## `excelRenameSheetOrChartsheet2(excel_file_name, excel_sheet_name, excel_news_sheetname)`

更改Sheet名或ChartSheet名 注：此函数无需依赖office/wps，但需要关闭文件。

| 参数                   | 类型   | 说明               |
| ---------------------- | ------ | ------------------ |
| `excel_file_name`      | string | 字符串,Excel文件名 |
| `excel_sheet_name`     | string | 字符串,Sheet名     |
| `excel_news_sheetname` | string | 字符串,新的Sheet名 |

返回：int

## `excelSetActiveSheet2(excel_file_name, excel_sheet_name)`

设置Excel文件的当前Sheet 注：此函数无需依赖office/wps，但需要关闭文件。

| 参数               | 类型   | 说明               |
| ------------------ | ------ | ------------------ |
| `excel_file_name`  | string | 字符串,Excel文件名 |
| `excel_sheet_name` | string | 字符串,Sheet名     |

返回：int

## `excelSetCell2(excel_file_name, excel_sheet_name, row, col, value)`

设置指定的Excel中的指定的Sheet的行列的数据值， 注：此函数无需依赖office/wps，但需要关闭文件。

| 参数               | 类型   | 说明                        |
| ------------------ | ------ | --------------------------- |
| `excel_file_name`  | string | 字符串,Excel文件名          |
| `excel_sheet_name` | string | 字符串,Sheet名              |
| `row`              | int    | 整数,指定行                 |
| `col`              | int    | 整数,指定列                 |
| `value`            | any    | 任意类型,设置的指定行列的值 |

返回：int

## `excelSetCells2(excel_file_name, excel_sheet_name, row, col, row2, col2, value)`

设置指定的Excel中的指定的Sheet的区域的数据值 注：此函数无需依赖office/wps，但需要关闭文件。

| 参数               | 类型   | 说明                    |
| ------------------ | ------ | ----------------------- |
| `excel_file_name`  | string | 字符串,Excel文件名      |
| `excel_sheet_name` | string | 字符串,Sheet名          |
| `row`              | int    | 整数,指定行             |
| `col`              | int    | 整数,指定列             |
| `row2`             | int    | 整数,指定行             |
| `col2`             | int    | 整数,指定列             |
| `value`            | array  | 数组,设置的指定区域的值 |

返回：int

## `excelUnMerge2(excel_file_name, excel_sheet_name, start_row, start_col, end_row, end_col)`

取消合并指定区域的属性 注：此函数无需依赖office/wps，但需要关闭文件。

| 参数               | 类型   | 说明               |
| ------------------ | ------ | ------------------ |
| `excel_file_name`  | string | 字符串,Excel文件名 |
| `excel_sheet_name` | string | 字符串,Sheet名     |
| `start_row`        | int    | 整数,数据的开始行  |
| `start_col`        | int    | 整数,数据的开始列  |
| `end_row`          | int    | 整数,数据的结束行  |
| `end_col`          | int    | 整数,数据的结束列  |

返回：int