mlreportgen.dom.InternalLink Class

Namespace: mlreportgen.dom

Hyperlink to a location in same document

Description

Use an object of the mlreportgen.dom.InternalLink class to hyperlink to a location in the same document that contains the hyperlink. Use this kind of link to provide internal navigation within a document.

To see what DOM objects you can append an mlreportgen.dom.InternalLink object to, see Append mlreportgen.dom.InternalLink object to DOM class object .

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,domObj) 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

The link target of the external link, specified as either a character vector for a URL or as the value in the Name property of an mlreportgen.dom.LinkTarget object.

linkText — Link text

character vector | string scalar

The text to use for the link text, specified as a character vector or a string scalar.

Data Types: char | string

linkTextStyleName — Name of style for link text

character vector | string scalar

Name of style to use for the link text, specified as a character vector or a string scalar.

Data Types: char | string

domObj — Object containing link text

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

Object containing link text to the external target, specified as one of the following DOM objects:

• mlreportgen.dom.CharEntity

• mlreportgen.dom.Number

• mlreportgen.dom.Text

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, see Templates for DOM API Report Programs.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Style — Format specification

{} (default) | cell array of DOM format objects

Format specification for this document element object, specified as a cell 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

Data Types: cell

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	appendedContent = append(classObj,textContent) appends text, textContent, to the class object, classObj. appendedContent = append(classObj,textContent,styleName) appends text using the style, styleName. Use a style defined in the style sheet of the template of the document you append content to. appendedContent = append(classObj,contentToAppend) appends a DOM or MATLAB object, contentToAppend, to the class object. Input Arguments classObj — Class object to append content to, specified as an mlreportgen.dom.InternalLink object. textContent — Text to append, specified as a character vector or string scalar. styleName — Name of style sheet, specified as a character vector or string scalar. Specifying this argument sets the StyleName property of the appendedContent object to styleName. contentToAppend — Content to append, specified as a DOM or MATLAB object. Return Values appendedContent — Appended content, returned as a DOM object. To see a list of the DOM class objects and MATLAB data types you can use as the classObj argument, see Append content to mlreportgen.dom.InternalLink object. For more information, see the equivalent append method from the mlreportgen.dom.Document class.
clone	copiedObj = clone(soureceObj) returns a copy of the mlreportgen.dom.InternalLink object specified by soureceObj. The copy includes the children of the source object, but not the parent. Note Do not append the same object to a document more than once. Use clone to create a copy when you want to reuse the same content elsewhere in a document. Input Arguments soureceObj — Object to clone, specified as an mlreportgen.dom.InternalLink object Return Values copiedObj— Object copy, returned as an mlreportgen.dom.InternalLink object For more information, see the equivalent method for the mlreportgen.dom.Paragraph class, clone.

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);

More About

Append content to mlreportgen.dom.InternalLink object

You can append these DOM objects to an mlreportgen.dom.InternalLink object:

• mlreportgen.dom.CharEntity

• mlreportgen.dom.CustomElement (HTML, Word)

• mlreportgen.dom.Image

• mlreportgen.dom.Leader

• mlreportgen.dom.Number

• mlreportgen.dom.NumPages (PDF, Word)

• mlreportgen.dom.Page (PDF, Word)

• mlreportgen.dom.PageRef (PDF, Word)

• mlreportgen.dom.Text

You can append these MATLAB data types to an mlreportgen.dom.InternalLink object:

• character array — Appends and returns a mlreportgen.dom.Text object

• string scalar — Appends and returns a mlreportgen.dom.Text object

• numeric variable — Appends and returns a mlreportgen.dom.Number object

• logical variable — Appends and returns a mlreportgen.dom.Number object with a value of 1 or 0

Append mlreportgen.dom.InternalLink object to DOM class object

You can append an mlreportgen.dom.InternalLink object to these DOM class objects:

• mlreportgen.dom.Container

• mlreportgen.dom.CustomElement

• mlreportgen.dom.Document

• mlreportgen.dom.DocumentPart

• mlreportgen.dom.DOCXPageFooter

• mlreportgen.dom.DOCXPageHeader

• mlreportgen.dom.Endnote (since R2024a)

• mlreportgen.dom.Footnote (since R2024a)

• mlreportgen.dom.Group

• mlreportgen.dom.Heading

• mlreportgen.dom.Heading1

• mlreportgen.dom.Heading2

• mlreportgen.dom.Heading3

• mlreportgen.dom.Heading4

• mlreportgen.dom.Heading5

• mlreportgen.dom.Heading6

• mlreportgen.dom.HTMLPage (since R2024a)

• mlreportgen.dom.ListItem

• mlreportgen.dom.OrderedList

• mlreportgen.dom.Paragraph

• mlreportgen.dom.PDFPageFooter

• mlreportgen.dom.PDFPageHeader

• mlreportgen.dom.Preformatted

• mlreportgen.dom.TableEntry

• mlreportgen.dom.TableHeaderEntry

• mlreportgen.dom.Template

• mlreportgen.dom.TemplateDocumentPart (since R2023b)

• mlreportgen.dom.UnorderedList

Tips

• When you append mlreportgen.dom.InternalLink objects in documents, the object content appends differently depending on the document format. In HTML documents, the content appends in the same line. In PDF and DOCX documents, the content appends in separate lines. To append the content in the same line, create a mlreportgen.dom.Paragraph object, append the content to the paragraph object by using the append method, then append the paragraph object to the document object.

Version History

Introduced in R2014b