mlreportgen.dom.DOCXRawFormat Class

Namespace: mlreportgen.dom
Superclasses:

XML markup for array of Microsoft Word formats

Compatibility

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

docxRawFormatObj — XML markup for Word formats

mlreportgen.dom.DOCXRawFormat object

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

Properties

Id — Identifier for mlreportgen.dom.DOCXRawFormat object

character vector | string scalar

Object identifier for mlreportgen.dom.DOCXRawFormat object, specified as a character vector or string scalar. The DOM API generates a session-unique identifier when it creates the document element object. You can specify your own value for Id.

Attributes:

NonCopyable

true

Data Types: char | string

Markup — Word XML markup character vectors

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://ecma-international.org/publications-and-standards/standards/ecma-376/.

Tag — Tag for mlreportgen.dom.DOCXRawFormat object

character vector | string scalar

Tag for mlreportgen.dom.DOCXRawFormat object, specified as a character vector or string scalar. The DOM API 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. Specify your own tag value to help you identify where to look when an issue occurs during document generation.

Attributes:

NonCopyable

true

Data Types: char | string

Examples

Turn on Line Numbering Based on Default DOM Template

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.CurrentPageLayout;
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');