Word

close()

方法描述

关闭word

调用样例- rpa.app.microsoft.word.Word.close-

# 注意事项：使用前需确认已安装MicroSoft相关软件
# close方法不会自动保存，建议先使用save方法保存后，再通过close方法关闭word
# 代码调用样例如下：
word_file_path = r"D:\2_测试文件归档\测试Word.docx"
word = rpa.app.microsoft.word.open(word_file_path, visible=True)

word.save()
word.close()

save(file=None)

方法描述

保存或另存为

参数说明

file<str>另存为的路径

调用样例- rpa.app.microsoft.word.Word.save-

# 注意事项：使用前需确认已安装MicroSoft相关软件
# 代码调用样例如下：
word_file_path = r"D:\2_测试文件归档\测试Word.docx"
word = rpa.app.microsoft.word.open(word_file_path, visible=True)
new_path = r"D:\2_测试文件归档\测试Word-副本.docx"

word.save()
word.save(file=new_path)

word.close()

write(text, size=8, family='微软雅黑', color=1)

方法描述

写入内容

参数说明

text<str>要输入的内容

size<int>字体大小

family<str>字体种类

color<int>字体颜色编号

调用样例- rpa.app.microsoft.word.Word.write-

# 注意事项：使用前需确认已安装MicroSoft相关软件
# 此方法默认在文档末尾写入一行
# 代码调用样例如下：
word_file_path = r"D:\2_测试文件归档\测试Word.docx"
word = rpa.app.microsoft.word.open(word_file_path, visible=True)

text = "RPA测试Word文档写入功能"
word.write(text)

read()

方法描述

读取word内容

返回值说明

返回读取内容<str>

调用样例- rpa.app.microsoft.word.Word.read-

# 注意事项：使用前需确认已安装MicroSoft相关软件
# 若word中有表格内容，则此方法会将其读取为文本
# 代码调用样例如下：
word_file_path = r"D:\2_测试文件归档\测试Word.docx"
word = rpa.app.microsoft.word.open(word_file_path, visible=True)

text = word.read()

search(key, from_pos='start', index=1, relative='left')

方法描述

查找关键字并移动光标

参数说明

key<str>查找的关键字

from_pos<str>查找方向

可选项：

• start : 开头

• current : 当前

index<int>第几个匹配 默认1

relative<str>光标对于关键字的方向

可选项：

• left : 左边

• right : 右边

调用样例- rpa.app.microsoft.word.Word.search-

# 注意事项：使用前需确认已安装MicroSoft相关软件
# 代码调用样例如下，会在word文档内容中找到对应关键词并默认将光标移动到关键词左侧：
word_file_path = r"D:\2_测试文件归档\测试Word.docx"
word = rpa.app.microsoft.word.open(word_file_path, visible=True)

word.search("写入")

replace(key, replacement, match_case=False, match_whole_word=False)

方法描述

替换

参数说明

key<str>要替换的关键词

replacement<str>要替换成的结果

match_case<bool>是否大小写匹配

match_whole_word<bool>是否全词匹配

调用样例- rpa.app.microsoft.word.Word.replace-

# 注意事项：使用前需确认已安装MicroSoft相关软件
# 代码调用样例如下：
word_file_path = r"D:\2_测试文件归档\测试Word.docx"
word = rpa.app.microsoft.word.open(word_file_path, visible=True)

new_text = "测试更新"
word.replace("写入",new_text)

file_name()

方法描述

查找word文件名

返回值说明

word文件名<str>

调用样例- rpa.app.microsoft.word.Word.file_name-

# 注意事项：使用前需确认已安装MicroSoft相关软件
# 代码调用样例如下：
word_file_path = r"D:\2_测试文件归档\测试Word.docx"
word = rpa.app.microsoft.word.open(word_file_path, visible=True)

word_name = word.file_name()

cursor_move(step_count, direction='right')

方法描述

移动光标

参数说明

step_count<int>移动步数

direction<str>移动方向

可选项：

• left : 左

• right : 右

• top : 上

• down : 下

调用样例- rpa.app.microsoft.word.Word.cursor_move-

# 注意事项：使用前需确认已安装MicroSoft相关软件
# 代码调用样例如下：
word_file_path = r"D:\2_测试文件归档\测试Word.docx"
word = rpa.app.microsoft.word.open(word_file_path, visible=True)

word.cursor_move(1,direction="top")

get_table(index)

方法描述

根据索引获取表格

参数说明

index<int>表格索引

返回值说明

返回表格对象<Table>

调用样例- rpa.app.microsoft.word.Word.get_table-

# 注意事项：使用前需确认已安装MicroSoft相关软件
# 代码调用样例如下：
word_file_path = r"D:\2_测试文件归档\测试Word.docx"
word = rpa.app.microsoft.word.open(word_file_path, visible=True)
# 注意microsoft中第一个表格索引是从1开始的
table = word.get_table(1)

add_picture(file=None, source='local', percentage=100, add_in_new_line=False)

方法描述

插入图片

参数说明

file<str>图片路径

source<str>图片来源

可选项：

• local：本地图片

• clipboard：剪贴板

percentage<int>百分比大小

add_in_new_line<bool>换行输入

调用样例- rpa.app.microsoft.word.Word.add_picture-

# 注意事项：使用前需确认已安装MicroSoft相关软件
# 此方法将在当前光标位置插入图片
# 代码调用样例如下：
word_file_path = r"D:\2_测试文件归档\测试Word.docx"
word = rpa.app.microsoft.word.open(word_file_path, visible=True)

pic_path = r"D:\2_测试文件归档\测试图片.png"
word.add_picture(pic_path, source='local', percentage=100, add_in_new_line=False)

to_pdf(file)

方法描述

转化成pdf

参数说明

file<str>保存的pdf路径

调用样例- rpa.app.microsoft.word.Word.to_pdf-

# 注意事项：使用前需确认已安装MicroSoft相关软件
# 代码调用样例如下：
word_file_path = r"D:\2_测试文件归档\测试Word.docx"
word = rpa.app.microsoft.word.open(word_file_path, visible=True)

pdf_path = r"D:\2_测试文件归档\word文档.pdf"
word.to_pdf(pdf_path)

get_table_content_by_keys(keys, combine=False)

方法描述

根据前后关键字获得表格的内容

参数说明

keys<list>关键字组合 格式为[(start1,end1),(start2,end2)]

combine<bool>是否需要合并单元格 默认false

返回值说明

返回一个二维数组<list>

调用样例- rpa.app.microsoft.word.Word.get_table_content_by_keys-

# 注意事项：使用前需确认已安装MicroSoft相关软件
# 此方法是取两个关键词所在的自然段之间包含的第一张表格的内容，并非按照表格里的关键词进行匹配
# 代码调用样例如下，本例中，word文档内，在一行输入文本标题"表格1"之后，插入了一张表格，然后另起一行，输入了文本标题"表格2"：
word_file_path = r"D:\2_测试文件归档\测试Word.docx"
word = rpa.app.microsoft.word.open(word_file_path, visible=True)

keys = [("表格1","表格2")]
tables = word.get_table_content_by_keys(keys)

add_table(row_num, col_num)

方法描述

在当前区域插入表格

参数说明

row_num<int>添加表格的行数

col_num<int>添加表格的列数

返回值说明

返回表格对象<Table>

调用样例- rpa.app.microsoft.word.Word.add_table-

# 注意事项：使用前需确认已安装WPS相关软件
# 代码调用样例如下：
word_file_path = r"D:\2_测试文件归档\测试Word.docx"
word = rpa.app.microsoft.word.open(word_file_path, visible=True)

table = word.add_table(2,3)