FormEditor

概述

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

表单操作的外观（Facade）：填充字段、展平表单、导入/导出数据。

此类提供 64 个方法，用于在 .NET 程序中处理 FormEditor 对象。可用的方法包括：AddCheckBox、AddField、AddFieldScript、AddListItem、AddSubmitBtn、AddTextField、BindPdf、CheckField、Close、CopyInnerField、CopyOuterField、DecorateField，以及另外 34 个方法。所有公共成员在安装 Aspose.PDF FOSS for .NET 包后，可供任何 .NET 应用程序访问。属性：ConvertTo、DestFileName、DestStream、Document、ExportItems、Facade，以及另外 7 项。

属性

名称	类型	访问	描述
`Document`	`Document`	读取	绑定到此编辑器的文档已公开，以便可以链入另一个外观。
`SrcFileName`	`string?`	读写	无参 ctor + Save 流程使用的源文件路径。
`SrcStream`	`Stream?`	读写	由无参数构造函数 + Save 流程使用的源流。
`DestFileName`	`string?`	读写	由无参数 Save() 写入的目标文件路径。
`DestStream`	`Stream?`	读写	由无参数 Save() 写入的目标流。
`ConvertTo`	`PdfFormat`	读写	目标 PDF/A 或已保存输出的 PDF 版本。
`Facade`	`FormFieldFacade`	读写	由 AddField 和 DecorateField() 应用的视觉外观。
`Items`	`string[]?`	读写	在创建 ListBox / ComboBox 字段时，AddField 使用的默认项目列表。
`ExportItems`	`string[][]?`	读写	导出值对与项目配对。
`RadioButtonItemSize`	`double`	读写	单选按钮项的边长（以点为单位），用于布局单选组时使用。
`RadioGap`	`float`	读写	组内单选按钮项之间的间距（以点为单位）。
`RadioHoriz`	`bool`	读写	为 true 时，单选按钮项水平布局；否则垂直布局。
`SubmitFlag`	`SubmitFormFlag`	读写	由 AddSubmitBtn 和 SetSubmitFlag 使用的提交格式。

方法

签名	描述
`FormEditor()`	无状态基于 byte[] 的 API 的默认构造函数。
`FormEditor(document: Document)`	将编辑器绑定到文档以进行就地操作。
`FormEditor(document: Document, destStream: Stream)`	绑定文档并为无参数的 Save 预先配置输出流。
`FormEditor(document: Document, destFileName: string)`	绑定文档并为无参数的 Save 预先配置输出文件路径。
`FormEditor(srcStream: Stream, destStream: Stream)`	从输入流打开，在 Save 时写入输出流。
`FormEditor(srcFileName: string, destFileName: string)`	从输入文件打开，在 Save 时写入输出文件。
`BindPdf(path: string)`	按路径绑定 PDF 文件以进行编辑。
`BindPdf(pdfData: byte[])`	从字节缓冲区绑定 PDF。
`BindPdf(stream: Stream)`	从流中绑定 PDF。
`BindPdf(document: Document)`	从已打开的 Document 绑定 PDF。
`Save(path: string)`	将已绑定的文档保存到文件路径。
`Save(destStream: Stream)`	将已绑定的文档保存到流中。
`Save()`	将绑定的文档保存到已配置的目标（DestFileName 或 DestStream）。
`Close()`	关闭并释放绑定的文档。
`Dispose()`	对该 FormEditor 实例调用 Dispose。
`SetField(fieldName: string, value: string)`	按名称设置字段值。
`CheckField(fieldName: string)`	按名称勾选复选框字段。
`UncheckField(fieldName: string)`	通过名称取消选中复选框字段。
`AddTextField(fieldName: string, pageNumber: int, llx: double, lly: double, urx: double, ury: double)`	向绑定文档添加文本字段。
`AddCheckBox(fieldName: string, pageNumber: int, llx: double, lly: double, urx: double, ury: double, isChecked: bool)`	向绑定文档添加复选框字段。
`AddField(fieldType: FieldType, fieldName: string, pageNum: int, llx: float, lly: float, urx: float, ury: float)`	在 pageNum 页的指定矩形区域添加给定 fieldType 类型的字段。
`AddField(fieldType: FieldType, fieldName: string, initValue: string?, pageNum: int, llx: float, lly: float, urx: float, ury: float)`	添加一个具有初始值的字段（文本字段和组合框）。
`AddListItem(fieldName: string, itemName: string)`	向 ListBox / ComboBox 字段添加单个项目。
`AddListItem(fieldName: string, exportName: string[])`	添加一个包含导出值对的单项（[display, export]；单元素数组即为两者）。
`DelListItem(fieldName: string, itemName: string)`	从 ListBox / ComboBox 字段中移除单个项目。
`AddSubmitBtn(fieldName: string, page: int, label: string, url: string, llx: float, lly: float, urx: float, ury: float)`	添加一个 Submit 按钮。
`AddFieldScript(fieldName: string, script: string)`	将 JavaScript 动作脚本附加到字段上。
`SetFieldScript(fieldName: string, script: string)`	替换字段的 JavaScript 动作脚本。
`CopyInnerField(fieldName: string, newFieldName: string, pageNum: int)`	在已绑定文档中复制字段到另一页。
`CopyInnerField(fieldName: string, newFieldName: string, pageNum: int, abscissa: float, ordinate: float)`	在已绑定文档中将字段复制到另一页的指定坐标处。
`CopyOuterField(srcFileName: string, fieldName: string)`	从另一个 PDF 文件中复制字段到已绑定文档的相同位置。
`CopyOuterField(srcFileName: string, fieldName: string, pageNum: int)`	将另一个 PDF 文件中的字段复制到绑定文档的指定页面。
`CopyOuterField(srcFileName: string, fieldName: string, pageNum: int, abscissa: float, ordinate: float)`	在明确的坐标处从另一个 PDF 文件复制字段。
`DecorateField()`	对文档中的每个字段应用 Facade。
`DecorateField(fieldType: FieldType)`	对给定类型的每个字段应用 Facade。
`DecorateField(fieldName: string)`	将 Facade 应用于单个具名字段。
`ResetFacade()`	重置 Facade 上的所有属性。
`ResetInnerFacade()`	对 ResetFacade 的别名，覆盖嵌套外观调用者。
`MoveField(fieldName: string, llx: float, lly: float, urx: float, ury: float)`	移动字段的边界框。
`RenameField(fieldName: string, newFieldName: string)`	重命名表单字段。
`RemoveField(fieldName: string)`	按名称删除字段。
`RemoveFieldAction(fieldName: string)`	删除附加到字段的操作。
`SetFieldAlignment(fieldName: string, alignment: int)`	设置字段值的水平对齐方式。
`SetFieldAlignmentV(fieldName: string, alignment: int)`	设置字段值的垂直对齐方式。
`SetFieldAppearance(fieldName: string, flags: AnnotationFlags)`	设置字段的可见性 / 只读 / 必填标志。
`GetFieldAppearance(fieldName: string)`	返回字段的可见性 / 只读 / 必填标志。
`SetFieldAttribute(fieldName: string, flag: PropertyFlag)`	设置 ReadOnly / 必需 / NoExport。
`SetFieldCombNumber(fieldName: string, combNumber: int)`	设置文本字段的 comb-cell 计数（PDF 1.5+）。
`SetFieldLimit(fieldName: string, fieldLimit: int)`	按名称设置文本字段的最大字符数。
`SetSubmitFlag(fieldName: string, submitFormFlag: SubmitFormFlag)`	在按钮字段上设置 SubmitForm 操作标志。
`SetSubmitUrl(fieldName: string, url: string)`	在按钮字段上设置 SubmitForm 操作的目标 URL。
`Single2Multiple(fieldName: string)`	将单行文本字段转换为多行。
`FlattenAllFields()`	将绑定文档中的所有表单字段展平。
`FillFields(input: byte[], fieldValues: Dictionary<string, string>)`	用给定的值填充表单字段（字段名 → 值）。
`FillField(input: byte[], fieldName: string, value: string)`	按名称填充单个表单字段。
`FlattenForm(input: byte[])`	将表单展平 — 将字段渲染为静态内容并移除 AcroForm。
`GetFieldNames(input: byte[])`	获取文档表单中的所有字段名称。
`GetFieldValue(input: byte[], fieldName: string)`	获取特定字段的值。
`GetFieldType(input: byte[], fieldName: string)`	获取特定字段的类型。
`HasForm(input: byte[])`	检查文档是否包含表单。
`GetFieldCount(input: byte[])`	获取表单字段的总数。
`ExportFormData(input: byte[])`	将表单数据导出为字典（字段名 → 值）。
`ImportFormData(input: byte[], data: Dictionary<string, string>)`	从字典导入表单数据。
`RenameField(input: byte[], oldName: string, newPartialName: string)`	在提供的字节中重命名表单字段。

另请参阅

Aspose.PDF for .NET — Enterprise API Reference