帮助中心
快速寻找答案
首页>帮助手册>

xbot.word.Document

描述:对word工作簿进行处理,如插入表格、读取表格、导出PDF

方法

save()

将工作簿保存为word文件

save(self)

输入参数

返回值

示例1

from xbot import word
def main(args):
document = word.open('D:\\test.docx', kind = 'office', visible = True)
document.save()

该示例执行逻辑: 打开word文件 "D:\test.docx" --> 保存文件

save_as()

将工作簿另存为word文件

save_as(self, filename)

输入参数

filename:另存为路径

返回值

示例1

from xbot import word
def main(args):
document = word.open('D:\\test.docx', kind = 'office', visible = True)
document.save_as('D:\\test1.docx')

该示例执行逻辑: 打开word文件 "D:\test.docx" --> 另存为 "D:\test1.docx"

close()

关闭工作簿

close(self)

输入参数

返回值

示例1

from xbot import word
def main(args):
document = word.open('D:\\test.docx', kind = 'office', visible = True)
document.close()

该示例执行逻辑: 打开word文件 "D:\test.docx" --> 关闭word文档

export_to_pdf()

Word导出PDF文件

export_to_pdf(self, pdf_name, export_range = 0, page_from = 0, page_to = 0, overwrite = True)

输入参数

pdf_name:要保存的PDF文件绝对路径

export_range:要导出的范围,0表示所有页面,1表示当前选择区域,2表示当前页面,3表示指定页面

page_from:导出指定页面的起始页面,当export_range=3时有效

page_to:导出指定页面的终止页面,当export_range=3时有效

override:若导出的PDF文件已存在,是否选择覆盖

返回值

示例1

from xbot import word
def main(args):
document = word.open('D:\\test.docx', kind = 'office', visible = True)
document.export_to_pdf('D:\\test.pdf', 0)

该示例执行逻辑: 打开word文件 "D:\test.docx" --> 将word文件全部导出到 "D:\test.pdf"

get_selection()

获取Word当前选择区域

get_selection(self)

输入参数

返回值

BaseSelection:Word选择区域对象

示例1

from xbot import word
def main(args):
document = word.open('D:\\test.docx', kind = 'office', visible = True)
selection = document.get_selection()

该示例执行逻辑: 打开word文件'D:\test.docx' --> 获取当前选择区域对象

插入超链接

insert_hyperlink(self, text, hyperlink_url, newline = False)

输入参数

text:超链显示文字

hyperlink_url:超链接地址

newline:插入超链前是否换行,True表示换行,False表示不换行

返回值

示例1

from xbot import word
def main(args):
document = word.open('D:\\test.docx', kind = 'office', visible = True)
document.insert_hyperlink('百度一下', 'www.baidu.com', True)

该示例执行逻辑: 打开word文件'D:\test.docx' --> 插入超链接 '百度一下'

insert_table()

插入Word表格

insert_table(self, table_data, table_data_format, grid = True, newline = False)

输入参数

table_data:表格数据,采用二维列表数据格式

table_data_format:表格格式内容,可以从客户端中获取

grid:表格是否显示边框,True表示显示,False表示不显示

newline:插入超链前是否换行,True表示换行,False表示不换行

返回值

示例1

from xbot import word
def main(args):
document = word.open('D:\\test.docx', kind = 'office', visible = True)
document.insert_table([['1','2','3'],['4','5','6']], '{"font": {"name": "宋体","style": "常规","size": 11,"color": 0,"strikethrough": false,"subscript": false,"superscript": false,"bold": false,"italic": false},"alignment": {"horizontalAlignment": 1,"verticalAlignment": 1}}')

该示例执行逻辑: 打开word文件'D:\test.docx' --> 插入数据表格

read_table_from_document()

读取Word表格

read_table_from_document(self, find_way, table_index, table_content)

输入参数

find_way:表格查找方式,'index'表示根据位置查找,'content'表示根据内容查找

table_index:表格位置,find_way='index'时生效

table_content:表格内容,find_way='content'时生效

返回值

List[List]:二维列表,表格内容文本

示例1

from xbot import word
def main(args):
document = word.open('D:\\test.docx', kind = 'office', visible = True)
table_data = document.read_table_from_document('index', 1)
print(table_data)

该示例执行逻辑: 打开word文件'D:\test.docx' --> 读取第一个数据表格

locate_cursor_to_bookmark()

定位光标到书签处

locate_cursor_to_bookmark(self, bookmark_name, bookmark_cursor_position = 'after_bookmark')

输入参数

bookmark_name:书签名

bookmark_cursor_position:定位到书签的位置,'before_bookmark'表示书签前,'after_bookmark'表示书签后

返回值

示例1

from xbot import word
def main(args):
document = word.open('D:\\test.docx', kind = 'office', visible = True)
document.locate_cursor_to_bookmark('书签1')

该示例执行逻辑: 打开word文件'D:\test.docx' --> 定位光标到书签'书签1'后面

问题没有解决?去社区提问