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

mlreportgen.dom.LineBreak 类

命名空间: mlreportgen.dom

Word 或 PDF 报告中的换行符

全页展开

描述

使用 mlreportgen.dom.LineBreak 类的实例在 Microsoft® Word 或 PDF 报告的任意位置插入换行符。

要了解可以将 mlreportgen.dom.LineBreak 对象追加到哪些 DOM 对象，请参阅将 mlreportgen.dom.LineBreak 对象追加到 DOM 类对象上。

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

  • "docx"

  • "pdf"

  • "pdfa" (自 R2025a 起)

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

类属性

HandleCompatible
true
ConstructOnLoad
true

有关类属性的信息，请参阅类属性。

创建对象

描述

lBreak = mlreportgen.dom.LineBreak 创建一个换行符对象。

示例

属性

全部展开

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

注意

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

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

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

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: cell

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

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

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

属性：

GetAccess
public
SetAccess
private
NonCopyable
true

此对象的子对象，指定为文档元素对象数组。此属性包含使用 append 方法追加的文档元素对象。

属性：

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

方法

全部展开

示例

全部折叠

打开实时脚本

本示例演示了如何使用 LineBreak 对象在 PDF 报告中插入换行符。

导入 DOM API 命名空间，这样您就不必使用长而完全限定的名称。

import mlreportgen.dom.*;

创建一个 Document 对象并打开它。

d = Document("LineBreakReport","pdf");
open(d);

创建第一页并向对象添加标题。创建一个 Paragraph 对象 p。

h = Heading1("Learning to Use Line Breaks");
append(d,h);
p = Paragraph("Use a LineBreak object");

为 preserve 对象的 WhiteSpace 方法指定 Paragraph，以便为其添加换行符。将 LineBreak 句柄类追加到段落。

p.WhiteSpace = 'preserve';
append(p,LineBreak);

通过将下一行追加到现有的 Paragraph 对象来插入下一行。将该段落追加至 Document。 

append(p,"to force a new line in a paragraph");
append(d,p);

关闭并查看文档。

close(d);
rptview(d);

详细信息

全部展开

版本历史记录

在 R2016b 中推出

另请参阅

| | | |

主题