Fill section title hole reporter
Reporter for other reporters, such as chapter and section reporters. These other reporters
use instances of this
SectionTitle reporter to fill title 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 holes in their
templates. For example, for the
Section reporter, its
getTitleReporter method returns the instance that the
Section reporter uses to fill the
Title hole in its template.
To customize the title format, specify a custom template for the
reporter returned by the
Reporters create instances of this object. You do not need to create this object yourself.
HoleId— ID of hole
ID of hole to be filled by this reporter, specified as a string.
Content— Content of hole
Content of hole to be filled by this reporter, specified as one of these values:
String or character array
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
NumberPrefix— Prefix for the title content
Prefix for the title content, specified as a string or character array. If no prefix is specified, the default title prefix, translated based on the report locale, is used.
NumberSuffix— Suffix for the title content
Suffix for the title content, specified as a string or character array. If no suffix is specified, the default title suffix, translated based on the report locale, is used.
Translations— Translation map for the section title prefix and suffix
Translation map for the section title prefix and suffix, specified as a MATLAB® structure. If the specified translation map does not contain a translation
for the report locale, the
Translations property uses
en as the backup locale. See the Locale
mlreportgen.report.Report for information about valid
TemplateSrc— Source of template for this reporter
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 is used for this reporter or whose template library contains the template for this reporter
DOM document or document part whose template is used for this reporter or whose template library contains the template for this reporter
The specified template must be the same type as the report to which this
reporter is appended. For example, for a Microsoft® Word report,
TemplateSrc must be a Word reporter template. If
TemplateSrc property is empty, this reporter uses the default
reporter template for the output type of the report.
TemplateName— Name of template for this reporter
Name of the template for this reporter, specified as a character vector or string
scalar. The template for this reporter is in the template library of the template source
TemplateSrc) for this reporter.
LinkTarget— Hyperlink target for this reporter
(default) | character vector | string scalar |
Hyperlink target for this reporter, specified as a string or character array that
specifies the link target ID, or an
mlreportgen.dom.LinkTarget object. A string or character array value is
converted to a
LinkTarget object. The link target object immediately
precedes the content of this reporter in the output report.