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.

internalLinkObj = InternalLink(targetName,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

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.

obj — Object containing link text

mlreportgen.dom.Text object | mlreportgen.dom.Number | mlreportgen.dom.CharEntity

Object containing link text to the external target, specified by an mlreportgen.dom.Text, mlreportgen.dom.Number, or mlreportgen.dom.CharEntity object.

Properties

Target — Target URL of link

"" (default) | character vector | string scalar

Target URL of link, specified as a character vector or a string scalar.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

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.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

StyleName — Name of stylesheet-defined style

[] (default) | character vector | string scalar

Name of stylesheet-defined style, specified as a character vector or 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 the formats specified by the Style property of this element override it. To learn more about using style sheets, see Use Style Sheet Styles.

Note

Microsoft^® Word reports ignore style names that are not defined in the document template. For more information on Microsoft Word templates, seeTemplates for DOM API Report Programs.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Style — Format specification

{} (default) | array of DOM format objects

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:

GetAccess	public
SetAccess	public
NonCopyable	true

CustomAttributes — Custom attributes of document element

[] (default) | array of mlreportgen.dom.CustomAttribute objects

Custom attributes of the 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:

GetAccess	public
SetAccess	public
NonCopyable	true

Parent — Parent of this object

document element object

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

Attributes:

GetAccess	public
SetAccess	private
NonCopyable	true

Children — Children of this object

array of document element objects

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

Attributes:

GetAccess	public
SetAccess	private
NonCopyable	true

Tag — Tag

character vector | string scalar

Tag, 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. Use this value to help identify where an issue occurs during document generation.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Id — Object identifier

character vector | string scalar

Object identifier, specified as a character vector or string scalar. The DOM API generates a session-unique identifier when it creates the document element object.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

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, CustomElement, Number, or CharEntity 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