Main Content

mlreportgen.dom.LinkTarget Class

Namespace: mlreportgen.dom

Target for internal or external links or image area links

expand all in page

Description

A target to use for internal and external links and for image area links. You can specify a LinkTarget object when you construct an mlreportgen.dom.InternalLink or mlreportgen.dom.ImageArea object.

The mlreportgen.dom.LinkTarget class is a handle class.

Creation

Description

targetObj = LinkTarget(name) creates a link target with the specified name.

example

Input Arguments

expand all

Name of a link target, specified as a character vector or string scalar.

Note

To generate a link target name that is valid for all report types, use mlreportgen.utils.normalizeLinkID. The generated name conforms to the Microsoft® Word limitation on ID length and the PDF requirement that an ID begin with an alphabetic character.

Word replaces spaces in link target names with underscore characters. Avoid spaces in link target names in Word reports.

To set up a link target for an external link:

  • In a Word report, specify a Word bookmark.

  • In an HTML report, specify an HTML named anchor (for example, <a name='appendix'/>).

Properties

expand all

See name input argument.

The style specified by styleName must be defined in the template used to create the document element to which this link target is appended.

Data Types: char | string

Whether this object is the target of an mlreportgen.dom.XRef object in an mlreportgen.dom.Document or mlreportgen.report.Report object of type PDF, specified as a numeric or logical 1 (true) or 0 (false). For example see Use Cross-Reference Elements in a PDF Report.

Format specification for this document element object, specified as an array of DOM format objects. The formats specified by this property override corresponding formats specified by the StyleName property of this element. Formats that do not apply to this document element object are ignored.

Attributes:

NonCopyable
true

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 of the document element to which this object is appended.

Attributes:

NonCopyable
true

Tag for the mlreportgen.dom.LinkTarget object, 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. Specify your own tag value to help you identify where to look when an issue occurs during document generation.

Attributes:

NonCopyable
true

Data Types: char | string

Object identifier for the mlreportgen.dom.LinkTarget object, specified as a character vector or string scalar. The DOM API generates a session-unique identifier when it creates the document element object. You can specify your own value for Id.

Attributes:

NonCopyable
true

Data Types: char | string

Methods

expand all

Examples

collapse all

Define a link target at the top of the report and add an internal link to that target.

import mlreportgen.dom.*
import mlreportgen.utils.*
d = Document('mydoc','pdf');

p = Paragraph('This is my paragraph');
linkID = normalizeLinkID('home');
append(p,LinkTarget(linkID));
append(d,p);

p = Paragraph('This is another paragraph');
p.Style = {PageBreakBefore(true)};
append(d,p);
append(d,InternalLink(linkID,'Go to Top'));

close(d);
rptview(d);

Version History

Introduced in R2014b

expand all

See Also

| | | | |

Topics