getTitleReporter

类: mlreportgen.report.ListOfCaptions
命名空间: mlreportgen.report

获取题注报告器列表

自 R2020b 起

语法

titleReporter = getTitleReporter(loc)

说明

titleReporter = getTitleReporter(loc) 返回指定的 mlreportgen.report.ListOfCaptions 报告器用来格式化题注列表节标题的 mlreportgen.report.Title 报告器。使用 Title 报告器自定义标题的对齐方式、位置和外观。

输入参数

全部展开

`loc` — 题注列表报告器
`mlreportgen.report.ListOfCaptions` 对象

题注列表报告器，指定为 mlreportgen.report.ListOfCaptions 对象。

输出参量

全部展开

`titleReporter` — 题注列表标题报告器
`mlreportgen.report.Title` 对象

题注列表标题报告器，以 mlreportgen.report.Title 对象形式返回。

示例

全部展开

对题注列表标题使用自定义模板

打开实时脚本

假设您在报告输出类型的模板库中为题注列表标题定义了自定义模板。要使用自定义模板：

使用 getTitleReporter 获取标题报告器。
设置标题报告器的属性。将 Content 属性设置为标题文本，将 TemplateSrc 属性为模板文件的路径和文件名，将 TemplateName 属性为题注列表标题的自定义模板的名称。
将题注列表报告器的 Title 属性设置为标题报告器。

例如，假设模板文件 myTemplate.pdftx 定义了两个模板以用于题注列表标题。一个模板，ListOfCaptionsTitleRed，使用了一种使标题变成红色的样式。第二个模板 ListOfCaptionsTitleBlue 使用使标题变成蓝色的样式。此代码应用了使标题变成蓝色的模板：

import mlreportgen.report.*
import mlreportgen.dom.*
rpt = Report('myReport','pdf');
open(rpt);

loc = ListOfCaptions;
loc.AutoNumberStreamName = "equation";

titleReporter = getTitleReporter(loc);
titleReporter.Content = "List of Equations";
titleReporter.TemplateSrc = "myTemplate.pdftx";
titleReporter.TemplateName = "ListOfCaptionsTitleBlue";
loc.Title = titleReporter;
append(rpt,loc);

ch = Chapter("Physics Principles")
eq = Equation("e = m * c^2");
eq.DisplayInline = true;
append(ch,eq);
      
p = Paragraph("Equation ");
p.Style = {CounterInc('equation'),WhiteSpace("preserve")};
append(p,AutoNumber("equation"));
append(p," Mass–energy equivalence");
append(ch,p);
append(rpt,ch);

close(rpt);
rptview(rpt);