mlreportgen.dom.PageRawFormat class

Package: mlreportgen.dom
Superclasses:

XML markup for array of Microsoft Word formats

Description

XML markup for an array of Microsoft^® Word formats.

Construction

RawFormatObj = PageRawFormat() creates an empty array of raw formats.

Output Arguments

RawFormatObj — XML markup for Word formats

mlreportgen.dom.PageRawFormat object

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

Properties

Id — ID for this document element

character vector | string scalar

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

Markup — Word XML markup

cell array of character vectors

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 — Tag for this document element

character vector | string scalar

Tag for this document element, specified as a character vector or string scalar.

The DOM generates a session-unique tag as part of the creation of this object. The generated tag has the form CLASS:ID, where CLASS is the object class and ID is the value of the Id property of the object. Specifying your own tag value can help you to identify where an issue occurred during document generation.

Examples

Turn on Line Numbering Based on Default DOM Template

In this example, the RawFormats property of the CurrentPageLayout object 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.CurrentPageLayout;
s.RawFormats = [s.RawFormats ...
{'<w:lnNumType w:countBy="1" w:start="0" w:restart="newSection"/>'}];
p = Paragraph('This document has line numbers');
append(d,'This document has line numbers');
append(d,clone(p));

close(d);
rptview(d.OutputPath);