主要内容

mlreportgen.dom.XRefclass

包:mlreportgen.dom

交叉引用元素多克斯或PDF报告

自从R2022a

扩展所有的页面

描述

使用的对象mlreportgen.dom.XRef类交叉引用一个目标在多克斯或PDF报告。

的mlreportgen.dom.XRef类是一个处理类。

类属性

HandleCompatible
真正的

类属性的信息,请参阅类属性。

创建

描述

xRefObj= mlreportgen.dom.XRef ()创建一个mlreportgen.dom.XRef与一个空对象目标财产。设置目标财产之前添加XRef对象的一份报告。

例子

xRefObj= mlreportgen.dom.XRef (目标)创建一个XRef对象ID的联系,目标。

属性

全部展开

指定链接的目标对象的ID交叉引用,作为一个字符数组或字符串标量。设置目标链接的ID属性mlreportgen.dom.LinkTarget你想交叉引用对象。

请注意

使用mlreportgen.utils.normalizeLinkID函数来生成一个有效的链接目标ID符合PDF和的限制微软®词文档。

属性:

GetAccess
公共
SetAccess
公共

数据类型:字符|字符串

格式对象,指定的单元阵列mlreportgen.dom格式的对象。添加一个或多个格式对象定制的外观交叉引用。

属性:

GetAccess
公共
SetAccess
公共

风格的名称使用呈现交叉引用,指定为一个字符串标量或特征向量。必须在样式表中定义样式的模板文档包含交叉引用。了解更多关于使用样式表,请参阅使用样式表样式。

属性:

GetAccess
公共
SetAccess
公共

数据类型:字符|字符串

交叉引用的对象是附加的,指定为一个mlreportgen.dom.Paragraph对象。

请注意

你可以添加一个XRef对象类的一个对象mlreportgen.dom.Paragraph。

属性:

GetAccess
公共
SetAccess
公共

数据类型:mlreportgen.dom.Paragraph

对象附加到XRef对象,指定为一个mlreportgen.dom.CustomElement数组中。

请注意

您只能添加对象的类mlreportgen.dom.CustomElement到一个XRef对象。

属性:

GetAccess
公共
SetAccess
公共

数据类型:mlreportgen.dom.CustomElement

标记文档元素,指定为一个特征向量或字符串标量。

DOM生成一个session-unique标签创建这个对象的一部分。生成的标签的形式类:ID,类是对象类和ID的值Id对象的属性。指定您自己的标记值可以帮助您确定问题发生在文档生成。

属性:

GetAccess
公共
SetAccess
公共
NonCopyable
真正的

数据类型:字符|字符串

自定义属性的文档元素,指定为数组mlreportgen.dom.CustomAttribute对象。自定义属性必须支持的输出格式。金宝app

本文档ID元素,指定为一个特征向量或字符串标量。DOM生成一个session-unique ID创建文档元素。你可以指定自己的ID。

属性:

GetAccess
公共
SetAccess
公共
NonCopyable
真正的

数据类型:字符|字符串

方法

全部展开

例子

全部折叠

打开生活的脚本

这个例子展示了如何使用交叉引用元素生成PDF格式的报告。

进口这些包,所以你不需要使用长,完全限定类名。

进口mlreportgen.dom。*进口mlreportgen.report。*

创建一个mlreportgen.report.Report类型的对象PDF。

rpt =报告(“Cross-ref_in_PDF_example”,“pdf”);

创建一个mlreportgen.report.Chapter对象的介绍章节,和一个mlreportgen.dom.Paragraph对象的内容介绍章节。

chapter1 =章(“介绍”);帕拉=段();帕拉。空白=“保存”;

使用的函数normalizeLinkID生成一个有效的惟一的链接ID,然后使用这个链接ID来创建一个mlreportgen.dom.LinkTarget对象。

linkID = mlreportgen.utils.normalizeLinkID (“myLinkID”);linkTarget = linkTarget (linkID);

创建两个参考对象,一个mlreportgen.dom.XRef和一个mlreportgen.dom.PageRef,你用来创建相同的链接IDLinkTarget对象。你必须使用相同的链接ID为所有三个对象链接链接目标对象的引用对象。

xRefObj = XRef (linkID);pageRefObj = PageRef (linkID);

通过添加一个定制的外观交叉引用对象mlreportgen.dom.Italic对象的样式属性。

xRefObj。风格{end+1} = Italic;

设置IsXRefTarget财产的LinkTarget对象为true。这是必要的,只有在PDF报告。

linkTarget。IsXRefTarget = true;

段落填充内容,包括交叉引用和引用对象的页面。

追加(帕拉,“看”的更多信息);追加(para xRefObj);追加(帕拉,“页”);追加(para pageRefObj);追加(帕拉,“更多信息”。);

段对象附加到章对象,然后将对象章。

追加(chapter1, para)追加(rpt, chapter1);

创建另一个章章对象的信息。

chapter2 =(章);

附加的文本“信息”链接目标对象和设置对象章的标题链接目标对象。

linkTarget.append (“信息”);chapter2。标题= linkTarget;

附加报告第二章对象。然后关闭并查看报告。

追加(rpt chapter2);关闭(rpt);rptview (rpt);

当打开报告,测试交叉引用和页面引用的元素。

版本历史

介绍了R2022a

另请参阅

|||||

主题