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

getImpl

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

获取报告器的实现

全页展开

语法

impl = getImpl(reporter,report)

说明

impl = getImpl(reporter,report) 返回在将报告器 reporter 追加到报告 report 时实现该报告器的文档对象模型 (DOM) 对象。

注意

调用此方法后，您无法再向报告器添加内容。

输入参数

全部展开

报告器对象，指定为 mlreportgen.report.Reporter 对象或 mlreportgen.report.Reporter 子类的对象。例如，mlreportgen.report.TitlePage 和 mlreportgen.report.Chapter 类是 mlreportgen.report.Reporter 的子类。

报告，指定为 mlreportgen.report.Report 对象。

输出参量

全部展开

报告器的实现，以 DOM 对象形式返回。DOM 对象通常是 mlreportgen.dom.DocumentPart 类型的对象。如果它是 mlreportgen.dom.DocumentPart 对象，则该对象使用由 TemplateSrc 的 TemplateName 和 reporter 属性指定的模板。

示例

全部展开

获取实现 mlreportgen.report.TitlePage 报告器的 DOM 对象。

rpt = mlreportgen.report.Report("My Report");
titlePage = mlreportgen.report.TitlePage;
titlePage.Title = "Data Summary";
impl = getImpl(titlePage,rpt);

impl = 

  DocumentPart with properties:

         TemplateName: 'TitlePage'
         TemplatePath: 'C:\Program Files\MATLAB\toolbox\shared\mlreportgen\rpt\rpt\+mlreportgen\+report\@TitlePage\resources\templates\pdf\default.pdftx'
                 Type: 'PDF'
        CurrentHoleId: '#end#'
      CurrentHoleType: 'Block'
    CurrentPageLayout: [1×1 mlreportgen.dom.PDFPageLayout]
           OpenStatus: 'open'
               Parent: []
             Children: [1×4 mlreportgen.dom.Element]
                  Tag: 'dom.LockedDocumentPart:5'
                   Id: '5'

提示

  • 使用 getImpl 获取报告器实现的相关信息，并在其他位置使用它，例如行内方程。请参阅在报告中创建内联方程。

  • 可用于 mlreportgen.report.Report 对象的 append 方法使用 getImpl 将报告器内容追加到实现报告的 DOM 文档对象。因此，您可以使用 getImpl 将报告器内容追加到其他类型的 DOM 对象。

  • 如果 getImpl 返回 mlreportgen.dom.DocumentPart 对象，则该方法会使用与空位名称匹配的报告器属性中的内容来填充 mlreportgen.dom.DocumentPart 对象源模板中定义的空位。如果属性不存在，getImpl 会填充空位但不向其添加内容。例如，如果报告器 myReporter 指定了一个包含空位 MyTemplateHole 的模板，则 getImpl 会使用报告器的 MyTemplateHole 属性中的内容来填充该空位（如果该属性存在）。如果您不希望 getImpl 填充空位，请创建一个自定义报告器并重写此方法，使其返回可以添加到 DOM 文档的对象，例如字符串或段落。请参阅定义新的自定义报告器和修改继承的方法。

  • 要在检索实现对象的同时保持向报告器添加内容的能力，请创建报告器的克隆，然后对克隆使用 getImpl。要查看使用此方法的示例，请参阅 创建包含纵向和横向页面的报告。

版本历史记录

在 R2017b 中推出

另请参阅

|

主题