mlreportgen.dom.InternalLink class

Package: 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.

internalLinkObj = InternalLink(targetName,textObj) creates a hyperlink to the specified target using the specified Text object.

Input Arguments

targetName — Link target name

character vector

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.

linkText — Link text

character vector

The text to use for the link text.

linkTextStyleName — Name of style for link text

character vector

Name of style to use for the link text.

textObj — Text object containing link text

mlreportgen.dom.Text object

Text object containing link text, specified by an mlreportgen.dom.Text object.

Properties

Children — Children of document element

array of DOM objects

Children of this document element, specified as an array of DOM objects. This property is read-only.

CustomAttributes — Custom attributes of document element

array of mlreportgen.dom.CustomAttribute objects

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.

Id — ID for this document element

character vector | string scalar

ID for this document element, specified as a character vector or string scalar. The DOM generates a session-unique ID when it creates the document element. You can specify your own ID.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Parent — Parent of document element

DOM object

Parent of this document element, specified as a DOM object. This property is read-only.

Attributes:

GetAccess	public
SetAccess	private
NonCopyable	true

StyleName — Name of link style defined in the template

character vector

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.

Style — Format specification

array of format objects

Format objects that specify the format of a document element.

Tag — Tag for this document element

character vector | string scalar

Tag for this document element, specified as a character vector or string scalar.

The DOM 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. Specifying your own tag value can help you to identify where an issue occurred during document generation.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Target — Internal target link

character vector

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

TargetSite — Specifies the window in which the target will be opened

"samewindow" (default) | "newwindow"

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: string | char

Methods

Public Methods

Method	Purpose
append Use InternalLink.append in a similar way to how you use ExternalLink.append.	Append text or a Text, Image, or CustomElement object.
clone Use InternalLink.clone in a similar way to how you use Paragraph.clone.	Copy the internal link.

Examples

Add Internal Link

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