C#设置或验证PDF文本域格式的方法详解

概述

PDF表单中的文本域支持多种内置的格式化需求，如货币显示、日期标准输出等。Adobe Acrobat提供了一系列现成的JavaScript方法来实现这些功能：带有 Format 后缀的方法用于控制内容的视觉呈现样式，而带有 Keystroke 后缀的方法用于拦截并验证用户的实时键盘输入。

在 .NET 环境中，可以使用第三方库简化这一过程。以下图片展示了常用的格式化方式及对应的操作思路：

引入依赖库

为了在 C# 项目中实现上述功能，需要先安装 Spire.PDF 组件。可以通过 NuGet Package Manager 便捷地完成集成：

第1步：打开包管理器控制台

在 Visual Studio 中进入“工具” → “NuGet 包管理器” → “程序包管理控制台”，或直接右键项目选择“管理 NuGet 包”。

第2步：执行安装命令

运行如下指令以拉取指定版本的依赖项：

Install-Package Spire.PDF -Version 7.12.1

若无法联网，也可下载离线压缩包，在项目的“引用”选项中手动导入 BIN 文件夹下的 Spire.Pdf.dll 文件。

C# 实现步骤

下面演示如何在 PDF 页面上创建不同类型的文本框，并为其绑定特定的格式与验证逻辑。

第1步：初始化文档并定义页面参数

新建 PdfDocument 实例，并向其中添加空白页。设定好各输入框的坐标 X, Y，以及宽高尺寸，以便后续排列布局。

第2步：创建并配置货币格式文本域

实例化 PdfTextBoxField 对象，指定名称及位置。利用 PdfJavaScript.GetNumberFormatString() 设置其显示为美元货币格式，同时通过 KeyPressed 动作限制仅允许有效数字键入，防止非法字符混入。

第3步：创建日期格式文本域

再次实例化一个新的文本框。调用 GetDateKeystrokeString("mm/dd/yyyy") 和 GetDateFormatString() 方法，使其能够自动解析并展示为标准年月日格式。

第4步：创建特殊标识符文本域（如邮政编码）

对于固定长度的编码类字段，可通过 GetSpecialKeystrokeString(1) 等方式强制规范输入的位数与类型，确保录入信息的统一性。

第5步：创建带数值范围限制的文本域

在某些业务场景中，可能只接受特定区间内的整数。例如使用 GetRangeValidateString(true, -18, true, 18) 来限定数值必须在 -18 到 18 之间，否则不予显示。

第6步：生成百分数显示文本域

针对财务或统计报表，可使用 GetPercentKeystrokeString() 等方法，让用户只需输入底数即可自动转化为百分比形式呈现。

完整代码示例

以下为将所有操作整合后的核心实现代码，可以直接复制到控制台应用中运行：

using Spire.Pdf;
using Spire.Pdf.Actions;
using Spire.Pdf.Fields;
using System.Drawing;

namespace SetTextFormatInTextboxField
{
    class Program
    {
        static void Main(string[] args)
        {
            //新建PDF文档,并添加空白页
            PdfDocument pdf = new PdfDocument();
            PdfPageBase page = pdf.Pages.Add();

            //定义坐标变量
            float X = 10;
            float Y = 10;
            float width = 100;
            float height = 20;

            //实例化一个文本域对象，并设置它的位置和边框样式
            PdfTextBoxField textbox = new PdfTextBoxField(page, "Number-TextBox");           
            textbox.Bounds = new RectangleF(X, Y, width, height);
            textbox.BorderWidth = 0.75f;
            textbox.BorderStyle = PdfBorderStyle.Solid;

            //给文本域的键盘击键事件设置一个JavaScript动作用于验证输入内容是否符合要求
            string js = PdfJavaScript.GetNumberKeystrokeString(2, 0, 0, 0, "$", true);
            PdfJavaScriptAction jsAction = new PdfJavaScriptAction(js);
            textbox.Actions.KeyPressed = jsAction;

            //设置文本域内容显示为数字货币
            js = PdfJavaScript.GetNumberFormatString(2, 0, 0, 0, "$", true);
            jsAction = new PdfJavaScriptAction(js);
            textbox.Actions.Format = jsAction;

            //添加文本域到PDF中,并保存文档
            pdf.Form.Fields.Add(textbox);


            //添加文本框，设置文本内容显示为日期格式
            PdfTextBoxField textbox1 = new PdfTextBoxField(page, "DateFormat-TextBox");
            textbox1.Bounds = new RectangleF(X+200, Y, width, height);
            textbox1.BorderWidth = 0.75f;
            textbox1.BorderStyle = PdfBorderStyle.Solid;
            string js1 = PdfJavaScript.GetDateKeystrokeString("mm/dd/yyyy");
            PdfJavaScriptAction jsAction1 = new PdfJavaScriptAction(js1);
            textbox1.Actions.KeyPressed = jsAction1;
            js1 = PdfJavaScript.GetDateFormatString("mm/dd/yyyy");
            jsAction1 = new PdfJavaScriptAction(js1);
            textbox1.Actions.Format = jsAction1;
            pdf.Form.Fields.Add(textbox1);


            //添加文本框，设置文本内容显示为邮政编码格式
            PdfTextBoxField textbox2 = new PdfTextBoxField(page, "SpecialFormat0-1-TextBox");
            textbox2.Bounds = new RectangleF(X + 400, Y, width, height);
            textbox2.BorderWidth = 0.75f;
            textbox2.BorderStyle = PdfBorderStyle.Solid;
            //string js2 = PdfJavaScript.GetSpecialKeystrokeString(0);
            string js2 = PdfJavaScript.GetSpecialKeystrokeString(1);

            PdfJavaScriptAction jsAction2 = new PdfJavaScriptAction(js2);
            textbox2.Actions.KeyPressed = jsAction2;
            //js2 = PdfJavaScript.GetSpecialFormatString(0);
            js2 = PdfJavaScript.GetSpecialFormatString(1);
            jsAction2 = new PdfJavaScriptAction(js2);
            textbox2.Actions.Format = jsAction2;
            pdf.Form.Fields.Add(textbox2);


            //添加文本框，设置文本内容显示为百分数
            PdfTextBoxField textbox3 = new PdfTextBoxField(page, "SpecialFormat2-TextBox");
            textbox3.Bounds = new RectangleF(X, Y+50, width, height);
            textbox3.BorderWidth = 0.75f;
            textbox3.BorderStyle = PdfBorderStyle.Solid;
            string js3 = PdfJavaScript.GetPercentKeystrokeString(1,0);
            PdfJavaScriptAction jsAction3 = new PdfJavaScriptAction(js3);
            textbox3.Actions.KeyPressed = jsAction3;
            js3 = PdfJavaScript.GetPercentFormatString(1, 0);
            jsAction3 = new PdfJavaScriptAction(js3);
            textbox3.Actions.Format = jsAction3;
            pdf.Form.Fields.Add(textbox3);

            //添加文本框，设置数据验证
            PdfTextBoxField textbox4 = new PdfTextBoxField(page, "RangeValidate-TextBox");
            textbox4.Bounds = new RectangleF(X+200, Y + 50, width, height);
            textbox4.BorderWidth = 0.75f;
            textbox4.BorderStyle = PdfBorderStyle.Solid;
            string js4 = PdfJavaScript.GetRangeValidateString(true, -18, true, 18);
            PdfJavaScriptAction jsAction4 = new PdfJavaScriptAction(js4);
            textbox4.Actions.Format = jsAction4;
            pdf.Form.Fields.Add(textbox4);

            //保存文档
            pdf.SaveToFile("FormatField.pdf", FileFormat.PDF);
        }
    }
}

运行效果验证

完成编译并执行程序后，生成的PDF文件将包含多个经过格式化的文本框。在实际填写过程中，系统将按照预设规则进行实时的输入过滤与展示调整。具体界面表现可参考下图所示：

以上就是C#设置或验证PDF文本域格式的方法详解的详细内容，更多关于C#设置与验证PDF表单字段的实用技巧资料请关注本站其它相关文章！