mlreportgen.dom.LinkTarget 类

命名空间: mlreportgen.dom

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

描述

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

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

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

创建对象

描述

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

示例

输入参量

全部展开

`name` — 链接目标的名称
字符向量 | 字符串标量

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

注意

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

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

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

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

属性

全部展开

`Name` — 链接目标的名称
字符向量 | 字符串标量

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

有关名称要求的更多信息，请参阅 name 参量。

属性：

`GetAccess`	`public`
`SetAccess`	`无`
`NonCopyable`	`true`
`Transient`	`true`

`IsXRefTarget` — 此对象是否是 PDF 报告中 `mlreportgen.dom.XRef` 的目标
`0` (`false`) (默认) | `1` (`true`)

该对象是否为 PDF 类型的 mlreportgen.dom.Document 或 mlreportgen.report.Report 对象中某个 mlreportgen.dom.XRef 对象的目标，或是作为逻辑 1 (true) 或 0 (false) 指定的。当您指定：

1 (true) - 该对象是某个 Xref 对象的目标。
0 (false) - 该对象不是某个 Xref 对象的目标。

相关示例，请参阅在 PDF 报告中使用交叉引用元素。

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: logical

`Stylename` — 链接目标样式名称
字符向量 | 字符串标量

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

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: char | string

`Style` — 格式设定
`{}` (默认) | DOM 格式对象元胞数组

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

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: cell

`CustomAttributes` — 文档元素的自定义属性
`[]` (默认) | `mlreportgen.dom.CustomAttribute` 对象数组

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

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`Children` — 此对象的子对象
文档元素对象数组

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

属性：

`GetAccess`	`public`
`SetAccess`	`private`
`NonCopyable`	`true`

`Tag` — 标签
字符向量 | 字符串标量

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

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: char | string

`Id` — 目标标识符
字符向量 | 字符串标量

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

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: char | string

方法

全部展开

公共方法

方法	用途
`append`	`appendedContent = append(classObj,textContent)` 将文本 `textContent` 追加到类对象 `classObj`。 `appendedContent = append(classObj,textContent,styleName)` 使用样式 `styleName` 来追加文本。使用您追加内容的文档模板的样式表中定义的样式。 `appendedContent = append(classObj,contentToAppend)` 将 DOM 或 MATLAB 对象 `contentToAppend` 追加到类对象。输入参量 `classObj` - 要追加内容的类对象，指定为 `mlreportgen.dom.LinkTarget` 对象。 `textContent` - 要追加的文本，指定为字符向量或字符串标量。 `styleName` - 样式表的名称，指定为字符向量或字符串标量。指定此参量会将 `appendedContent` 对象的 `StyleName` 属性设置为 `styleName`。 `contentToAppend` - 要追加的内容，指定为 DOM 对象或 MATLAB 对象。返回值 `appendedContent` - 追加的内容，以 DOM 对象形式返回。要查看可作为 `classObj` 参量使用的 DOM 类对象和 MATLAB 数据类型的列表，请参阅将内容追加到 mlreportgen.dom.LinkTarget 对象。有关信息，请参阅 `mlreportgen.dom.Document` 类中的等效方法 `append`。
`clone`	`copiedObj = clone(soureceObj)` 返回 `soureceObj` 指定的 `mlreportgen.dom.LinkTarget` 对象的副本。副本包含源对象的子级，但不包含父级。注意请勿将同一对象多次追加到文档中。当您希望在文档的其他位置重用相同内容时，请使用克隆功能创建副本。输入参量 `soureceObj` - 要克隆的对象，指定为 `mlreportgen.dom.LinkTarget` 对象返回值 `copiedObj` - 对象副本，以 `mlreportgen.dom.LinkTarget` 对象形式返回有关详细信息，请参阅 `mlreportgen.dom.Paragraph` 类的等效方法 `clone`。

方法

用途

append

appendedContent = append(classObj,textContent) 将文本 textContent 追加到类对象 classObj。

appendedContent = append(classObj,textContent,styleName) 使用样式 styleName 来追加文本。使用您追加内容的文档模板的样式表中定义的样式。

appendedContent = append(classObj,contentToAppend) 将 DOM 或 MATLAB 对象 contentToAppend 追加到类对象。

输入参量

classObj - 要追加内容的类对象，指定为 mlreportgen.dom.LinkTarget 对象。
textContent - 要追加的文本，指定为字符向量或字符串标量。
styleName - 样式表的名称，指定为字符向量或字符串标量。指定此参量会将 appendedContent 对象的 StyleName 属性设置为 styleName。
contentToAppend - 要追加的内容，指定为 DOM 对象或 MATLAB 对象。

返回值

appendedContent - 追加的内容，以 DOM 对象形式返回。

要查看可作为 classObj 参量使用的 DOM 类对象和 MATLAB 数据类型的列表，请参阅将内容追加到 mlreportgen.dom.LinkTarget 对象。

有关信息，请参阅 mlreportgen.dom.Document 类中的等效方法 append。

clone

copiedObj = clone(soureceObj) 返回 soureceObj 指定的 mlreportgen.dom.LinkTarget 对象的副本。副本包含源对象的子级，但不包含父级。

注意

请勿将同一对象多次追加到文档中。当您希望在文档的其他位置重用相同内容时，请使用克隆功能创建副本。

输入参量

soureceObj - 要克隆的对象，指定为 mlreportgen.dom.LinkTarget 对象

返回值

copiedObj - 对象副本，以 mlreportgen.dom.LinkTarget 对象形式返回

有关详细信息，请参阅 mlreportgen.dom.Paragraph 类的等效方法 clone。

示例

全部折叠

返回文档顶部

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

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

在链接目标后追加文本

本示例创建一个两页的文档，并在文档顶部有一个指向目标的链接。

创建一个名为 "home" 的链接目标，并在其后追加文本。在分页符之后，创建一个指向目标的链接。该链接的文本是 Go to top。

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

target = LinkTarget("home");
append(target," - top of page");
append(d,target);

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

append(d,InternalLink("home","Go to top"));

close(d);
rptview(d.OutputPath);

在链接目标后追加自动生成的编号

此示例将创建一份两页的文档，并在链接目标后自动追加一个编号。

创建一个段落，并定义一个自动生成的编号。将该数值追加到目标后，再将目标追加到段落中。分页符后，创建指向目标的链接。

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

p = Paragraph("Chapter ");
p.Style = {CounterInc("chapter"),WhiteSpace("preserve")};
number = AutoNumber("chapter");
target = LinkTarget("chapno");
append(target,number);
append(p,target);
append(d,p);

p = Paragraph("Paragraph on another page");
p.Style = {PageBreakBefore(true)};
append(d,p);

append(d,InternalLink("target","Chapter reference"));

close(d);
rptview(d.OutputPath);

详细信息

全部展开

将内容追加到 `mlreportgen.dom.LinkTarget` 对象

您可以将这些 DOM 对象追加到 mlreportgen.dom.LinkTarget 对象：

您可以将这些 MATLAB 数据类型追加到 mlreportgen.dom.LinkTarget 对象：

字符数组 - 追加并返回 mlreportgen.dom.Text 对象
字符串标量 - 追加并返回 mlreportgen.dom.Text 对象
数值变量 - 追加并返回 mlreportgen.dom.Number 对象
逻辑变量 - 追加并返回值为 1 或 0 的 mlreportgen.dom.Number 对象

将 `mlreportgen.dom.LinkTarget` 对象追加到 DOM 类对象上

您可以将 mlreportgen.dom.LinkTarget 对象追加到以下这些 DOM 类对象：

版本历史记录

在 R2014b 中推出

全部展开

为所有报告类型生成有效的链接目标名称

在未来的版本中，mlreportgen.utils.hash 生成的链接目标名称 (ID) 可能对 PDF 报告无效。为了确保链接目标名称对所有报告类型都有效，请使用 mlreportgen.utils.normalizeLinkID 而不是 mlreportgen.utils.hash。

另请参阅

主题

创建链接

mlreportgen.dom.LinkTarget 类

描述

创建对象

描述

输入参量

name — 链接目标的名称 字符向量 | 字符串标量

属性

Name — 链接目标的名称 字符向量 | 字符串标量

属性：

IsXRefTarget — 此对象是否是 PDF 报告中 mlreportgen.dom.XRef 的目标 0 (false) (默认) | 1 (true)

属性：

Stylename — 链接目标样式名称 字符向量 | 字符串标量

属性：

Style — 格式设定 {} (默认) | DOM 格式对象元胞数组

属性：

CustomAttributes — 文档元素的自定义属性 [] (默认) | mlreportgen.dom.CustomAttribute 对象数组

属性：

Children — 此对象的子对象 文档元素对象数组

属性：

Tag — 标签 字符向量 | 字符串标量

属性：

Id — 目标标识符 字符向量 | 字符串标量

属性：

方法

公共方法

示例

返回文档顶部

在链接目标后追加文本

在链接目标后追加自动生成的编号

详细信息

将内容追加到 mlreportgen.dom.LinkTarget 对象

将 mlreportgen.dom.LinkTarget 对象追加到 DOM 类对象上

版本历史记录

为所有报告类型生成有效的链接目标名称

另请参阅

主题

`name` — 链接目标的名称
字符向量 | 字符串标量

`Name` — 链接目标的名称
字符向量 | 字符串标量

`IsXRefTarget` — 此对象是否是 PDF 报告中 `mlreportgen.dom.XRef` 的目标
`0` (`false`) (默认) | `1` (`true`)

`Stylename` — 链接目标样式名称
字符向量 | 字符串标量

`Style` — 格式设定
`{}` (默认) | DOM 格式对象元胞数组

`CustomAttributes` — 文档元素的自定义属性
`[]` (默认) | `mlreportgen.dom.CustomAttribute` 对象数组

`Children` — 此对象的子对象
文档元素对象数组

`Tag` — 标签
字符向量 | 字符串标量

`Id` — 目标标识符
字符向量 | 字符串标量

将内容追加到 `mlreportgen.dom.LinkTarget` 对象

将 `mlreportgen.dom.LinkTarget` 对象追加到 DOM 类对象上