matlab.unittest.plugins.testreport.DOCXTestReportPlugin class

Package: matlab.unittest.plugins.testreport
Superclasses: matlab.unittest.plugins.TestReportPlugin

TestReportPlugin that creates a test report in .docx format

Description

A DOCXTestReportPlugin is an instance of the TestReportPlugin class that creates a test result report in .docx format. To create a DOCXTestReportPlugin instance, use the matlab.unittest.plugins.TestReportPlugin.producingDOCX static method.

Properties

PageOrientation — Report orientation

'portrait' (default) | 'landscape'

Report orientation, specified as 'portrait' or 'landscape'. This property is read only. You can specify it during plugin construction.

These properties are inherited from matlab.unittest.plugins.TestReportPlugin:

IncludeCommandWindowText — Indicator if text output from Command Window is included

false (default) | true

This property is read-only.

Indicator if text output from Command Window is included, specified as false or true (logical 0 or 1). By default, IncludeCommandWindowText is false and the text output from the Command Window is excluded from the report. To include Command Window text in the report, specify IncludeCommandWindowText as true during plugin construction.

IncludePassingDiagnostics — Indicator if diagnostics for passing events are included

false (default) | true

This property is read-only.

Indicator if diagnostics for passing events are included, specified as false or true (logical 0 or 1). By default, IncludePassingDiagnostics is false and the diagnostics from passing events are excluded from the output. To include diagnostics from passing events in the output, specify IncludePassingDiagnostics as true during plugin construction.

LoggingLevel — Maximum verbosity level for logged diagnostics included by the plugin

matlab.unittest.Verbosity.Terse (default) | matlab.unittest.Verbosity enumeration object

This property is read-only.

Maximum verbosity level for logged diagnostics included by the plugin, returned as a matlab.unittest.Verbosity enumeration object. The plugin includes diagnostics that are logged at this level and below. By default this property value is matlab.unittest.Verbosity.Terse. You can specify a different logging level during plugin construction.

Logged diagnostics are diagnostics that you supply to the testing framework with a call to the log (TestCase) or log (Fixture) method.

Copy Semantics

Handle. To learn how handle classes affect copy operations, see Copying Objects.