mlreportgen.dom.DOCXRawFormat Class

Namespace: mlreportgen.dom
Superclasses:

XML markup for array of Microsoft Word formats

expand all in page

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

expand all

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

Properties

expand all

Object identifier, specified as a character vector or string scalar. The DOM API generates a session-unique identifier when it creates the document element object.

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true

Data Types: char | string

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, 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. Use this value to help identify where an issue occurs during document generation.

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true

Data Types: char | string

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.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");

See Also

Topics