nuget server logo nuget api documents
↑

API Docs / Microsoft.VisualBasic.MIME.RTF / RtfDocument

RtfDocument

Full name Microsoft.VisualBasic.MIME.RTF.RtfDocument Assembly Microsoft.VisualBasic.MIME.RTF Members 46

RTF 文档生成器。实现 IDocumentWriter，对外提供与 WordDocument / PdfDocument 完全一致的编程接口， 将文本、表格、图片写入并生成 .rtf 文件。

00 Remarks

该类不改动既有的 Rtf 文档对象模型，两者相互独立： Rtf 面向"逐步追加带样式的文本区域"， RtfDocument 面向"结构化文档写入接口"。

01 Syntax

Microsoft.VisualBasic.MIME.RTF.RtfDocument

02 Methods

NameOverloadsSummary
.ctor 1 构造 RTF 文档生成器。默认样式与 WordDocument / PdfDocument 保持一致。
HeadingStyle 1 设置指定级别的标题样式 (level 1-6)。
ParagraphStyle 1 设置正文段落样式。
DefaultStyle 1 设置文档默认样式。
TableStyle 1 设置表格样式。
CodeStyle 1 设置代码块样式。
BlockquoteStyle 1 设置引用块样式。
TitleStyle 1 设置文档标题样式。
PageSetup 1 设置页面尺寸和边距 (twips)。
PageSetupA4 1 A4 纸张，1 英寸边距。
PageSetupLetter 1 Letter 纸张，1 英寸边距。
DocTitle 1 写入文档标题（居中大字号，非 heading 样式）。
H1 1 写入一级标题。
H2 1 写入二级标题。
H3 1 写入三级标题。
H4 1 写入四级标题。
H5 1 写入五级标题。
H6 1 写入六级标题。
Heading 1 写入指定级别的标题 (level 1-6)。
Paragraph 2 写入正文段落（指定样式）。
CodeBlock 1 写入代码块（等宽字体，灰色底纹）。
Blockquote 1 写入引用块。
List 1 写入列表（有序或无序）。
TaskList 1 写入任务列表。
DefinitionList 1 写入定义列表。
Hr 1 写入水平分割线。
PageBreak 1 插入分页符。
Toc 1 插入目录 (TOC)。
Table 3 写入等宽表格（交错数组形式）。
TableAutoFitWindow 2 写入表格，按窗口宽度自适应。
TableAutoFitContents 2 写入表格，按内容宽度自适应。
Image 1 插入图片。图片二进制将以十六进制内嵌进 RTF（png / jpg / jpeg）。
WriteBlocks 1 将一组 Markdown 内容块写入文档。
WriteBlock 1 将单个 Markdown 内容块映射为等价的写入调用。映射语义与 WordDocument.WriteBlock / PdfDocument.WriteBlock 保持一致。
Save 1 将文档保存到指定文件路径。

03 Properties

NameOverloadsSummary
Author 1 文档作者。
Title 1 文档标题。
Subject 1 文档主题。
Description 1 文档描述。
Tags 1 文档标签。
ApplicationName 1 生成该文档的应用程序名称。

04 Members

method .ctor #
#ctor(String, String, String(), String, String)

构造 RTF 文档生成器。默认样式与 WordDocument / PdfDocument 保持一致。

method HeadingStyle #
HeadingStyle(Int32, WordStyle)

设置指定级别的标题样式 (level 1-6)。

method ParagraphStyle #
ParagraphStyle(WordStyle)

设置正文段落样式。

method DefaultStyle #
DefaultStyle(WordStyle)

设置文档默认样式。

method TableStyle #
TableStyle(TableStyle)

设置表格样式。

method CodeStyle #
CodeStyle(WordStyle)

设置代码块样式。

method BlockquoteStyle #
BlockquoteStyle(WordStyle)

设置引用块样式。

method TitleStyle #
TitleStyle(WordStyle)

设置文档标题样式。

method PageSetup #
PageSetup(Int32, Int32, Int32, Int32, Int32, Int32)

设置页面尺寸和边距 (twips)。

method PageSetupA4 #
PageSetupA4

A4 纸张，1 英寸边距。

method PageSetupLetter #
PageSetupLetter

Letter 纸张，1 英寸边距。

method DocTitle #
DocTitle(String)

写入文档标题（居中大字号，非 heading 样式）。

method H1 #
H1(String)

写入一级标题。

method H2 #
H2(String)

写入二级标题。

method H3 #
H3(String)

写入三级标题。

method H4 #
H4(String)

写入四级标题。

method H5 #
H5(String)

写入五级标题。

method H6 #
H6(String)

写入六级标题。

method Heading #
Heading(Int32, String)

写入指定级别的标题 (level 1-6)。

method Paragraph overload 2 #
Paragraph(String)

写入正文段落。

method Paragraph #
Paragraph(String, WordStyle)

写入正文段落（指定样式）。

method CodeBlock #
CodeBlock(String, String)

写入代码块（等宽字体，灰色底纹）。

method Blockquote #
Blockquote(String)

写入引用块。

method List #
List(String(), Boolean)

写入列表（有序或无序）。

method TaskList #
TaskList(String(), Boolean())

写入任务列表。

method DefinitionList #
DefinitionList(String(), String())

写入定义列表。

method Hr #
Hr

写入水平分割线。

method PageBreak #
PageBreak

插入分页符。

method Toc #
Toc(Int32)

插入目录 (TOC)。

method Table overload 3 #
Table(String(), String[0:,0:])

写入等宽表格（二维数组形式）。

method Table overload 2 #
Table(String(), String[0:,0:], String())

写入表格（二维数组形式，支持对齐方式）。

method Table #
Table(String(), String()(), String())

写入等宽表格（交错数组形式）。

method TableAutoFitWindow #
TableAutoFitWindow(String(), String()(), String(), Boolean, Boolean)

写入表格，按窗口宽度自适应。

method TableAutoFitWindow overload 2 #
TableAutoFitWindow(String[0:,0:], String[0:,0:], String(), Boolean, Boolean)

写入表格，按窗口宽度自适应（二维数组形式）。

method TableAutoFitContents #
TableAutoFitContents(String(), String()(), String(), Boolean, Boolean)

写入表格，按内容宽度自适应。

method TableAutoFitContents overload 2 #
TableAutoFitContents(String[0:,0:], String[0:,0:], String(), Boolean, Boolean)

写入表格，按内容宽度自适应（二维数组形式）。

method Image #
Image(String, Double, Double, String)

插入图片。图片二进制将以十六进制内嵌进 RTF（png / jpg / jpeg）。

method WriteBlocks #
WriteBlocks(IEnumerable(Of Block))

将一组 Markdown 内容块写入文档。

method WriteBlock #
WriteBlock(Block)

将单个 Markdown 内容块映射为等价的写入调用。映射语义与 WordDocument.WriteBlock / PdfDocument.WriteBlock 保持一致。

method Save #
Save(String)

将文档保存到指定文件路径。

property Author #
Author

文档作者。

property Title #
Title

文档标题。

property Subject #
Subject

文档主题。

property Description #
Description

文档描述。

property Tags #
Tags

文档标签。

property ApplicationName #
ApplicationName

生成该文档的应用程序名称。