WorksheetCollection类
WorksheetCollection类
封装 Worksheet 对象的集合。
WorksheetCollection 类型公开了以下成员:
特性
| 属性 | 描述 |
|---|---|
| web_extension_task_panes | 获取任务窗格列表。 |
| web_extensions | 获取任务窗格列表。 |
| threaded_comment_authors | 获取线程评论作者的列表。 |
| is_refresh_all_connections | 指示是否在 MS Excel 中打开文件时刷新所有连接。 |
| names | 获取电子表格中所有 Name 对象的集合。 |
| active_sheet_name | 表示打开电子表格时活动工作表的名称。 |
| active_sheet_index | 表示打开电子表格时活动工作表的索引。 |
| dxfs | 获取主差异格式记录。 |
| xml_maps | 获取和设置工作簿中的 XML 映射。 |
| built_in_document_properties | 返回代表电子表格所有内置文档属性的 DocumentProperty 集合。 |
| custom_document_properties | 返回代表电子表格所有自定义文档属性的 DocumentProperty 集合。 |
| ole_size | 获取和设置工作簿文件用作 Ole 对象时的显示大小。 |
| external_links | 表示工作簿中的外部链接。 |
| table_styles | 获取 WorksheetCollection.table_styles 对象。 |
| revision_logs | 表示修订日志。 |
| capacity | 获取或设置数组列表可以包含的元素数。 |
方法
| 方法 | 描述 |
|---|---|
| get(index) | 添加 API for Python Via .Net.since this[int index] is unsupported |
| get(sheet_name) | 添加 API for Python 通过 .Net.since this[string sheetName] 不受支持 |
| add(type) | 将工作表添加到集合中。 |
| add() | 将工作表添加到集合中。 |
| add(sheet_name) | 将工作表添加到集合中。 |
| register_add_in_function(add_in_file, function_name, lib) | 将插件功能添加到工作簿中 |
| register_add_in_function(id, function_name) | 将插件功能添加到工作簿中 |
| add_copy(sheet_name) | 将工作表添加到集合并从现有工作表复制数据。 |
| add_copy(sheet_index) | 将工作表添加到集合并从现有工作表复制数据。 |
| get_range_by_name(range_name) | 通过预定义名称获取 Range 对象。 |
| get_range_by_name(range_name, current_sheet_index, include_table) | 通过预定义名称或表名获取 Range |
| copy_to(array) | 将整个数组列表复制到兼容的一维数组列表,从目标数组列表的开头开始。 |
| copy_to(index, array, array_index, count) | 将数组列表中的一系列元素复制到兼容的一维数组列表,从目标数组列表的指定索引开始。 |
| index_of(item, index) | 搜索指定的对象并返回数组列表中从指定索引延伸到最后一个元素的元素范围内第一次出现的从零开始的索引。 |
| index_of(item, index, count) | 搜索指定的对象并返回数组列表中从指定索引开始并包含指定数量的元素的元素范围内第一次出现的从零开始的索引。 |
| last_index_of(item) | 搜索指定的对象并返回整个数组列表中最后一次出现的从零开始的索引。 |
| last_index_of(item, index) | 搜索指定的对象并返回数组列表中从第一个元素到指定索引的元素范围内最后一次出现的从零开始的索引。 |
| last_index_of(item, index, count) | 搜索指定的对象并返回数组列表中包含指定数量的元素并以指定索引结束的元素范围内最后一次出现的从零开始的索引。 |
| create_range(address, sheet_index) | 从范围地址创建一个 Range 对象。 |
| create_union_range(address, sheet_index) | 从范围地址创建一个 Range 对象。 |
| get_sheet_by_code_name(code_name) | 通过代码名称获取工作表。 |
| sort_names() | 对定义的名称进行排序。 |
| swap_sheet(sheet_index1, sheet_index2) | 交换两张纸。 |
| remove_at(name) | 删除指定名称的元素。 |
| get_named_ranges() | 获取电子表格中所有预定义的命名范围。 |
| get_named_ranges_and_tables() | 获取电子表格中所有预定义的命名范围。 |
| set_ole_size(start_row, end_row, start_column, end_column) | 设置工作簿文件用作 Ole 对象时的显示大小。 |
| clear_pivottables() | 从电子表格中清除数据透视表。 |
| refresh_pivot_tables() | 刷新 WorksheetCollection 中的所有数据透视表。 |
| binary_search(item) | 使用默认比较器在整个排序数组列表中搜索元素,并返回元素的从零开始的索引。 |
例子
from aspose.cells import Workbook
workbook = Workbook()
sheets = workbook.worksheets
# Add a worksheet
sheets.add()
# Change the name of a worksheet
sheets[0].name = "First Sheet"
# Set the active sheet to the second worksheet
sheets.active_sheet_index = 1
也可以看看
- 模块 aspose.cells
- 类 DocumentProperty
- 类 Range
- 类 Worksheet