mlreportgen.utils.WordDoc 类

命名空间: mlreportgen.utils

包装 Microsoft Word 文档文件

全页展开

描述

此实用工具将 Word 文档文件（.docx 或 .rtf）包装到对象中。然后您可以使用该实用工具的方法来操作该对象。

mlreportgen.utils.WordDoc 类是一个 handle 类。

创建对象

描述

docobj = mlreportgen.utils.WordDoc(filename) 包装 Word 文档文件并将其作为 Word doc 对象返回。每个 Word 文档文件只能存在一个 WordDoc 对象。

示例

输入参量

全部展开

`filename` — Word 文档文件的路径
字符向量 | 字符串标量

Word 文档文件的路径，指定为字符向量或字符串标量。

属性

全部展开

`FileName` — Word 文档文件的路径
字符向量 | 字符串标量

Word 文档文件的路径，指定为字符向量或字符串标量。

属性：

`GetAccess`	`public`
`SetAccess`	`private`

数据类型: char | string

方法

全部展开

公共方法

`show`	使 Word 文档可见 `show(wordDoc)`
`hide`	隐藏 Word 文档 `hide(wordDoc)`
`close`	关闭 Word 文档 `close(wordDoc)` 或 `close(wordDoc,true)` 仅在没有未保存的更改时关闭 Word 文档 `close(wordDoc,false)` 关闭 Word 文档，即使还有未保存的更改
`save`	保存 Word 文档 `save(wordDoc)`
`update`	更新 Word 文档字段 `update(wordDoc)` `update(wordDoc,0)` 即使有未保存的文档字段也会强制更新
`print`	打印 Word 文档 `print(wordDoc)` 打印指定的 Word 文档，但不缩放内容以适合 A4 或 8.5×11 纸张尺寸 `print(wordDoc,"ScaleToFitPaper", true)` 打印指定的 Word 文档并缩放内容以适合 A4 或 8.5×11 纸张尺寸 `print(wordDoc,"ScaleToFitPaper", false)` 打印指定的 Word 文档，但不缩放内容以适合 A4 或 8.5×11 纸张尺寸
`saveAsDoc`	使用指定文件名保存 Word 文档 `saveAsDoc(wordDoc)` 用相同的文件名保存 doc 文件 `docFullPath = saveAsDoc(wordDoc,docFileName)` 以指定文件名保存 doc 文件
`exportToPDF`	导出为 PDF 文档 `exportToPDF(wordDoc)` 导出为具有相同文件名的 PDF 文档 `pdfFullPath = exportToPDF(wordDoc,pdfFileName)` 以指定文件名导出到 PDF 文档
`unlinkFields`	从 Word 文档中的字段中删除链接 `unlinkFields(wordDoc)` 从所有字段中删除链接 `unlinkFields(wordDoc,fieldType1)` 从 fieldType1 字段的所有实例中删除链接。例如，`unlinkFields(wordDoc,’wdHyperLink’)` 删除所有超链接字段 `unlinkFields(wordDoc,fieldType1,fieldType2)` 从 fieldType1 和 fieldType2 字段的所有实例中删除链接有关 Word 字段的信息，请参阅 Word FieldType Enumeration
`unlinkSubdocuments`	删除子文档的链接并将子文档复制到主文档中 `unlinkSubdocuments(wordDoc)`
`isOpen`	测试 Word 文档是否打开 `isOpen(wordDoc)`
`isReadOnly`	测试 Word 文档是否为只读 `isReadOnly(wordDoc)`
`isSaved`	测试 Word 文档是否保存 `isSaved(wordDoc)`
`isVisible`	测试 Word 文档是否可见 `isVisible(wordDoc)`
`netobj`	返回一个 .NET Word 文档对象，允许在此对象上使用 .NET 接口 `netobj(wordDoc)`

示例

全部折叠

创建 `WordDoc` 对象和 .NET 对象

此示例从现有的 MyWordDoc.docx 文件创建一个 WordDoc 对象。

docobj = mlreportgen.utils.WordDoc("MyWordDoc.docx");
netobj(docobj);

限制

mlreportgen.utils.WordDoc 仅在 Microsoft^® Windows^® 上可用。
MATLAB^® Web App 不支持 mlreportgen.utils.WordDoc。

版本历史记录

在 R2018b 中推出

另请参阅

mlreportgen.utils.word | mlreportgen.utils.WordApp

外部网站

https://learn.microsoft.com/office/vba/api/overview/word

mlreportgen.utils.WordDoc 类

描述

创建对象

描述

输入参量

filename — Word 文档文件的路径 字符向量 | 字符串标量

属性

FileName — Word 文档文件的路径 字符向量 | 字符串标量

属性：

方法

公共方法

示例

创建 WordDoc 对象和 .NET 对象

限制

版本历史记录

另请参阅

外部网站

`filename` — Word 文档文件的路径
字符向量 | 字符串标量

`FileName` — Word 文档文件的路径
字符向量 | 字符串标量

创建 `WordDoc` 对象和 .NET 对象