Main Content

mlreportgen.dom.ExternalLink Class

Namespace: mlreportgen.dom

Hyperlink to a location outside of document

Description

Defines a hyperlink to a location outside of the document.

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

Creation

Description

externalLinkObj = ExternalLink(target,linkText) creates a hyperlink to the specified target and having the specified link text. This constructor creates a text object (mlreportgen.dom.Text) to hold the link text.

externalLinkObj = ExternalLink(target,linkText,linkTextStyleName) creates a hyperlink with the specified link text and style name.

example

externalLinkObj = ExternalLink(target,obj) creates a hyperlink to the specified target using link text from the specified mlreportgen.dom.Text, mlreportgen.dom.Number, or mlreportgen.dom.CharEntity object.

Input Arguments

expand all

The link target of the external link, specified as either a character vector (for a URL) or as an mlreportgen.dom.LinkTarget object.

The text to use for the link text.

Name of style to use for the link text.

Object containing link text to the external target, specified by an mlreportgen.dom.Text, mlreportgen.dom.Number, or mlreportgen.dom.CharEntity 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 of the document element to which this object is appended.

Attributes:

NonCopyable
true

Format specification for this document element object, specified as an array of 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 element are ignored.

Attributes:

NonCopyable
true

Data Types: cell

Style name, specified as a character vector or a string scalar. The style name is the name of a style specified in the style sheet of the document or document part to which this element is appended. The specified style defines the appearance of this element in the output document unless overridden by the formats specified by the Style property of this element. To learn more about using style sheets, see Use Style Sheet Styles.

Note

Microsoft® Word output ignores the style name.

Attributes:

NonCopyable
true

Data Types: char | string

This read-only property displays the URL of the link target of this hyperlink.

The window in which the target will be opened, specified as a character vector or string scalar.

Possible values are:

  • "samewindow" - (default) opens a target in the same window

  • "newwindow" - opens a target in a new window

Note

This property applies only to HTML output-type reports.

Data Types: char | string

Tag for mlreportgen.dom.ExternalLink 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 mlreportgen.dom.ExternalLink 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

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

append(d,ExternalLink('https://www.mathworks.com/','MathWorks'));

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

Version History

Introduced in R2014b