Report Generator Utilities

Functions for accessing Word, PDF, PowerPoint, and HTML applications and documents, and manipulating strings

These utility functions enable you to access and manipulate documents and applications directly, and to obtain, manipulate, and test files, characters, and strings.

Classes

expand all

Word and PDF Utilities

`mlreportgen.utils.WordApp`	Wrap Microsoft Word application
`mlreportgen.utils.WordDoc`	Wrap a Microsoft Word doc file
`mlreportgen.utils.word`	Interact with Microsoft Word and Word documents
`mlreportgen.utils.PDFDoc`	Wrap PDF file for viewing

PowerPoint Utilities

`mlreportgen.utils.PPTApp`	Wrap PowerPoint application
`mlreportgen.utils.PPTPres`	Wrap PowerPoint presentation file
`mlreportgen.utils.powerpoint`	Interact with PowerPoint application and presentations

HTML Utilities

`mlreportgen.utils.HTMLDoc`	Wrap HTML file for viewing
`mlreportgen.utils.HTMXDoc`	Wrap HTMX document file for viewing

Report Viewer and Units Utilities

`mlreportgen.utils.rptviewer`	Report document viewer manager
`mlreportgen.utils.units`	Convert units

Table Utilities

`mlreportgen.utils.TableSlice`	Table slicer object output
`mlreportgen.utils.TableSlicer`	Divide table into slices

Functions

expand all

HTML Utilities

mlreportgen.utils.tidy Correct and clean XML and HTML content

File Utilities

`mlreportgen.utils.fileToURI`	Convert file path to Universal Resource Identifier (URI)
`mlreportgen.utils.findFile`	Find file path
`mlreportgen.utils.isFileLocked`	Determine if file is locked

String Utilities

`mlreportgen.utils.capitalizeFirstChar`	Capitalize first character of string
`mlreportgen.utils.hash`	Hash a piece of text
`mlreportgen.utils.makeSingleLineText`	Convert input to single line
`mlreportgen.utils.normalizeLinkID`	Normalize a link target ID
`mlreportgen.utils.normalizeString`	Remove extra spaces and line feeds from text
`mlreportgen.utils.toString`	Create string representation of MATLAB variable