mlreportgen.dom.ExternalLink 类

命名空间: mlreportgen.dom

超链接到文档外部的位置

全页展开

描述

定义指向文档外部位置的超链接。

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

创建对象

描述

externalLinkObj = ExternalLink(target,linkText) 创建到指定目标并具有指定链接文本的超链接。此构造函数创建一个文本对象 (mlreportgen.dom.Text) 来保存链接文本。

externalLinkObj = ExternalLink(target,linkText,linkTextStyleName) 使用指定的链接文本和样式名称创建超链接。

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

示例

输入参量

全部展开

`target` — 链接目标
字符向量 | `mlreportgen.dom.LinkTarget` 对象

外部链接的链接目标，指定为字符向量（用于 URL）或 mlreportgen.dom.LinkTarget 对象。

`linkText` — 链接文本
字符向量

用于链接文本的文本。

`linkTextStyleName` — 链接文本样式的名称
字符向量

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

`obj` — 包含链接文本的对象
`mlreportgen.dom.Text` 对象 | `mlreportgen.dom.Number` | `mlreportgen.dom.CharEntity`

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

属性

全部展开

`Target` — 链接的目标 URL
`""` (默认) | 字符向量 | 字符串标量

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

属性：

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

数据类型: char | string

`TargetSite` — 指定打开目标的窗口
`"samewindow"` (默认) | `"newwindow"`

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

可能的值包括：

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

注意

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

属性：

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

数据类型: char | string

`StyleName` — 样式表定义样式的名称
`[]` (默认) | 字符向量 | 字符串标量

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

注意

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

属性：

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

数据类型: char | string

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

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

属性：

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

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

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

属性：

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

`Parent` — 此对象的父对象
文档元素对象

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

属性：

`GetAccess`	`public`
`SetAccess`	`private`
`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`	追加文本或 `Text`、`Image`、`CustomElement`、`Number` 或 `CharEntity` 对象。
`clone` `ExternalLink.clone` 的使用方式与 `Paragraph.clone` 类似。	复制外部链接

方法

用途

append

追加文本或 Text、Image、CustomElement、Number 或 CharEntity 对象。

clone

ExternalLink.clone 的使用方式与 Paragraph.clone 类似。

复制外部链接

示例

全部折叠

添加外部链接

打开实时脚本

import mlreportgen.dom.*
d = Document('mydoc');

append(d,ExternalLink('https://www.mathworks.com/','MathWorks'));

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

版本历史记录

在 R2014b 中推出

另请参阅

类

mlreportgen.dom.LinkTarget | mlreportgen.dom.InternalLink | mlreportgen.dom.EmbeddedObject | mlreportgen.dom.Text | mlreportgen.dom.Number | mlreportgen.dom.CharEntity

主题

创建链接

mlreportgen.dom.ExternalLink 类

描述

创建对象

描述

输入参量

target — 链接目标 字符向量 | mlreportgen.dom.LinkTarget 对象

linkText — 链接文本 字符向量

linkTextStyleName — 链接文本样式的名称 字符向量

obj — 包含链接文本的对象 mlreportgen.dom.Text 对象 | mlreportgen.dom.Number | mlreportgen.dom.CharEntity

属性

Target — 链接的目标 URL "" (默认) | 字符向量 | 字符串标量

属性：

TargetSite — 指定打开目标的窗口 "samewindow" (默认) | "newwindow"

属性：

StyleName — 样式表定义样式的名称 [] (默认) | 字符向量 | 字符串标量

属性：

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

属性：

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

属性：

Parent — 此对象的父对象 文档元素对象

属性：

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

属性：

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

属性：

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

属性：

方法

公共方法

示例

添加外部链接

版本历史记录

另请参阅

类

主题

`target` — 链接目标
字符向量 | `mlreportgen.dom.LinkTarget` 对象

`linkText` — 链接文本
字符向量

`linkTextStyleName` — 链接文本样式的名称
字符向量

`obj` — 包含链接文本的对象
`mlreportgen.dom.Text` 对象 | `mlreportgen.dom.Number` | `mlreportgen.dom.CharEntity`

`Target` — 链接的目标 URL
`""` (默认) | 字符向量 | 字符串标量

`TargetSite` — 指定打开目标的窗口
`"samewindow"` (默认) | `"newwindow"`

`StyleName` — 样式表定义样式的名称
`[]` (默认) | 字符向量 | 字符串标量

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

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

`Parent` — 此对象的父对象
文档元素对象

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

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

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