slreportgen.report.DocBlockclass

包:slreportgen.report
超类:slreportgen.report.Reporter

DocBlock记者

扩展所有的页面

描述

使用的对象slreportgen.report.DocBlock类报告DocBlock块。

请注意

使用一个DocBlock记者在一份报告中,您必须创建报告使用slreportgen.report.Report类或子类。

记者包括DocBlock在其中一个方面内容在一份报告中:

在报告中包括的实际内容
内容保存到外部文件并添加一个链接的文件报告
嵌入报告中的内容作为一个文件并添加一个链接嵌入的文件

表显示当记者包括链接,或嵌入的内容,根据DocBlock内容类型、报告类型、和的值ConvertHTML和EmbedFile属性。

DocBlock内容类型	报告类型	ConvertHTML财产	EmbedFile财产	报告包含
DocBlock内容类型	报告类型	ConvertHTML财产	EmbedFile财产	DocBlock内容	外部链接DocBlock内容文件	链接到嵌入式DocBlock内容文件
文本	HTML	N /一个	N /一个	是的	没有	没有
文本	html文件	N /一个	N /一个	是的	没有	没有
文本	词	N /一个	N /一个	是的	没有	没有
文本	PDF	N /一个	N /一个	是的	没有	没有
HTML	HTML	N /一个	N /一个	是的	没有	没有
HTML	html文件	N /一个	N /一个	是的	没有	没有
HTML	PDF	真正的	N /一个	是的	没有	没有
HTML	PDF	假	真正的	没有	没有	是的
HTML	PDF	假	假	没有	是的	没有
HTML	词	真正的	N /一个	是的	没有	没有
HTML	词	假	N /一个	没有	是的	没有
RTF	PDF	N /一个	真正的	没有	没有	是的
RTF	PDF	N /一个	假	没有	是的	没有
RTF	词	N /一个	N /一个	是的	没有	没有
RTF	HTML	N /一个	真正的	没有	没有	是的
RTF	HTML	N /一个	假	没有	是的	没有
RTF	html文件	N /一个	N /一个	没有	是的	没有

的slreportgen.report.DocBlock类是一个处理类。

类属性

HandleCompatible 真正的

类属性的信息,请参阅类属性。

创建

描述

rptr = slreportgen.report.DocBlock ()创建一个空DocBlock记者根据默认模板。定制的内容和格式生成的内容通过记者属性。添加报告记者之前,您必须指定DocBlock在对象记者的属性。添加一个空的记者报道产生一个错误。

例子

rptr = slreportgen.report.DocBlock (docBlockObj)创建一个DocBlock记者DocBlock指定的docBlockObj,这可能是一个DocBlock路径或处理。看到对象财产。

rptr= slreportgen.report.DocBlock (名称,值)集记者属性使用名称-值对。你可以在任何顺序指定多个参数名称-值对。在单引号或双引号将每个属性的名字。

属性

全部展开

`对象`- - - - - -金宝app^®DocBlock块
`[]`(默认)|字符串标量|特征向量|处理

金宝appDocBlock块指定为字符串标量或特征向量包含路径DocBlock或作为一个句柄DocBlock块。

请注意

如果您使用一个发现者DocBlock块和将结果直接添加到报告中,DocBlock记者是用来报告DocBlock块,而不是模型对象属性记者。金宝app

`ImportTextInline`- - - - - -是否要导入文本内容一致
`假`(默认)|`真正的`

是否进口纯文本内容,指定为真正的或假。如果ImportTextInline是假记者附加内容之前,一个洞,它封装在一个或多个段落的内容,根据的价值TexSep财产。集ImportTextInline来真正的添加DocBlock在一段文本内容,一个洞洞(内联)。

`TextSep`- - - - - -分离器的划定段落文本内容
“忽略”(默认)|“换行”|“BlankLine”

分离器用于划段落在纯文本内容,表中指定的值。您可以指定的值作为字符串标量或特征向量。

价值	描述
`“忽略”`	文字换行在一段无论它包含分隔符。(默认)
`“换行”`	如果一个文本片段以换行结束,包装在一个段落。
`“BlankLine”`	如果一个文本片段结束于一个空行,包装在一个段落。

`ConvertHTML`- - - - - -是否包含HTML内容
`真正的`(默认)|`假`

是否包含HTML内容,指定为真正的或假这财产仅适用于词和PDF报告。

如果该值为真正的,HTML内容转换为DOM对象附加到一个报告。

如果该值为假:

PDF报告,报告嵌入内容或包括一个外部链接的内容,根据的价值EmbedFile财产。
字的报告,报告包括一个外部链接的内容。

如果报告是一个HTML或HTML文件报告,HTML内容包含在报告中,不管的价值ConvertHTML财产。

`EmbedFile`- - - - - -是否要嵌入的内容
`假`(默认)|`真正的`

是否要嵌入的内容DocBlock块生成的报告中,指定为真正的或假。这个属性只适用于HTML或RTF满意PDF报告和RTF内容的HTML报告。如果该值为真正的,记者嵌入DocBlock报告内容,插入一个嵌入式文件的超链接。

`ParagraphFormatter`- - - - - -为纯文本段落格式化程序
`mlreportgen.dom.Paragraph`

段落格式的纯文本,如果格式化程序对象ImportTextInline属性是假指定为一个mlreportgen.dom.Paragraph对象。的初始值ParagraphFormatter房地产是一个mlreportgen.dom.Paragraph对象的默认属性值。定制的外观段,修改mlreportgen.dom.Paragraph对象属性或替换对象与一个定制的mlreportgen.dom.Paragraph对象。如果你添加内容到默认或更换段对象,内容出现在前面DocBlock在生成的报告内容。

`定义`- - - - - -纯文本的文本格式化器
`mlreportgen.dom.Text`

文本格式的纯文本,如果格式化程序对象ImportTextInline属性是真正的指定为一个mlreportgen.dom.Text对象。的初始值定义房地产是一个mlreportgen.dom.Text对象的默认属性值。自定义文本的外观,修改mlreportgen.dom.Text对象属性或替换对象与一个定制的mlreportgen.dom.Text对象。如果你添加内容到默认或更换段对象,内容出现在前面DocBlock在生成的报告内容。

`TemplateSrc`- - - - - -这个记者的模板
`[]`(默认)|特征向量|字符串标量|记者或报告|DOM文档或文档部分

这个记者的模板,指定其中的一个方面:

特征向量或字符串标量指定路径的文件,其中包含的模板的记者
记者或报告的模板是用于这个记者或模板库中包含的模板的记者
DOM文档或文档模板的一部分用于记者或模板库中包含的模板的记者

指定的模板必须是相同的类型作为这个记者是附加的报告。例如,对于一个微软^®词报告,TemplateSrc必须是一个文字记者模板。如果TemplateSrc属性是空的,这个记者记者使用默认模板输出类型的报告。

`TemplateName`- - - - - -这个记者名字的模板
特征向量|字符串标量

这个记者,模板的名称指定为一个特征向量或字符串标量。这个记者的模板必须在模板的模板库源(TemplateSrc这个记者)。

`LinkTarget`- - - - - -这个记者超链接的目标
`[]`(默认)|特征向量|字符串标量|`mlreportgen.dom.LinkTarget`对象

这个记者,超链接目标指定为一个特征向量或指定链接目标ID字符串标量,或一个mlreportgen.dom.LinkTarget对象。一个特征向量或字符串转换为一个标量值LinkTarget对象。链接目标立即先于这个记者在输出中报告的内容。

方法

全部展开

公共方法

`slreportgen.report.DocBlock.createTemplate`	创建DocBlock记者模板
`slreportgen.report.DocBlock.customizeReporter`	创建自定义类DocBlock记者
`slreportgen.report.DocBlock.getClassFolder`	得到DocBlock记者类定义文件的位置
`复制`	创建的副本金宝app记者对象,使深拷贝的某些属性值
`getImpl`	得到实现的记者

例子

全部折叠

包括DocBlock内容在一份报告中称

打开生活的脚本

包括的内容传感器信息DocBlock的slrgex_fuelsys模型通过添加的一份报告中DocBlock记者的报告。指定的段落DocBlock由换行符分隔。

%导入API包进口slreportgen.report。*进口mlreportgen.report。*%加载模型model_name =“slrgex_fuelsys”;load_system (model_name);docBlock =“slrgex_fuelsys /控制器/传感器信息”;%创建一个报告rpt = slreportgen.report.Report (“输出”,“pdf”);%创建一个记者章章=章(docBlock);%创建一个DocBlock记者%指定段落由换行符分隔rptr = DocBlock (DocBlock);rptr。TextSep =“换行”;%添加DocBlock记者章%在报表中添加这一章添加(章,rptr);add (rpt,章);%,查看输出报告关闭(rpt);close_system (model_name);rptview (rpt);