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

mlreportgen.dom.LinkTarget 类

命名空间: mlreportgen.dom

内部或外部链接或图像区域链接的目标

全页展开

描述

用于内部和外部链接以及图像区域链接的目标。构造 LinkTarget 或 mlreportgen.dom.InternalLink 对象时可以指定 mlreportgen.dom.ImageArea 对象。

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

创建对象

描述

targetObj = LinkTarget(name) 创建具有指定名称的链接目标。

示例

输入参量

全部展开

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

注意

要生成对所有报告类型有效的链接目标名称，请使用 mlreportgen.utils.normalizeLinkID。生成的名称符合 Microsoft® Word 对 ID 长度的限制以及 PDF 对 ID 以字母开头的要求。

Word 用下划线字符替换链接目标名称中的空格。避免在 Word 报告中的链接目标名称中使用空格。

要设置外部链接的链接目标：

  • 在 Word 报告中，指定 Word 书签。

  • 在 HTML 报告中，指定一个 HTML 命名锚点（例如，<a name="appendix"/>）。

属性

全部展开

请参阅 name 输入参量。

styleName 指定的样式必须在用于创建追加此链接目标的文档元素的模板中定义。

数据类型: char | string

该对象是否是 PDF 类型的 mlreportgen.dom.XRef 或 mlreportgen.dom.Document 对象中的 mlreportgen.report.Report 对象的目标，指定为数值或逻辑值 1 (true) 或 0 (false)。相关示例，请参阅在 PDF 报告中使用交叉引用元素。

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

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

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

属性：

GetAccess
public
SetAccess
public
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

方法

全部展开

示例

全部折叠

在报告顶部定义一个链接目标并添加指向该目标的内部链接。

import mlreportgen.dom.*
import mlreportgen.utils.*
d = Document("mydoc","pdf");

p = Paragraph("This is my paragraph");
linkID = normalizeLinkID("home");
append(p,LinkTarget(linkID));
append(d,p);

p = Paragraph("This is another paragraph");
p.Style = {PageBreakBefore(true)};
append(d,p);
append(d,InternalLink(linkID,"Go to Top"));

close(d);
rptview(d);

版本历史记录

在 R2014b 中推出

全部展开

另请参阅

| | | | |

主题