mlreportgen.utils.word Class

Namespace: mlreportgen.utils

Interact with Microsoft Word and Word documents

Description

Use the static methods of the mlreportgen.utils.word class to interact interacting with the Microsoft^® Word application and Word documents. These methods use the MATLAB^® interface to the Microsoft .NET Framework to interact with Word.

The mlreportgen.utils.word class is a handle class.

Class Attributes

HandleCompatible true

For information on class attributes, see Class Attributes.

Methods

expand all

Public Methods

`mlreportgen.utils.word.start`	`wordApp = mlreportgen.utils.word.start()` starts the Word application if it has not already been started and returns an `mlreportgen.utils.WordApp` object. A `WordApp` object wraps a .NET object that wraps the Word editor. The Word application is hidden.
`mlreportgen.utils.word.load`	`wordDoc = mlreportgen.utils.word.load(filename)` loads the existing Word document file specified by `filename` and returns a `mlreportgen.utils.WordDoc` object. A `WordDoc` object wraps a .NET object that wraps the Word document. Specify `filename` as a character vector or string scalar.
`mlreportgen.utils.word.open`	`wordDoc = mlreportgen.utils.word.open(filename)` loads the Word document specified by `filename`, makes it visible, and returns a `mlreportgen.utils.WordDoc` object. A `WordDoc` object wraps a .NET object that wraps the Word document. Specify `filename` as a character vector or string scalar.
`mlreportgen.utils.word.close`	These syntaxes close the Word application and return `true` if the application is closed and `false` if the application remains open: `tf = mlreportgen.utils.word.close()` closes the Word application only if there are no unsaved Word documents. `tf = mlreportgen.utils.word.close(true)` closes the Word application only if there are no unsaved Word documents or there are no Word documents open outside of MATLAB. `tf = mlreportgen.utils.word.close(false)` closes the Word application even if there are unsaved Word documents or Word documents opened outside of MATLAB. These syntaxes close the Word document specified by `filename`, return `true` if the Word document is closed, return `false` if the Word document remains open, and hide the Word application if there are no open Word documents: `tf = mlreportgen.utils.word.close(filename)` closes the specified Word document file only if there are no unsaved changes. `tf = mlreportgen.utils.word.close(filename,true)`closes the specified Word document file only if there are no unsaved changes. `tf = mlreportgen.utils.word.close(filename,false)`closes the specified Word document file even if there are unsaved changes. Specify `filename` as a character vector or string scalar.
`mlreportgen.utils.word.closeAll`	These syntaxes close all open Word documents, return `true` if all Word documents are closed, return `false` if a Word document remains open, and hide the Word application if there are no open Word documents: `tf = mlreportgen.utils.word.closeAll()` closes all Word document files. `tf = mlreportgen.utils.word.closeAll(true)` closes all Word document files only if there are no unsaved changes. `tf = mlreportgen.utils.word.closeAll(false)` closes all Word document files even if there are no unsaved changes. Specify `filename` as a character vector or string scalar.
`mlreportgen.utils.word.show`	`wordApp = mlreportgen.utils.word.show()` makes the Word application visible and returns the associated `mlreportgen.utils.WordApp` object. `wordApp = mlreportgen.utils.word.show(filename)` makes the Word document file specified by `filename` visible and returns the associated `mlreportgen.utils.WordDoc` object. Specify `filename` as a character vector or string scalar.
`mlreportgen.utils.word.hide`	`wordApp = mlreportgen.utils.word.hide()` hides the Word application and returns the `mlreportgen.utils.WordApp` object associated with the application. `wordApp = mlreportgen.utils.word.hide(filename)` hides the Word document file specified by `filename` and returns the associated `mlreportgen.utils.WordDoc` object. Specify `filename` as a character vector or string scalar.
`mlreportgen.utils.word.filenames`	`files = mlreportgen.utils.word.filenames()` returns the open Word document file names as a string array.
`mlreportgen.utils.word.isAvailable`	`tf = mlreportgen.utils.word.isAvailable()` returns `true` if Word is available for use and `false` if Word is not available for use.
`mlreportgen.utils.word.isStarted`	`tf = mlreportgen.utils.word.isStarted()` returns `true` if the Word application is started and `false` if the Word application is not started.
`mlreportgen.utils.word.isLoaded`	`tf = mlreportgen.utils.word.isLoaded(filename)` returns `true` if the Word document specified by `filename` is loaded and `false` if it is not loaded. Specify `filename` as a character vector or string scalar.
`mlreportgen.utils.word.wordapp`	`wordApp = mlreportgen.utils.word.wordapp()` returns the `mlreportgen.utils.WordApp` object associated with the Word application and an error if the application is not started.
`mlreportgen.utils.word.worddoc`	`wordDoc = mlreportgen.utils.word.worddoc(filename)` returns the `mlreportgen.utils.WordDoc` object associated with the Word document file specified by `filename` and an error if the Word document file is not open. Specify `filename` as a character vector or string scalar.

Examples

collapse all

Open Word Documents

Suppose that the Word files, test.docx and test1.docx are in a folder named mydocs on the C: drive. Open the files using 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"

Obtain Document File Names

Suppose that the Word files test.docx and test1.docx are in a folder named mydocs on the C: drive and that you opened them using mlreportgen.utils.word.open.

Obtain the file names of the open Word document files by using mlreportgen.utils.word.filenames.

files = mlreportgen.utils.word.filenames()

files = 

  1×2 string array

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

Limitations

mlreportgen.utils.word is only available on Microsoft Windows^®.
mlreportgen.utils.word is not supported in a MATLAB web app.

Version History

Introduced in R2018b