主要内容

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

mlreportgen.dom.FOProperties 类

命名空间: mlreportgen.dom

用于格式化 PDF 输出的 FO 属性数组

描述

创建一个包含一个或多个用于 PDF 输出的可扩展样式表语言 (XSL) 格式化对象 (FO) 的对象。使用 mlreportgen.dom.FOProperty 指定格式。有关 FO 属性的信息,请参阅 www.w3.org/2002/08/XSLFOsummary.html

注意

仅对其他 DOM 格式对象不支持的 FO 属性使用 FOProperties 对象。大多数 DOM 格式对象适用于所有输出类型。使用 FOProperty 对象使您的报告应用程序特定于 PDF 输出。

此类仅与以下 MATLAB® Report Generator™ 输出类型兼容:

  • "pdf"

  • "pdfa" (自 R2025a 起)

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

创建对象

输入参量

全部展开

FO 属性,指定为 mlreportgen.dom.FOProperty 对象或者 mlreportgen.dom.FOProperty 对象的数组或元胞数组。

属性

全部展开

FO 属性,指定为 mlreportgen.dom.FOProperty 对象的数组。

属性:

GetAccess
public
SetAccess
private
NonCopyable
true

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

属性:

GetAccess
public
SetAccess
private
NonCopyable
true

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

示例

全部折叠

此示例显示如何将 FO 属性应用于 List 对象。使用 DOM API,您可以使用 PageBreakBefore 在段落上设置分页符属性。但是,您不能在列表上使用 PageBreakBefore 属性。相反,对于 PDF 输出,您可以使用 FO 属性 'break-before' 和值 'page'

import mlreportgen.dom.*

d = Document('Break Before List','pdf');

p = Paragraph('First Page');
p.Style = {PageBreakBefore};
append(d, p);

p = Paragraph('Second Page');
p.Style = {PageBreakBefore};
append(d, p);

list = UnorderedList({'Earl Grey','Jasmine','Honeybush'});
list.Style = {FOProperties(FOProperty('break-before','page'))};
append(d, list);

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

版本历史记录

在 R2016a 中推出