mlreportgen.utils.word 类

命名空间: mlreportgen.utils

与 Microsoft Word 和 Word 文档进行交互

描述

使用 mlreportgen.utils.word 类的静态方法与 Microsoft^® Word 应用程序和 Word 文档进行交互。这些方法使用 MATLAB^® 接口到 Microsoft .NET Framework 与 Word 进行交互。

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

类属性

HandleCompatible true

有关类属性的信息，请参阅类属性。

方法

全部展开

公共方法

`mlreportgen.utils.word.start`	如果尚未启动 Word 应用程序，`wordApp = mlreportgen.utils.word.start()` 将启动它并返回 `mlreportgen.utils.WordApp` 对象。`WordApp` 对象包装了 .NET 对象，而该 .NET 对象又包装了 Word 编辑器。Word 应用程序被隐藏。
`mlreportgen.utils.word.load`	`wordDoc = mlreportgen.utils.word.load(filename)` 加载 `filename` 指定的现有 Word 文档文件并返回 `mlreportgen.utils.WordDoc` 对象。`WordDoc` 对象包装了 .NET 对象，而该 .NET 对象又包装了 Word 文档。以字符向量或字符串标量形式指定 `filename`。
`mlreportgen.utils.word.open`	`wordDoc = mlreportgen.utils.word.open(filename)` 加载 `filename` 指定的 Word 文档，使其可见，并返回 `mlreportgen.utils.WordDoc` 对象。 `WordDoc` 对象包装了 .NET 对象，而该 .NET 对象又包装了 Word 文档。以字符向量或字符串标量形式指定 `filename`。
`mlreportgen.utils.word.close`	这些语法关闭 Word 应用程序，如果应用程序已关闭则返回 `true`，如果应用程序保持打开状态则返回 `false`：仅当没有未保存的 Word 文档时，`tf = mlreportgen.utils.word.close()` 才会关闭 Word 应用程序。仅当没有未保存的 Word 文档或没有在 MATLAB 之外打开的 Word 文档时， `tf = mlreportgen.utils.word.close(true)` 才会关闭 Word 应用程序。即使有未保存的 Word 文档或在 MATLAB 之外打开的 Word 文档， `tf = mlreportgen.utils.word.close(false)` 也会关闭 Word 应用程序。这些语法关闭 `filename` 指定的 Word 文档，如果 Word 文档已关闭则返回 `true`，如果 Word 文档保持打开状态则返回 `false`，如果没有打开的 Word 文档则隐藏 Word 应用程序： `tf = mlreportgen.utils.word.close(filename)` 仅当没有未保存的更改时才关闭指定的 Word 文档文件。 `tf = mlreportgen.utils.word.close(filename,true)` 仅当没有未保存的更改时才关闭指定的 Word 文档文件。即使有未保存的更改， `tf = mlreportgen.utils.word.close(filename,false)` 也会关闭指定的 Word 文档文件。以字符向量或字符串标量形式指定 `filename`。
`mlreportgen.utils.word.closeAll`	这些语法关闭所有打开的 Word 文档，如果所有 Word 文档都已关闭则返回 `true`，如果 Word 文档仍然打开则返回 `false`，如果没有打开的 Word 文档则隐藏 Word 应用程序： `tf = mlreportgen.utils.word.closeAll()` 关闭所有 Word 文档文件。仅当没有未保存的更改时， `tf = mlreportgen.utils.word.closeAll(true)` 才会关闭所有 Word 文档文件。即使没有未保存的更改， `tf = mlreportgen.utils.word.closeAll(false)` 也会关闭所有 Word 文档文件。以字符向量或字符串标量形式指定 `filename`。
`mlreportgen.utils.word.show`	`wordApp = mlreportgen.utils.word.show()` 使 Word 应用程序可见并返回关联的 `mlreportgen.utils.WordApp` 对象。 `wordApp = mlreportgen.utils.word.show(filename)` 使 `filename` 指定的 Word 文档文件可见并返回关联的 `mlreportgen.utils.WordDoc` 对象。以字符向量或字符串标量形式指定 `filename`。
`mlreportgen.utils.word.hide`	`wordApp = mlreportgen.utils.word.hide()` 隐藏 Word 应用程序并返回与该应用程序关联的 `mlreportgen.utils.WordApp` 对象。 `wordApp = mlreportgen.utils.word.hide(filename)` 隐藏 `filename` 指定的 Word 文档文件并返回关联的 `mlreportgen.utils.WordDoc` 对象。以字符向量或字符串标量形式指定 `filename`。
`mlreportgen.utils.word.filenames`	`files = mlreportgen.utils.word.filenames()` 以字符串数组的形式返回打开的 Word 文档文件名。
`mlreportgen.utils.word.isAvailable`	如果 Word 可用，则 `tf = mlreportgen.utils.word.isAvailable()` 返回 `true`；如果 Word 不可用，则返回 `false`。
`mlreportgen.utils.word.isStarted`	如果 Word 应用程序已启动，则 `tf = mlreportgen.utils.word.isStarted()` 返回 `true`，如果 Word 应用程序未启动，则返回 `false`。
`mlreportgen.utils.word.isLoaded`	如果加载了 `tf = mlreportgen.utils.word.isLoaded(filename)` 指定的 Word 文档，则 `true` 返回 `filename`，如果未加载，则返回 `false`。以字符向量或字符串标量形式指定 `filename`。
`mlreportgen.utils.word.wordapp`	`wordApp = mlreportgen.utils.word.wordapp()` 返回与 Word 应用程序关联的 `mlreportgen.utils.WordApp` 对象，如果该应用程序未启动，则返回错误。
`mlreportgen.utils.word.worddoc`	`wordDoc = mlreportgen.utils.word.worddoc(filename)` 返回与 `filename` 指定的 Word 文档文件关联的 `mlreportgen.utils.WordDoc` 对象，如果 Word 文档文件未打开，则返回错误。以字符向量或字符串标量形式指定 `filename`。

示例

全部折叠

打开 Word 文档

假设 Word 文件 test.docx 和 test1.docx 位于 mydocs 驱动器上名为 C: 的文件夹中。使用 mlreportgen.utils.word.open 打开文件。

wordDoc = mlreportgen.utils.word.open("test")
wordDoc1 = mlreportgen.utils.word.open("test1")

wordDoc = 

  WordDoc with properties:

    FileName: "C:\mydocs\test.docx"


wordDoc1 = 

  WordDoc with properties:

    FileName: "C:\mydocs\test1.docx"

获取文档文件名

假设 Word 文件 test.docx 和 test1.docx 位于 mydocs 驱动器上名为 C: 的文件夹中，并且您使用 mlreportgen.utils.word.open 打开它们。

使用 mlreportgen.utils.word.filenames 获取打开的 Word 文档文件的文件名。

files = mlreportgen.utils.word.filenames()

files = 

  1×2 string array

    "C:\mydocs\test.docx"    "C:\mydocs\test1.docx"

限制

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

版本历史记录

在 R2018b 中推出

另请参阅

mlreportgen.utils.WordDoc | mlreportgen.utils.WordApp

主题

Microsoft .NET 快速入门