mlreportgen.dom.CustomElement class

Package: mlreportgen.dom
Superclasses:

Custom element of document

expand all in page

Description

Use a custom element to extend the DOM API. You can create a custom HTML or Microsoft® Word element that provides functionality not yet included in the DOM API.

Construction

customElementObj = CustomElement() creates an empty element.

customElementObj = CustomElement(name) creates a custom element having the specified name.

Input Arguments

expand all

Name of an element supported by the type of document to which this custom element is appended. For example, specify 'div' for a custom HTML div element or 'w:p' for a custom Word paragraph element.

Output Arguments

expand all

Custom element, represented by an mlreportgen.dom.CustomElement object.

Properties

expand all

Custom attributes of this document element, specified as an array of mlreportgen.dom.CustomAttribute objects. The custom attributes must be supported by the output format.

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.

Element name, specified as a character vector.

This property is ignored.

This property is ignored.

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.

Methods

Method

Purpose

append

Append a custom element to the document element

clone

Use CustomElement.clone similar to how you use Paragraph.clone.

Copy custom element.

Examples

collapse all

Open Live Script

This example shows how to add a custom element that provides a check box in an HTML report.

Create and a custom element and append text to it. 

import mlreportgen.dom.*;
d = Document('test');

input1 = CustomElement('input');
input1.CustomAttributes = { 
         CustomAttribute('type','checkbox'), ...
         CustomAttribute('name','vehicle'), ...
         CustomAttribute('value','Bike'), ...
         };
append(input1, Text('I have a bike'));

Append the custom element to an ordered list and display the report. 

ol = OrderedList({input1});
append(d,ol);

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

See Also

|

MATLAB Report Generator Documentation

Support