Main Content

mlreportgen.dom.InternalLink Class

Namespace: mlreportgen.dom

Hyperlink to a location in same document

Description

Hyperlink to a location in the same document that contains the hyperlink. Use this kind of link to provide internal navigation within a document.

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

Creation

Description

internalLinkObj = InternalLink(targetName,linkText) creates a hyperlink to the specified link target object and uses the specified link text.

internalLinkObj = InternalLink(targetName,linkText,linkTextStyleName) creates a hyperlink to the specified link target and uses the specified style name for the link text.

example

internalLinkObj = InternalLink(target,obj) creates a hyperlink to the specified target using link test from the specified mlreportgen.dom.Text, mlreportgen.dom.Number, or mlreportgen.dom.CharEntity object.

Input Arguments

expand all

Link target name, specified as character vector. The character vector is the value in the Name property of an mlreportgen.dom.LinkTarget object or a URL.

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

Children of mlreportgen.dom.InternalLink object, specified as an array of document element objects. This property contains the document element objects appended using the append method.

Attributes:

SetAccess
private
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

Object identifier for mlreportgen.dom.InternalLink 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

Parent of mlreportgen.dom.InternalLink object, specified as a document element object. A document element must have only one parent.

Attributes:

SetAccess
private
NonCopyable
true

Name of link style defined in the template, specified as a character vector. The style specified by styleName must be defined in the template used to create the document to which the link is appended.

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

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

This read-only property displays 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

Methods

expand all

Examples

collapse all

Link to a target in the same document by using an mlreportgen.dom.LinkTarget object to define the link target and an mlreportgen.dom.InternalLink object to define the link. The link target name associates the link with the link target. To generate a link target name that is valid for all report types, use mlreportgen.utils.normalizeLinkID.

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

% Append a link target to a heading
h = Heading(1,'Author''s Biography');
h.Style = {PageBreakBefore(true)};
linkID = normalizeLinkID('bio');
append(h,LinkTarget(linkID));

% Link to the target
append(d,InternalLink(linkID,'About the Author'));

% Append the heading 
append(d,h);

close(d);
rptview(d);

Version History

Introduced in R2014b