Form – Aspose FOSS API Reference

Form

概述

Form 是 Aspose.PDF FOSS 中用于 .NET 的一个类。继承自：IDisposable。

用于表单字段操作的外观（Facade），包括 XML 的导入/导出。

此类为 .NET 程序中的 Form 对象提供了 55 个方法。可用的方法包括：BindPdf、Close、Dispose、ExportFdf、ExportJson、ExportXfdf、ExportXml、ExtractXfaData、FillBarcodeField、FillField、FillFields、FillImageField，以及另外 24 个方法。安装 Aspose.PDF FOSS for .NET 包后，所有公共成员对任何 .NET 应用程序均可访问。属性包括：ConvertTo、DestFileName、DestStream、Document、FieldNames、FormSubmitButtonNames，以及另外 3 项。

属性

名称	类型	访问	描述
`ImportResult`	`FormImportResult[]`	读取	最近一次 ImportFdf/ ImportXfdf/ImportXml 调用的各字段结果。
`Document`	`Document?`	读取	底层文档。
`FormSubmitButtonNames`	`string[]`	读取	获取表单中提交按钮的名称。
`SrcFileName`	`string?`	读写	源文件名。
`SrcStream`	`Stream?`	读写	源流。
`ConvertTo`	`Aspose.Pdf.PdfFormat`	读写	目标 PDF/A 或 PDF 版本的已保存输出。
`FieldNames`	`string[]`	读取	获取表单中的所有字段名称。
`DestFileName`	`string?`	读写	保存的目标文件名。
`DestStream`	`Stream?`	读写	用于保存的目标流。

方法

签名	描述
`Form()`	创建一个未绑定的 Form facade。
`Form(document: Document)`	创建一个绑定到文档的 Form facade。
`Form(document: Document, destStream: Stream)`	绑定 Document 并为无参 Save 预先配置输出流。
`Form(document: Document, destFileName: string)`	绑定 Document 并为无参 Save 预先配置输出文件路径。
`Form(srcFileName: string, destFileName: string)`	从输入和输出文件路径创建 Form facade。
`Form(srcFileName: string, destStream: Stream)`	从输入文件创建 Form facade，在保存时写入流。
`Form(srcFileName: string)`	从输入文件路径创建 Form facade。
`Form(srcStream: Stream)`	从流创建 Form facade。
`Form(srcStream: Stream, destStream: Stream)`	从源流创建 Form facade，在保存时写入目标流。
`Form(srcStream: Stream, destFileName: string)`	从源流创建 Form facade，在保存时写入目标文件。
`BindPdf(path: string)`	将 PDF 文件绑定到此 facade。
`BindPdf(doc: Document)`	将文档绑定到此 facade。
`BindPdf(stream: Stream)`	将 PDF 流绑定到此 facade。
`GetFieldLimit(fieldName: string)`	根据名称获取文本字段的最大字符数。
`GetField(fieldName: string)`	通过名称获取字段值。
`FillField(fieldName: string, fieldValue: string)`	用一个值填充字段。
`FillField(fieldName: string, beChecked: bool)`	使用布尔值填充字段（用于复选框/单选按钮）。
`GetFieldType(fieldName: string)`	按名称获取字段的类型。
`GetFieldTemplate(fieldName: string)`	返回指定字段的 XFA 模板节点（当文档没有 XFA 或字段不存在时返回 null）。
`GetFieldFacade(fieldName: string)`	获取字段的可视化外观属性。
`GetButtonOptionCurrentValue(fieldName: string)`	获取按钮（单选按钮）字段的当前值。
`GetButtonOptionValues(fieldName: string)`	获取按钮（单选按钮）字段的选项值。
`GetFullFieldName(fieldName: string)`	获取完整限定的字段名称。
`FlattenField(fieldName: string)`	按名称展平特定字段——将其渲染为静态内容并移除交互状态。
`FlattenAllFields()`	展平文档中的所有表单字段——将它们渲染为静态内容并移除 AcroForm。
`ImportXml(inputXmlStream: Stream, IgnoreFormTemplateChanges: bool)`	从 XML 流导入表单字段值。
`ImportXfdf(inputXfdfStream: Stream)`	从 XFDF 流导入表单字段数据。
`ImportFdf(inputFdfStream: Stream)`	从 FDF 流导入表单字段数据。
`ExportXml(outputXmlStream: Stream)`	将表单字段值导出到 XML 流。
`ExportFdf(outputFdfStream: Stream)`	将表单字段值以 FDF 格式导出到流。
`ExportXfdf(outputXfdfStream: Stream)`	将表单字段值以 XFDF 格式导出到流。
`ExportJson(outputJsonStream: Stream, indented: bool)`	将文档中所有字段的内容导出到 JSON 流中。
`ImportJson(inputJsonStream: Stream)`	从 JSON 流中导入字段值到绑定的文档中，按完整名称匹配字段。
`HasField(fullName: string)`	如果绑定表单中存在具有给定完整名称的字段，则为 True。
`Save()`	保存已修改的文档。
`Save(destFile: string)`	保存到指定路径。
`Save(destStream: Stream)`	将已修改的文档保存到流中。
`SaveBytes()`	保存修改后的文档并返回字节。
`Close()`	关闭 facade。
`Dispose()`	对该 Form 实例调用 Dispose。
`ExtractXfaData(outputXmlStream: Stream)`	将文档的 XFA 数据集 XML 提取到流中。
`SetXfaData(inputXmlStream: Stream)`	将文档的 XFA 数据集 XML 从流中替换。
`FillBarcodeField(fieldName: string, data: string)`	按名称填充条形码字段，使用给定的数据。
`FillField(fieldName: string, value: string, fitFontSize: bool)`	使用提供的值填充文本字段，可选地将字体大小适配到框内。
`FillField(fieldName: string, index: int)`	通过所选选项索引（从0开始）填充选择或单选字段。
`FillField(fieldName: string, fieldValues: string[])`	使用提供的多选值填充列表框字段。
`FillFields(fieldNames: string[], fieldValues: string[], output: Stream)`	应用多个字段值并将生成的 PDF 以流的形式返回。
`FillImageField(fieldName: string, imageStream: Stream)`	通过嵌入图像作为字段小部件的常规外观 (/AP/N) 来填充图像字段，并按比例填充每个小部件的矩形。
`FillImageField(fieldName: string, imageFileName: string)`	从文件路径填充图像字段。
`GetFieldFlag(fieldName: string)`	获取字段上设置的 PropertyFlag（ReadOnly / 必填 / NoExport）。
`GetRichText(fieldName: string)`	返回字段的富文本内容（/RV 条目），如果不存在则返回 null。
`GetSubmitFlags(fieldName: string)`	返回在提交按钮字段上记录的 SubmitFormFlag，从其 /A submit-form 操作的 /Flags 位掩码读取。
`IsRequiredField(fieldName: string)`	当字段设置了 Required 标志时为 True。
`RenameField(fieldName: string, newFieldName: string)`	重命名表单字段。
`ImportXml(inputXmlStream: Stream)`	从 XML 流导入表单字段值（无参数重载 — 等同于 ImportXml(Stream, bool)，其中 ignoreFormTemplateChanges=false）。

另请参阅

Aspose.PDF for .NET — Enterprise API Reference