mlreportgen.utils.WordDoc Class

Namespace: mlreportgen.utils

Wrap a Microsoft Word doc file

Description

This utility wraps a Word document file (.docx or .rtf) into an object. You can then manipulate the object using the methods of this utility.

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

Creation

Description

docobj = mlreportgen.utils.WordDoc(filename) wraps a Word document file and returns it as a Word doc object. Only one WordDoc object can exist for each Word document file.

Input Arguments

filename — Path to Word document file

character vector | string scalar

Path to a Word document file, specified as a character vector or string scalar.

Properties

FileName — Path to Word document file

character vector | string scalar

Path to a Word document file, specified as a character vector or string scalar.

Attributes:

GetAccess	public
SetAccess	private

Data Types: char | string

Methods

Public Methods

show	Make Word document visible show(wordDoc)
hide	Hide Word document hide(wordDoc)
close	Close Word document close(wordDoc) or close(wordDoc,true) closes the Word document only if there are no unsaved changes close(wordDoc,false) closes the Word document even if there are unsaved changes
save	Save Word document save(wordDoc)
update	Update Word document fields update(wordDoc) update(wordDoc,0) forces update even if there are unsaved document fields
print	Print Word document print(wordDoc) prints the specified Word document and does not scale the contents to fit to A4 or 8.5-by-11 paper sizes print(wordDoc,"ScaleToFitPaper", true) prints the specified Word document and scales the contents to fit A4 or 8.5-by-11 paper sizes print(wordDoc,"ScaleToFitPaper", false) prints the specified Word document and does not scale the contents to fit to A4 or 8.5-by-11 paper sizes
saveAsDoc	Save Word document with specified file name saveAsDoc(wordDoc) save the doc file with the same file name docFullPath = saveAsDoc(wordDoc,docFileName) saves the doc file with the specified file name
exportToPDF	Export to PDF document exportToPDF(wordDoc) export to PDF document with same file name pdfFullPath = exportToPDF(wordDoc,pdfFileName) export to PDF document with specified file name
unlinkFields	Remove links from fields in the Word document unlinkFields(wordDoc) removes links from all fields unlinkFields(wordDoc,fieldType1) removes links from all instances of fieldType1 fields. For example, unlinkFields(wordDoc,’wdHyperLink’) removes all hyperlink fields unlinkFields(wordDoc,fieldType1,fieldType2) removes links from all instances of both fieldType1 and fieldType2 fields See Word FieldType Enumeration for information on Word fields
unlinkSubdocuments	Remove links to subdocuments and copy subdocuments into main document unlinkSubdocuments(wordDoc)
isOpen	Test if Word document is open isOpen(wordDoc)
isReadOnly	Test if Word document is read-only isReadOnly(wordDoc)
isSaved	Test if Word document is saved isSaved(wordDoc)
isVisible	Test if Word document is visible isVisible(wordDoc)
netobj	Return a .NET Word document object, which allows using the .NET interface on this object netobj(wordDoc)

Examples

Create WordDoc Object and .NET Object

This example creates a WordDoc object from the existing MyWordDoc.docx file.

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

Limitations

• mlreportgen.utils.WordDoc is only available on Microsoft^® Windows^®.

• mlreportgen.utils.WordDoc is not supported in a MATLAB^® web app.

Version History

Introduced in R2018b