xbot.excel.WorkBook

概述

workbook接口主要是对工作簿的处理，如获取sheet页、激活sheet页、创建sheet页、保存为excel文件、另存为excel文件、执行宏、关闭工作簿等

详情

get_active_sheet

获取工作簿中激活的sheet页

get_active_sheet(self)
参数：

• 无

返回值:

• WorkSheet：sheet页对象

示例1：
获取excel文件’D:\test.xlsx’中当前激活的sheet页

from xbot import excel
def main(args):
    workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
    worksheet = workbook.get_active_sheet()

get_sheet_by_index

获取工作簿中指定位置的sheet页

get_sheet_by_index(self, index)
参数：

• index：目标sheet页在工作簿中的索引位置，从1开始计数

返回值:

• WorkSheet：sheet页对象

示例1：
获取excel文件’D:\test.xlsx’中第一个sheet页

from xbot import excel
def main(args):
    workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
    worksheet = workbook.get_sheet_by_index(1)

get_sheet_by_name

获取工作簿中指定名称的sheet页

get_sheet_by_name(self, name)
参数：

• name：目标sheet页的名称

返回值:

• WorkSheet：sheet页对象

示例1：
获取excel文件’D:\test.xlsx’中名称为 ‘Sheet1’ 的sheet页

from xbot import excel
def main(args):
    workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
    worksheet = workbook.get_sheet_by_name('Sheet1')

create_sheet

在工作簿中创建新的sheet页

create_sheet(self, name, create_way)
参数：

• name：sheet页名称
• create_way：添加方式
  • ‘first’：作为第一个sheet页
  • ‘last’：作为最后一个sheet页

返回值:

• WorkSheet：sheet页对象

示例1：
打开excel文件’D:\test.xlsx’，并追加一个名称为 ‘SheetTest’ 的sheet页

from xbot import excel
def main(args):
    workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
    worksheet = workbook.create_sheet('SheetTest', 'last')

active_sheet_by_index

激活工作簿中指定位置的sheet页

active_sheet_by_index(self, index)
参数：

• index：目标sheet页在工作簿中的索引位置，从1开始计数

返回值:

• 无

示例1：
激活excel文件’D:\test.xlsx’中第一个sheet页

from xbot import excel
def main(args):
    workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
    workbook.active_sheet_by_index(1)

active_sheet_by_name

激活工作簿中指定名称的sheet页

active_sheet_by_name(self, name)
参数：

• name：目标sheet页的名称

返回值:

• 无

示例1：
激活excel文件’D:\test.xlsx’中名称为 ‘Sheet1’ 的sheet页

from xbot import excel
def main(args):
    workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
    workbook.active_sheet_by_name('Sheet1')

save

将工作簿保存为excel文件

save(self)
参数：

• 无

返回值:

• 无

示例1：
打开excel文件’D:\test.xlsx’后保存

from xbot import excel
def main(args):
    workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
    workbook.save()

save_as

将工作簿另存为excel文件

save_as(self, filename)
参数：

• filename：另存为路径

返回值:

• 无

示例1：
打开excel文件’D:\test.xlsx’后另存为’D:\test1.xlsx’

from xbot import excel
def main(args):
    workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
    workbook.save_as('D:\\test1.xlsx')

close

关闭工作簿

close(self)
参数：

• 无

返回值:

• 无

示例1：
打开excel文件’D:\test.xlsx’后关闭

from xbot import excel
def main(args):
    workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
    workbook.close()

execute_macro

执行宏

execute_macro(self, macro)
参数：

• macro：宏名称

返回值:

• 无

示例1：
打开excel文件’D:\test.xlsx’后执行名称为’macro1’的宏

from xbot import excel
def main(args):
    workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
    workbook.execute_macro('macro1')

get_all_sheet

获取所有的Sheet页

get_all_sheet(self)
参数：

• 无

返回值:

• List[WorkSheet]：sheet页对象列表

示例1：
获取excel文件’D:\test.xlsx’所有Sheet页对象

from xbot import excel
def main(args):
    workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
    workbook.get_all_sheet()

delete_sheet

删除Sheet页

delete_sheet(self, name)
参数：

• name：Sheet页名称

返回值:

• 无

示例1：
删除excel文件’D:\test.xlsx’的Sheet1页

from xbot import excel
def main(args):
    workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
    workbook.delete_sheet('Sheet1')

copy_sheet

拷贝Sheet页

copy_sheet(self, name, new_name)
参数：

• name：待拷贝的Sheet页名称
• new_name：新的Sheet页名称

返回值:

• 无

示例1：
拷贝excel文件’D:\test.xlsx’的Sheet1页到新的Sheet2页

from xbot import excel
def main(args):
    workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
    workbook.copy_sheet('Sheet1', 'Sheet2')

copy_sheet_toworkbook

拷贝Sheet页至另外一个Workbook

copy_sheet_to_workbook(self, name, workbook, new_name)
参数：

• name：待拷贝的Sheet页名称
• workbook：另外一个已经打开的workbook
• new_name：新的Sheet页名称

返回值:

• 无

示例1：
将 test1.xlsx 的Sheet1页拷贝到 test2.xlsx 的Sheet2页

from xbot import excel
def main(args):
    workbook1 = excel.open('D:\\test1.xlsx', kind = 'office', visible = True)
    workbook2 = excel.open('D:\\test2.xlsx', kind = 'office', visible = True)
    workbook1.copy_sheet('Sheet1', workbook2, 'Sheet2')

get_selected_range

获取当前页的选中区域

get_selected_range(self)
参数：

• 无

返回值:

• 四元组：（起始单元格行号, 起始单元格列名, 终止单元格行号, 终止单元格列名）

示例1：
获取excel文件’D:\test.xlsx’的当前页的选中区域

from xbot import excel
def main(args):
    workbook = excel.open('D:\\test.xlsx', kind = 'office', visible = True)
    workbook.get_selected_range()