Main Content

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

mlreportgen.dom.InternalLink 类

命名空间: mlreportgen.dom

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

全页展开

描述

超链接到包含超链接的同一文档中的某个位置。使用此类链接可提供文档内的内部导航。

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

创建对象

描述

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

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

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

示例

输入参量

全部展开

链接目标名称，指定为字符向量。字符向量是 mlreportgen.dom.LinkTarget 对象或 URL 的 Name 属性中的值。

用于链接文本的文本。

用于链接文本的样式名称。

包含指向外部目标的链接文本的对象，由 mlreportgen.dom.Text、mlreportgen.dom.Number 或 mlreportgen.dom.CharEntity 对象指定。

属性

全部展开

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

属性：

SetAccess
private
NonCopyable
true

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

属性：

NonCopyable
true

mlreportgen.dom.InternalLink 对象的对象标识符，指定为字符向量或字符串标量。DOM API 在创建文档元素对象时会生成一个会话唯一标识符。您可以为 Id 指定自己的值。

属性：

NonCopyable
true

数据类型: char | string

mlreportgen.dom.InternalLink 对象的父级，指定为文档元素对象。一个文档元素必须只有一个父元素。

属性：

SetAccess
private
NonCopyable
true

模板中定义的链接样式的名称，指定为字符向量。styleName 指定的样式必须在用于创建追加链接的文档的模板中定义。

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

属性：

NonCopyable
true

数据类型: cell

mlreportgen.dom.InternalLink 对象的标签，指定为字符向量或字符串标量。DOM API 在创建此对象的过程中生成一个会话唯一标签。生成的标签形式为 CLASS:ID，其中 CLASS 是对象类，ID 是对象的 Id 属性的值。指定您自己的标签值，以帮助您确定在文档生成过程中出现问题时要查找的位置。

属性：

NonCopyable
true

数据类型: char | string

此只读属性显示此超链接的链接目标。

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

可能的值包括：

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

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

注意

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

数据类型: 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);

版本历史记录

在 R2014b 中推出

另请参阅

| | | | | |

主题