全部产品
云市场
云游戏

rpa.word

更新时间:2020-03-03 15:25:55

目录

word

要使用word模块,需要rpa.word

word模块是用来向用户提供一系列操作Word的SDK,让用户通过简单的参数和方法调用来实现一些复杂的操作。

open

方法名
open(file, visible=False)

方法描述
该方法会启动一个Word进程并打开文档,可以通过visible来控制这个Word进程是可见。

版本信息
该方法适用于从3.3.0及以上版本。

参数说明

  • file : 文件路径
  • visible : 是否可见

返回值说明
返回一个Word类型的对象
示例

  1. doc = rpa.word.open(r'C:\xxx.docx')

create

方法名
create(visible=False)

方法描述
该方法会启动一个Word进程并打开文档,可以通过visible来控制这个Word进程是可见。

版本信息
该方法适用于从3.3.0及以上版本。

参数说明

  • file : 文件路径
  • visible : 是否可见

返回值说明
返回一个Word类型的对象
示例

  1. doc = rpa.word.create(visible=True)

Class: Word

Word : 负责为用户提供Word相关的一些操作。

Word实例不再被使用时,建议close()它,否则会不断产生残留的Word进程。

save

方法名
create(visible=False)

方法描述
该方法用于保存对Word的修改,如果是另存为或者新创建的Word,需要传入文件路径。

版本信息
该方法适用于从3.3.0及以上版本。

参数说明

  • file : 另存为文件路径

返回值说明

示例

  1. # 保存修改
  2. doc.save()
  3. # 另存为修改
  4. doc.save(file=r"c:\xxxx.docx")

close

方法名
close()

方法描述
该方法用于关闭Word文档并释放进程。

版本信息
该方法适用于从3.3.0及以上版本。

参数说明

返回值说明

示例

  1. doc.close()

write

方法名
write(text, size=8, family=”微软雅黑”, color=1)

方法描述
该方法用于Word内写入内容。

版本信息
该方法适用于从3.3.0及以上版本。

参数说明

  • text : 要输入的内容
  • size : 字体大小
  • family: 字体种类
  • color : 字体颜色编号

返回值说明

示例

  1. doc.write("11222")

read

方法名
read()

方法描述
该方法读取word内容。

版本信息
该方法适用于从3.3.0及以上版本。

参数说明

  • text : 要输入的内容
  • size : 字体大小
  • family: 字体种类
  • color : 字体颜色编号

返回值说明
返回Word文档中的内容
示例

  1. print(doc.read())

方法名
search(self, from_pos=”start”, index=1, relative=”left”)

方法描述
该方法查找关键字并移动光标到关键字的左边或者右边。

版本信息
该方法适用于从3.3.0及以上版本。

参数说明

  • key : 查找的关键字
  • from_pos : 从哪开始查找 开头或者当前 只能填start|current
  • index: 第几个匹配 默认1
  • relative:光标在关键字左边还是右边 只能填left|right

返回值说明

示例

  1. doc.search("xxx")

cursor_move

方法名
cursor_move(step_count, direction=”right”)

方法描述
该方法移动光标,朝某一个方向移动一定的步数,默认向右移动光标。

版本信息
该方法适用于从3.3.0及以上版本。

参数说明

  • step_count : 移动步数
  • direction : 移动方向 上下左右 只能填 left|right|top|down

返回值说明

示例

  1. doc.cursor_move(3)

add_picture

方法名
add_picture(file)

方法描述
该方法向Word中插入图片。

版本信息
该方法适用于从3.3.0及以上版本。

参数说明

  • file : 图片路径

返回值说明

示例

  1. doc.add_picture(r"C:\aaa.jpg")

to_pdf

方法名
to_pdf(file)

方法描述
该方法将Word转成pdf文件。

版本信息
该方法适用于从3.3.0及以上版本。

参数说明

  • file : 保存的pdf路径

返回值说明

示例

  1. doc.to_pdf(r'C:\aaa.pdf')

get_table

方法名
get_table(index)

方法描述
该方法根据索引获取表格。

版本信息
该方法适用于从3.3.0及以上版本。

参数说明

  • index : 表格索引

返回值说明
返回Table对象
示例

  1. table = doc.get_table(1)

get_table_content_by_keys

方法名
get_table_content_by_keys(keys, combine=False)

方法描述
该方法根据前后关键字获得表格的内容,会以给定的关键字数组中第一组匹配的进行查找表格。

版本信息
该方法适用于从3.3.0及以上版本。

参数说明

  • keys :关键字组合 格式为[(start1,end1),(start2,end2)]
  • combine : 是否需要合并单元格 默认false

返回值说明
返回一个二维数组
示例

  1. print(doc.get_table_content_by_keys([("A","B"),("A","C")]))

Class: Table

Table : 负责为用户提供Word中表格相关的一些操作。

row_count

方法名
row_count()

方法描述
该方法获取表格的行数。

版本信息
该方法适用于从3.3.0及以上版本。

参数说明

返回值说明
返回表格行数
示例

  1. print(table.row_count())

col_count

方法名
col_count()

方法描述
该方法获取表格的列数。

版本信息
该方法适用于从3.3.0及以上版本。

参数说明

返回值说明
返回表格的列数
示例

  1. print(table.col_count())

add_row

方法名
add_row()

方法描述
该方法增加一个空行。

版本信息
该方法适用于从3.3.0及以上版本。

参数说明

返回值说明

示例

  1. table.add_row()

add_col

方法名
add_col()

方法描述
该方法增加一个空列。

版本信息
该方法适用于从3.3.0及以上版本。

参数说明

返回值说明

示例

  1. table.add_col()

read

方法名
read(row,col)

方法描述
该方法获取指定单元格内容。

版本信息
该方法适用于从3.3.0及以上版本。

参数说明

  • row : 行的索引
  • col : 列的索引

返回值说明
返回word表格指定行列的内容
示例

  1. print(table.read(1,1))

write

方法名
write(row, col, text, size=8, family=”微软雅黑”, color=1)

方法描述
该方法向指定单元格写入内容。

版本信息
该方法适用于从3.3.0及以上版本。

参数说明

  • row : 行的索引
  • col : 列的索引
  • text : 要输入的内容
  • size : 字体大小
  • family: 字体种类
  • color : 字体颜色编号

返回值说明

示例

  1. table.write(1,1,"333")