Workbook类

Workbook类

表示创建 Excel 电子表格的根对象。

Workbook 类型公开以下成员:

构造函数

构造函数描述
__init__(self)初始化 Workbook 类的新实例。
__init__(self, file_format_type)初始化 Workbook 类的新实例。
__init__(self, file)初始化Workbook类的新实例并打开一个文件。
__init__(self, stream)初始化Workbook类的新实例并打开一个流。
__init__(self, file, load_options)初始化Workbook类的新实例并打开一个文件。
__init__(self, stream, load_options)初始化Workbook类的新实例并打开流。

属性

属性描述
settings代表工作簿设置。
worksheets获取电子表格中的 WorksheetCollection 集合。
is_licensed指示是否设置了许可证。
colors返回电子表格调色板中的颜色。
count_of_styles_in_pool获取样式池中的样式数量。
default_style获取或设置工作簿的默认 Style 对象。
is_digitally_signed指示此电子表格是否经过数字签名。
is_workbook_protected_with_password指示结构或窗口是否受密码保护。
vba_project在电子表格中获取 Workbook.vba_project
has_macro指示此电子表格是否包含宏/VBA。
has_revisions获取工作簿是否有任何跟踪更改
file_name获取并设置当前文件名。
cells_data_table_factory获取从自定义对象构建 ICellsDataTable 的工厂
data_sorter获取 DataSorter 对象来对数据进行排序。
theme获取主题名称。
built_in_document_properties返回一个 DocumentProperty 集合,该集合代表电子表格的所有内置文档属性。
custom_document_properties返回代表电子表格的所有自定义文档属性的 DocumentProperty 集合。
file_format获取并设置文件格式。
has_custom_function检测此工作簿中是否使用了自定义函数,
例如在单元格的公式中、在定义的名称中……
content_type_properties获取工作簿中 ContentTypeProperty 对象的列表。
custom_xml_parts表示自定义 XML 数据存储部分(包内的自定义 XML 数据)。
data_mashup获取混搭数据。
ribbon_xml获取并设置定义 Ribbon UI 的 XML 文件。
absolute_path获取并设置文件的绝对路径。
data_connections获取 ExternalConnection 集合。
data_model获取工作簿中的数据模型。

方法

方法描述
save(self, file_name, save_format)将工作簿保存到磁盘。
save(self, file_name)将工作簿保存到磁盘。
save(self, file_name, save_options)将工作簿保存到磁盘。
save(self, stream, save_format)将工作簿保存到流中。
save(self, stream, save_options)将工作簿保存到流中。
create_style(self)創造出新的風格。
create_style(self, clone_default_style)創造出新的風格。
replace(self, place_holder, new_value)用新字符串替换单元格的值。
replace(self, place_holder, new_value)用新的整数替换单元格的值。
replace(self, place_holder, new_value)用新的双精度值替换单元格的值。
replace(self, place_holder, new_values, is_vertical)用新的字符串数组替换单元格的值。
replace(self, place_holder, new_values, is_vertical)用整数数组替换单元格的值。
replace(self, place_holder, new_values, is_vertical)用双精度数组替换单元格的值。
replace(self, bool_value, new_value)用新数据替换单元格的值。
replace(self, int_value, new_value)用新数据替换单元格的值。
replace(self, place_holder, new_value, options)用新字符串替换单元格的值。
copy(self, source, copy_options)复制另一个 Workbook 对象。
copy(self, source)从源 Workbook 对象复制数据。
calculate_formula(self)计算公式的结果。
calculate_formula(self, ignore_error)计算公式的结果。
calculate_formula(self, options)本工作簿中的计算公式。
refresh_dynamic_array_formulas(self, calculate)刷新动态数组公式(根据当前数据溢出到相邻单元格的新范围)
工作簿中的其他公式即使被动态数组公式使用,也不会被递归计算。
refresh_dynamic_array_formulas(self, calculate, copts)刷新动态数组公式(根据当前数据溢出到相邻单元格的新范围)
import_xml(self, url, sheet_name, row, col)将 XML 数据文件导入/更新到工作簿。
import_xml(self, stream, sheet_name, row, col)将 XML 数据文件导入/更新到工作簿。
export_xml(self, map_name, path)导出由指定的 XML 映射链接的 XML 数据。
export_xml(self, map_name, stream)导出 XML 数据。
parse_formulas(self, ignore_error)解析从模板文件加载或设置到单元格时尚未解析的所有公式。
start_access_cache(self, opts)启动使用缓存访问数据的会话。
close_access_cache(self, opts)关闭使用缓存访问数据的会话。
remove_unused_styles(self)删除所有未使用的样式。
create_builtin_style(self, type)根据给定类型创建内置样式。
create_cells_color(self)创建一个 CellsColor 对象。
combine(self, second_workbook)合并另一个 Workbook 对象。
get_style_in_pool(self, index)获取样式池中的样式。
工作簿中的所有样式都将聚集到一个池中。
单元格中只有一个简单的参考索引。
get_fonts(self)获取样式池中的所有字体。
get_named_style(self, name)获取样式池中的命名样式。
merge_named_styles(self, source)合并来自其他 Excel 文件的命名样式。
change_palette(self, color, index)更改指定索引中的电子表格的调色板。
is_color_in_palette(self, color)检查颜色是否存在于电子表格的调色板中。
get_matching_color(self, raw_color)在当前调色板中查找最匹配的颜色。
set_encryption_options(self, encryption_type, key_length)设置加密选项。
protect(self, protection_type, password)保护工作簿。
protect_shared_workbook(self, password)保护共享工作簿。
unprotect(self, password)取消保护工作簿。
unprotect_shared_workbook(self, password)取消保护共享工作簿。
remove_macro(self)从此电子表格中删除 VBA/宏。
remove_digital_signature(self)从此电子表格中删除数字签名。
accept_all_revisions(self)接受工作簿中的所有修订。
remove_external_links(self)删除工作簿中的所有外部链接。
get_theme_color(self, type)获取主题颜色。
set_theme_color(self, type, color)设置主题颜色
custom_theme(self, theme_name, colors)风俗为主题。
copy_theme(self, source)从另一个工作簿复制主题。
has_exernal_links(self)指示此工作簿是否包含指向其他数据源的外部链接。
update_custom_function_definition(self, definition)更新自定义函数的定义。
update_linked_data_source(self, external_workbooks)如果此工作簿包含指向其他数据源的外部链接,
Aspose.Cells 将尝试从给定来源检索最新数据。
set_digital_signature(self, digital_signature_collection)为电子表格文件设置数字签名(Excel2007及更高版本)。
add_digital_signature(self, digital_signature_collection)向 OOXML 电子表格文件(Excel2007 及更高版本)添加数字签名。
get_digital_signature(self)从文件获取数字签名。
remove_personal_information(self)删除个人信息。
close(self)自 Python 协议以来,包装器跳过了 Dispose()

注意事项

Workbook 类表示一个 Excel 电子表格。每个电子表格可以包含多个工作表。 该类的基本功能是打开和保存原生的excel文件。 该类具有一些高级功能,例如从其他工作簿复制数据、合并两个工作簿、将 Excel 转换为 PDF、将 Excel 渲染为图像以及保护 Excel 电子表格。

例子

以下示例从名为 designer.xls 的 Excel 文件加载 Workbook,并使水平和垂直滚动条不可见。 然后,它分别用电子表格中的整数值和字符串值替换两个字符串值,最后将工作簿保存为 Excel xlsx 文件。

from aspose.cells import Workbook

# Open a designer file
designerFile = "designer.xls"
workbook = Workbook(designerFile)
# Set scroll bars
workbook.settings.is_h_scroll_bar_visible = False
workbook.settings.is_v_scroll_bar_visible = False
# Replace the placeholder string with new values
newInt = 100
workbook.replace("OldInt", newInt)
newString = "Hello!"
workbook.replace("OldString", newString)
workbook.save("result.xlsx")

也可以看看