本页采用了机器翻译。点击此处可查看英文原文。

mlreportgen.dom.InternalLink 类

命名空间: mlreportgen.dom

超链接到同一文档中的位置

全页展开

描述

使用 mlreportgen.dom.InternalLink 类的实例创建指向同一文档中包含该超链接的位置的超链接。使用此类链接可提供文档内的内部导航。

要了解可以将 mlreportgen.dom.InternalLink 对象追加到哪些 DOM 对象上，请参阅 将 mlreportgen.dom.InternalLink 对象追加到 DOM 类对象上。

mlreportgen.dom.InternalLink 类是一个 handle 类。

创建对象

描述

internalLinkObj = InternalLink(targetName,linkText) 创建到指定链接目标对象的超链接并使用指定的链接文本。

internalLinkObj = InternalLink(targetName,linkText,linkTextStyleName) 创建到指定链接目标的超链接，并使用指定的样式名称作为链接文本。

internalLinkObj = InternalLink(targetName,domObj) 使用来自指定 mlreportgen.dom.Text、mlreportgen.dom.Number 或 mlreportgen.dom.CharEntity 对象的链接文本创建到指定目标的超链接。

示例

输入参量

全部展开

外部链接的链接目标，可指定为表示 URL 的字符向量，或指定为 mlreportgen.dom.LinkTarget 对象的 Name 属性中的值。

链接文本中要使用的文本，指定为字符向量或字符串标量。

数据类型: char | string

链接文本所采用的样式名称，指定为字符向量或字符串标量。

数据类型: char | string

包含指向外部目标的链接文本的容器，应指定为以下 DOM 对象之一：

属性

全部展开

链接的目标 URL，指定为字符向量或字符串标量。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

将打开目标的窗口，指定为字符向量或字符串标量。

可能的值包括：

  • "samewindow"-（默认）在同一窗口中打开目标

  • "newwindow"-在新窗口中打开目标

注意

此属性仅适用于 HTML 输出类型的报告。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

样式表中定义的样式名称，指定为字符向量或字符串标量。样式名称是此元素所追加到的文档或文档部件的样式表中指定的样式的名称。指定的样式定义了该元素在输出文档中的外观，除非该元素的 Style 属性指定的格式覆盖了该样式。要了解有关使用样式表的更多信息，请参阅 使用样式表样式。

注意

Microsoft® Word 报告会忽略文档模板中未定义的样式名称。有关 Microsoft Word 模板的详细信息，请参阅DOM API 报告程序模板。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

此文档元素对象的格式规范，指定为 DOM 格式对象元胞数组。此属性指定的格式将覆盖此元素的 StyleName 属性指定的相应格式。不适用于此文档元素对象的格式将被忽略。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: cell

文档元素的自定义属性，指定为 mlreportgen.dom.CustomAttribute 对象数组。自定义属性必须被此对象所追加到的文档元素的输出格式支持。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

此对象的父对象，指定为文档元素对象。一个文档元素必须只有一个父元素。

属性：

GetAccess
public
SetAccess
private
NonCopyable
true

此对象的子对象，指定为文档元素对象数组。此属性包含使用 append 方法追加的文档元素对象。

属性：

GetAccess
public
SetAccess
private
NonCopyable
true

标记，指定为字符向量或字符串标量。DOM API 在创建此对象的过程中生成一个会话唯一标记。生成的标记形式为 CLASS:ID，其中 CLASS 是对象类，ID 是对象的 Id 属性的值。使用此值来帮助确定在文档生成过程中出现的问题的位置。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

目标标识符，指定为字符向量或字符串标量。DOM API 在创建文档元素对象时会生成一个会话唯一标识符。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

方法

全部展开

示例

全部折叠

使用 mlreportgen.dom.LinkTarget 对象定义链接目标并使用 mlreportgen.dom.InternalLink 对象定义链接来链接到同一文档中的目标。链接目标名称将链接与链接目标关联起来。要生成对所有报告类型有效的链接目标名称，请使用 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);

详细信息

全部展开

提示

  • 在文档中追加 mlreportgen.dom.InternalLink 对象时，根据文档格式的不同，对象内容的追加方式也会有所不同。在 HTML 文档中，内容会添加在同一行。在 PDF 和 DOCX 文档中，内容以单独的行形式追加。要将内容追加到同一行，请创建一个 mlreportgen.dom.Paragraph 对象，使用 append 方法将内容追加到段落对象，然后将段落对象追加到文档对象。

版本历史记录

在 R2014b 中推出

另请参阅

类

函数

主题