mlreportgen.report.BlockContent Class

Namespace: mlreportgen.report

Fill block content hole reporter

Description

Reporter for templates with a block content hole. A block hole is a hole that can contain paragraphs or any other type of content. Other reporters use this BlockContent reporter to fill block holes in their templates. Reporters have methods that return instances of this object. Using these object instances, you can customize the format of the content used to fill the block holes in their templates. For example, for the BaseTable reporter, the getContentReporter method returns the instance that the BaseTable reporter uses to fill the Content hole in its template. To customize the content format, specify a custom template for the BlockContent reporter returned by the getContentReporter method.

Note

Reporters create instances of this object. You do not need to create this object yourself.

The mlreportgen.report.BlockContent class is a handle class.

Properties

HoleId — Name of hole

character vector | string scalar

Name of hole to be filled by this reporter, specified as a character vector or string scalar.

Attributes:

GetAccess	public
SetAccess	public

Data Types: char | string

Content — Content of hole

character array | string scalar | DOM object | ...

Content of hole to be filled by this reporter, specified as one of these values:

• String or character array

• DOM object

• 1-by-N or N-by-1 array of strings or DOM objects

• 1-by-N or N-by-1 cell array of strings, character arrays, and/or DOM objects

Attributes:

GetAccess	public
SetAccess	public

TemplateSrc — Source of template for this reporter

character vector | string scalar | reporter or report | DOM document or document part

Source of the template for this reporter, specified in one of these ways:

• Character vector or string scalar that specifies the path of the file that contains the template for this reporter

• Reporter or report whose template this reporter uses or whose template library contains the template for this reporter

• Document Object Model (DOM) document or document part whose template this reporter uses or whose template library contains the template for this reporter

The specified template must be the same type as the report to which you append this reporter. For example, for a Microsoft^® Word report, TemplateSrc must be a Word reporter template. If the TemplateSrc property is empty, this reporter uses the default reporter template for the output type of the report.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

TemplateName — Name of template for this reporter

character vector | string scalar

Name of the template for this reporter, specified as a character vector or string scalar. The template for this reporter must be in the template library of the template specified by the TemplateSrc property of this reporter.

Attributes:

GetAccess	public
SetAccess	public

Data Types: char | string

LinkTarget — Hyperlink target for this reporter

[] (default) | character vector | string scalar | mlreportgen.dom.LinkTarget object

Hyperlink target for this reporter, specified as a character vector or string scalar that specifies the link target ID, or an mlreportgen.dom.LinkTarget object. A character vector or string scalar value converts to a LinkTarget object. The link target immediately precedes the content of this reporter in the output report.

Attributes:

GetAccess	public
SetAccess	public

Version History

Introduced in R2018b