DocumentGenerator类

对象类型

对象类型

注意：只读

区分通过Dispatch接口引用的对象。

DocumentConnector（长连接器ID，长nDepth，字符串templateName）

布尔型

注意：记录连接器。

参数：

• connectorId：长-连接器的ID
• nDepth：长-调整航向级别的深度
• templateName：字符串-记录连接器时要使用的模板的名称；这可以是空白

DocumentCustomData（字符串XML，长nDepth，字符串templateName）

布尔型

注意：根据提供的数据记录信息。

参数：

• XML：字符串-要记录的数据的XML
• nDepth：长-调整航向级别的深度
• templateName：字符串-在记录自定义数据时要使用的模板的名称；这可以是空白

DocumentDiagram（长图ID，长nDepth，字符串templateName）

布尔型

注意：记录图表。

参数：

• diagramId：长-图表的ID
• nDepth：长-调整航向级别的深度
• templateName：字符串-记录图表时要使用的模板的名称；这可以是空白

DocumentElement（长elementID，长nDepth，字符串templateName）

布尔型

注意：记录元素。

参数：

• elementId：长整数-元素的ID
• nDepth：长-调整航向级别的深度
• templateName：字符串-文档元素时要使用的模板的名称；这可以是空白

DocumentModelAuthor（字符串名称，长nDepth，字符串templateName）

布尔型

注意：记录模型作者。

参数：

• name：字符串-作者姓名
• nDepth：长-调整航向级别的深度
• templateName：字符串-在记录模型作者时要使用的模板；这可以是空白

DocumentModelClient（字符串名称，长nDepth，字符串templateName）

布尔型

注意：记录单个模型客户端。

参数：

• name：字符串-客户端的名称
• nDepth：长-调整航向级别的深度
• templateName：字符串-文档客户端模型时使用的模板；这可以是空白

DocumentModelGlossary（长id，长nDepth，字符串templateName）

布尔型

注意：记录单个模型词汇表术语。

参数：

• id：长整数-术语的ID
• nDepth：长-调整航向级别的深度
• templateName：字符串-文档模型词汇表术语时要使用的模板；这可以是空白

DocumentModelIssue（长id，长nDepth，字符串templateName）

布尔型

注意：记录单个模型问题。

参数：

• id：长-问题的ID
• nDepth：长-调整航向级别的深度
• templateName：字符串-记录模型问题时要使用的模板；这可以是空白

DocumentModelResource（字符串名称，长nDepth，字符串templateName）

布尔型

注意：记录单个模型资源。

参数：

• name：字符串-资源的名称
• nDepth：长-调整航向级别的深度
• templateName：字符串-文档模型资源时要使用的模板；这可以是空白

DocumentModelRole（字符串名称，长nDepth，字符串templateName）

布尔型

注意：记录单个模型角色。

参数：

• name：字符串-角色的名称
• nDepth：长-调整航向级别的深度
• templateName：字符串-文档模型角色时要使用的模板；这可以是空白

DocumentModelTask（长id，长nDepth，字符串templateName）

布尔型

注意：记录单个模型任务。

参数：

• id：长-任务的ID
• nDepth：长-调整航向级别的深度
• templateName：字符串-在记录模型任务时使用的模板；这可以是空白

DocumentPackage（长packageID，
长nDepth，
字符串templateName）

布尔型

注意：记录包装。

参数：

• packageId：长整数-包的ID
• nDepth：长-调整航向级别的深度
• templateName：字符串-记录软件包时要使用的模板；这可以是空白

GetDocumentAsRTF（）

只读。

以原始RTF格式返回文档的字符串值。

GetProjectConstant（字符串nameVal）

串

注意：返回项目常量的值。

参数：

• nameVal：字符串-要为其提取值的项目常量的名称。

GetLastError（）

串

注意：返回一个字符串值，该字符串值描述与该对象有关的最新错误。

InsertBreak（长breakType）

布尔型

注意：在当前位置的报表中插入一个分隔符。

参数：

• breakType：长整数-0 =分页符，1 =分节符

InsertCoverPageDocument（字符串名称）

布尔型

注意：将“封面”插入当前位置的文档中。

在将样式表插入到生成的文档中之前，将样式表应用于文档。

参数：

• 名称：字符串-在资源树中找到的封面文档的名称

InsertHyperlink（字符串名称，字符串URL）

布尔型

注意：在当前位置插入超链接。如果您使用具有#BOOKMARKNAME语法的URL，则超链接将链接到文档的另一部分。

参数：

• 名称：字符串-插入到报告中的链接文本
• URL：字符串-要链接到的网站的URL

InsertLinkedDocument（字符串guid）

布尔型

注意：将链接文档插入到当前位置的报告中。

链接文档可用于设置报告的页眉和页脚。这些摘自添加到报告中的第一个链接文档。

参数：

• guid：字符串-具有链接文档的元素的GUID

InsertTableOfContents

布尔型

注意：在当前位置插入目录。

InsertTeamReviewPost（字符串路径）

布尔型

注意：将团队库过帐插入到当前位置的报告中。

参数：

• path：字符串-团队库发布的路径

InsertTemplate（字符串templateName）

注意：将模板的内容直接插入到报告中。

参数：

• templateName：字符串-要使用的模板的名称

InsertText（字符串文本，
字符串样式）

布尔型

注意：在当前位置的报表中插入静态文本。

不包括回车；如果需要使用一个，可以手动添加。

参数：

• text：字符串-要插入的静态文本
• style：字符串-模板中样式的名称；默认为普通样式

InsertTOCDocument（字符串名称）

布尔型

注意：将目录插入当前位置的文档中。

注意：样式表在插入到生成的文档中之前已应用到该文档。

参数：

• name：String-在资源树中找到的目录文档的名称

LoadDocument（字符串FileName）

布尔型

注意：将外部文档插入当前生成的文件中。

参数：

• FileName：字符串-要插入到文档中的外部文档文件的文件名。

NewDocument（字串templateName）

布尔型

注意：开始一个新文档；您可以在尝试记录其他任何内容之前调用此方法。

参数：

• templateName：字符串-文档元素时要使用的模板的名称；这可以是空白

ReplaceField（字符串字段名，
字符串字段值）

布尔型

注意：将fieldname参数标识的“ Section”字段替换为fieldvalue中提供的值。例如：

ReplaceField（“ Element.Alias”，“ MyAlias”）

如果使用相同的字段名称多次调用此函数，则该字段仅设置了最新的值。

参数：

• fieldname：字符串-要查找的字段名称（不包括{}大括号）
• fieldvalue：String-要插入到字段中的值；这可以是常量或派生值

SaveDocument（字符串文件名，
nDocType长）

布尔型

注意：将文档保存到磁盘。

参数：

• filename：字符串-将文件保存到的文件名
• nDocType：长整数-0 = RTF，1 = HTML，2 = PDF，
  3 = DOCX

SetPageOrientation（长pageOrientation）

布尔型

注意：设置当前页面方向。

参数：

• pageOrientation：长-0 =纵向，1 =横向

SetProjectConstant（字符串newNameVal，字符串newValue）

布尔型

注意：为文档生成器设置项目常量；这将保存在当前模型中。

参数：

• newNameVal：字符串-项目常量的名称
• newValue：字符串-项目常量的值

SetStyleSheetDocument（字符串名称）

布尔型

注意：设置要用于目录，封面和模板的样式表。可以在NewDocument之前调用它。

参数：

• name：字符串-在资源树中找到的样式表的名称

SetSuppressProfile（名称）

布尔型

注意：设置要在报告生成期间使用的抑制配置文件。

参数：

• 名称：字符串-抑制配置文件的名称，在“文档生成”对话框的“抑制部分”选项卡上创建。