Main Content

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

mlreportgen.dom.LineBreak 类

命名空间: mlreportgen.dom

Word 或 PDF 报 告中的换行符

全页展开

描述

使用 mlreportgen.dom.LineBreak 对象在 Microsoft® Word 或 PDF 报 告中的任何位置插入换行符。

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

类属性

HandleCompatible
true
ConstructOnLoad
true

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

创建对象

描述

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

示例

属性

全部展开

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

注意

Microsoft Word 输 出忽略样式名称。

属性：

NonCopyable
true

数据类型: char | string

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

属性：

NonCopyable
true

数据类型: cell

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

属性：

NonCopyable
true

mlreportgen.dom.LineBreak 对象的父级，指定为文档元素对象。一个文档元素必须只有一个父元素。

属性：

SetAccess
private
NonCopyable
true

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

属性：

SetAccess
private
NonCopyable
true

mlreportgen.dom.LineBreak 对象的标签，指定为字符向量或字符串标量。DOM API 在创建此对象的过程中生成一个会话唯一标签。生成的标签形式为 CLASS:ID，其中 CLASS 是对象类，ID 是对象的 Id 属性的值。指定您自己的标签值，以帮助您确定在文档生成过程中出现问题时要查找的位置。

属性：

NonCopyable
true

数据类型: char | string

mlreportgen.dom.LineBreak 对象的对象标识符，指定为字符向量或字符串标量。DOM API 在创建文档元素对象时会生成一个会话唯一标识符。您可以为 Id 指定自己的值。

属性：

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");

为 Paragraph 对象的 WhiteSpace 方法指定 preserve，以便为其添加换行符。将 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 中推出

另请参阅

| | | |

主题