Files
playbook/docs/tsl/codegen/builtin/document/word.md
T

173 lines
4.2 KiB
Markdown

# Builtin - 文档 / Word
## `loadClientData(client_data)`
获得当前客户端程序复制的数据。
| 参数 | 类型 | 说明 |
| ------------- | ---- | ---------------- |
| `client_data` | any | 返回的数据内容。 |
返回:bool
## `wordGetCurrentDocument()`
获得当前Word模板正在生成的文档对象。
返回:comobj
## `wordSetCurrentRange(range)`
设置当前Word模板函数处理的当前位置。
| 参数 | 类型 | 说明 |
| ------- | ------ | ---- |
| `range` | comobj | 对象 |
返回:any
## `wordGetLastRange()`
获得上次Word模板函数处理生成的内容位置对象。
返回:comobj
## `wordGetLastTable()`
获得最后由Word模板函数插入的表格对象。
返回:comobj
## `wordGetLastShape()`
获得最后由Word模板函数插入的InlineShape对象,包括Excel对象,ExcelChart对象以及图形对象等。
返回:comobj
## `wordWrite(param1, param2)`
在Word中输出内容。参数个数不定,可以输出字符串,数字以及数组/表格,图形等类型
| 参数 | 类型 | 说明 |
| -------- | ---- | --------- |
| `param1` | any | any 参数1 |
| `param2` | any | any 参数2 |
返回:bool
## `wordBr()`
在Word中换行(新段落)。
返回:bool
## `wordSetFont(_property, value)`
设置Word的当前字体的属性。返回真表示成功。
| 参数 | 类型 | 说明 |
| ----------- | ------ | ---------------------------------------- |
| `_property` | string | 字体的属性名。例如’Size’表示字体的大小。 |
| `value` | any | 字体属性的值。 |
返回:bool
## `wordGetFont(_property, value)`
获取Word的当前字体的属性。返回真表示成功。
| 参数 | 类型 | 说明 |
| ----------- | ------ | ---------------------------------------- |
| `_property` | string | 字体的属性名。例如’Size’表示字体的大小。 |
| `value` | any | 返回的字体属性的值。 |
返回:bool
## `wordPaste()`
将剪裁板中的内容粘贴到Word中。返回真表示成功。
返回:bool
## `wordAddOleObjectFromFile(file_name, width, height)`
在Word中插入由文件产生的Ole对象。如果不指定宽度和高度,则由该对象自己决定。
| 参数 | 类型 | 说明 |
| ----------- | --------- | ------------------------------------------ |
| `file_name` | string | 字符串类型,需要插入的图形文件的全路径名。 |
| `width` | integer=0 | 整数,宽度 |
| `height` | integer=0 | 整数,高度 |
返回:bool
## `wordSetRangeProp(name, value)`
设置当前位置的区域的属性。
| 参数 | 类型 | 说明 |
| ------- | ------ | ---- |
| `name` | string | |
| `value` | any | |
返回:bool
## `wordGetRangeProp(name, value)`
获取当前位置的区域的属性。
| 参数 | 类型 | 说明 |
| ------- | ------ | ---- |
| `name` | string | |
| `value` | any | |
返回:bool
## `wordSetLastTableProp(name, value)`
设置最后插入的表格的属性。
| 参数 | 类型 | 说明 |
| ------- | ------ | ---- |
| `name` | string | |
| `value` | any | |
返回:bool
## `wordGetLastTableProp(name, value)`
获取最后插入的表格的属性。
| 参数 | 类型 | 说明 |
| ------- | ------ | ---- |
| `name` | string | |
| `value` | any | |
返回:bool
## `wordSetLastTableCellProp(row, column, name, value)`
设置最后插入的表格的指定单元格的属性。
| 参数 | 类型 | 说明 |
| -------- | ------- | ---- |
| `row` | | |
| `column` | integer | |
| `name` | string | |
| `value` | any | |
返回:bool
## `wordGetLastTableCellProp(row, column, name, value)`
获取最后插入的表格的指定单元格的属性。
| 参数 | 类型 | 说明 |
| -------- | ------- | ---- |
| `row` | | |
| `column` | integer | |
| `name` | string | |
| `value` | any | |
返回:bool