mlreportgen.dom.DOCXRawFormat class

Package: mlreportgen.dom
Superclasses:

XML markup for array of Microsoft Word formats

Note

mlreportgen.dom.DOCXRawFormat will be removed in a future release. Use mlreportgen.dom.PageRawFormat instead.

Description

XML markup for an array of Microsoft® Word formats.

Construction

docxRawFormatObj = DOCXRawFormat() creates an empty array of raw formats.

Output Arguments

expand all

XML markup for Word formats, represented by an mlreportgen.dom.DOCXRawFormat object.

Properties

expand all

ID for this document element, specified as a character vector. The DOM generates a session-unique ID when it creates the document element. You can specify your own ID.

Specify a cell array of character vectors. Each character vector contains Word XML markup for a Word format.

For information about XML markup for Word formats, see https://www.ecma-international.org/publications/standards/Ecma-376.htm.

Tag for document element, specified as a character vector.

A session-unique ID is generated as part of document element creation. The generated tag has the form CLASS:ID, where CLASS is the class of the element and ID is the value of the Id property of the object. You can specify a tag to replace the generated tag.

For example, to make it easier to identify where an issue occurred during document generation, you can specify your own tag value.

Examples

collapse all

In this example, the RawFormats property of a DOCXSection is initialized with the markup for properties specified by the default template. This code appends the line numbering property to the existing properties.

import mlreportgen.dom.*;
d = Document('myreport','docx');
open(d); 

s = d.CurrentDOCXSection;
s.RawFormats = [s.RawFormats ...
{'<w:lnNumType w:countBy="1" w:start="1" w:restart="newSection"/>'}];
append(d,'This document has line numbers');

close(d);
rptview('myreport','docx');