Add 90 example(s) for facades-forms

Author: agent-aspose-pdf-examples

facades-forms/add-digital-signature-field-and-sign-pdf.cs

@@ -0,0 +1,89 @@
+using System;
+using System.IO;
+using Aspose.Pdf;
+using Aspose.Pdf.Facades;
+using Aspose.Pdf.Forms; // for FieldType, PKCS1
+
+class Program
+{
+    static void Main()
+    {
+        // Input and output files
+        const string inputPdf   = "input.pdf";
+        const string outputPdf  = "signed_output.pdf";
+        const string certFile   = "certificate.pfx";
+        const string certPass   = "password";
+        const string appearance = "signature_appearance.png";
+
+        // Verify that required files exist
+        if (!File.Exists(inputPdf))
+        {
+            Console.Error.WriteLine($"Input PDF not found: {inputPdf}");
+            return;
+        }
+        if (!File.Exists(certFile))
+        {
+            Console.Error.WriteLine($"Certificate file not found: {certFile}");
+            return;
+        }
+        if (!File.Exists(appearance))
+        {
+            Console.Error.WriteLine($"Signature appearance image not found: {appearance}");
+            return;
+        }
+
+        // Load the PDF document
+        using (Document doc = new Document(inputPdf))
+        {
+            // Add a signature field named "DigitalSignature" on page 1
+            // Rectangle coordinates: lower‑left (100,100), upper‑right (200,150)
+            using (FormEditor formEditor = new FormEditor(doc))
+            {
+                bool fieldAdded = formEditor.AddField(
+                    FieldType.Signature,          // field type
+                    "DigitalSignature",          // field name
+                    1,                           // page number (1‑based)
+                    100f, 100f,                  // llx, lly
+                    200f, 150f);                 // urx, ury
+
+                if (!fieldAdded)
+                {
+                    Console.Error.WriteLine("Failed to add signature field.");
+                    return;
+                }
+
+                // Persist the added field into the document
+                formEditor.Save();
+            }
+
+            // Prepare the signature object (PKCS1)
+            PKCS1 pkcs1Signature = new PKCS1(certFile, certPass)
+            {
+                Reason      = "Document approved",
+                ContactInfo = "contact@example.com",
+                Location    = "Office"
+            };
+
+            // Sign the document using the newly created field
+            using (PdfFileSignature pdfSigner = new PdfFileSignature())
+            {
+                // Bind the in‑memory document to the signer
+                pdfSigner.BindPdf(doc);
+
+                // Set visual appearance (image) for the signature
+                pdfSigner.SignatureAppearance = appearance;
+
+                // Set the certificate (required for signing)
+                pdfSigner.SetCertificate(certFile, certPass);
+
+                // Sign the field by its name
+                pdfSigner.Sign("DigitalSignature", pkcs1Signature);
+
+                // Save the signed PDF
+                pdfSigner.Save(outputPdf);
+            }
+
+            Console.WriteLine($"Signed PDF saved to '{outputPdf}'.");
+        }
+    }
+}

facades-forms/add-email-validation-javascript-to-pdf-form-field.cs

@@ -0,0 +1,53 @@
+using System;
+using System.IO;
+using Aspose.Pdf;
+using Aspose.Pdf.Facades;
+using Aspose.Pdf.Forms;
+using Aspose.Pdf.Annotations;
+
+class Program
+{
+    static void Main()
+    {
+        const string inputPdf = "input.pdf";   // PDF containing a text field named "Email"
+        const string outputPdf = "output.pdf";
+
+        if (!File.Exists(inputPdf))
+        {
+            Console.Error.WriteLine($"File not found: {inputPdf}");
+            return;
+        }
+
+        // JavaScript that validates the email format on the blur (focus loss) event.
+        // It shows an alert if the entered value does not match a simple email pattern.
+        string jsCode = @"
+if (event.value.match(/^\\S+@\\S+\\.\\S+$/) == null) {
+    app.alert('Invalid email address');
+}";
+
+        // FormEditor is a Facade class used to edit form fields.
+        using (FormEditor formEditor = new FormEditor())
+        {
+            // Bind the existing PDF document.
+            formEditor.BindPdf(inputPdf);
+
+            // Retrieve the field named "Email". The Document property gives access to the core PDF object.
+            // The Form collection is indexed by the full field name.
+            // The collection returns a WidgetAnnotation, which can be cast to Field.
+            Field emailField = formEditor.Document.Form["Email"] as Field;
+            if (emailField == null)
+            {
+                Console.Error.WriteLine("Field 'Email' not found in the PDF.");
+                return;
+            }
+
+            // Assign the JavaScript to the OnLostFocus (blur) action of the field.
+            emailField.Actions.OnLostFocus = new JavascriptAction(jsCode);
+
+            // Save the modified PDF.
+            formEditor.Save(outputPdf);
+        }
+
+        Console.WriteLine($"PDF saved with JavaScript validation: {outputPdf}");
+    }
+}

facades-forms/add-email-validation-to-pdf-form-field.cs

@@ -0,0 +1,39 @@
+using System;
+using System.IO;
+using Aspose.Pdf;
+using Aspose.Pdf.Facades;
+
+class Program
+{
+    static void Main()
+    {
+        const string inputPdf  = "input.pdf";
+        const string outputPdf = "output.pdf";
+
+        if (!File.Exists(inputPdf))
+        {
+            Console.Error.WriteLine($"File not found: {inputPdf}");
+            return;
+        }
+
+        // Load the PDF document first – FormEditor expects a Document instance, not a file path.
+        using (Document pdfDocument = new Document(inputPdf))
+        using (FormEditor formEditor = new FormEditor(pdfDocument))
+        {
+            // JavaScript that validates the field value against a simple e‑mail regex.
+            // If the value does not match, an alert is shown and the validation fails (event.rc = false).
+            string emailValidationScript = @"
+if (!/^[\w\.\-]+@([\w\-]+\.)+[\w\-]{2,4}$/.test(event.value)) {
+    app.alert('Invalid email address.');
+    event.rc = false;
+}";
+            // Attach the script to the "Email" field. This script runs on the field's Validate event.
+            formEditor.SetFieldScript("Email", emailValidationScript);
+
+            // Save the modified PDF
+            formEditor.Save(outputPdf);
+        }
+
+        Console.WriteLine($"Email field validation added. Saved to '{outputPdf}'.");
+    }
+}

facades-forms/add-gender-radio-button-group-to-pdf-form.cs

@@ -0,0 +1,46 @@
+using System;
+using Aspose.Pdf;
+using Aspose.Pdf.Facades;
+
+class Program
+{
+    static void Main()
+    {
+        // Paths for the source PDF (must exist) and the resulting PDF
+        const string inputPdf  = "input.pdf";
+        const string outputPdf = "output.pdf";
+
+        // Ensure the source file exists
+        if (!System.IO.File.Exists(inputPdf))
+        {
+            Console.Error.WriteLine($"Source PDF not found: {inputPdf}");
+            return;
+        }
+
+        // FormEditor loads the source PDF and prepares the output file
+        using (FormEditor formEditor = new FormEditor(inputPdf, outputPdf))
+        {
+            // Define the radio button options
+            formEditor.Items = new string[] { "Male", "Female", "Other" };
+
+            // Arrange the radios horizontally (default is true, set explicitly for clarity)
+            formEditor.RadioHoriz = true;
+
+            // Optional: set the gap between radio buttons (pixels)
+            formEditor.RadioGap = 10;
+
+            // Add the radio button group:
+            // - FieldType.Radio indicates a radio button group
+            // - "Gender" is the field name
+            // - "Male" is the default selected option
+            // - Page number is 1 (Aspose.Pdf uses 1‑based indexing)
+            // - llx, lly, urx, ury define the rectangle that contains the group
+            formEditor.AddField(FieldType.Radio, "Gender", "Male", 1, 100, 700, 200, 720);
+
+            // Persist the changes to the output PDF
+            formEditor.Save();
+        }
+
+        Console.WriteLine($"Radio button group 'Gender' added and saved to '{outputPdf}'.");
+    }
+}

facades-forms/add-hidden-authtoken-field-to-pdf.cs

@@ -0,0 +1,63 @@
+using System;
+using System.IO;
+using System.Security.Cryptography;
+using Aspose.Pdf;
+using Aspose.Pdf.Facades;
+using Aspose.Pdf.Forms;
+
+class Program
+{
+    static void Main()
+    {
+        const string inputPath = "input.pdf";
+        const string outputPath = "output_with_token.pdf";
+
+        if (!File.Exists(inputPath))
+        {
+            Console.Error.WriteLine($"Input file not found: {inputPath}");
+            return;
+        }
+
+        // Generate a secure random token (32 bytes, Base64 encoded)
+        string authToken;
+        using (RandomNumberGenerator rng = RandomNumberGenerator.Create())
+        {
+            byte[] tokenBytes = new byte[32];
+            rng.GetBytes(tokenBytes);
+            authToken = Convert.ToBase64String(tokenBytes);
+        }
+
+        // Load the PDF using the Facades Form class (fully qualified to avoid ambiguity)
+        using (Aspose.Pdf.Facades.Form pdfForm = new Aspose.Pdf.Facades.Form())
+        {
+            pdfForm.BindPdf(inputPath);               // Initialize the facade with the source PDF
+            Document doc = pdfForm.Document;          // Access the underlying Document object
+
+            // Ensure the document has at least one page
+            if (doc.Pages.Count == 0)
+            {
+                Console.Error.WriteLine("The PDF has no pages.");
+                return;
+            }
+
+            // Create a hidden text field named "AuthToken" on the first page
+            Page firstPage = doc.Pages[1]; // 1‑based indexing
+            // Rectangle with zero size; field will not be visible
+            Aspose.Pdf.Rectangle rect = new Aspose.Pdf.Rectangle(0, 0, 0, 0);
+            TextBoxField hiddenField = new TextBoxField(firstPage, rect)
+            {
+                PartialName = "AuthToken",
+                Value = authToken
+                // No need to set Flags; zero‑size rectangle makes the field invisible
+            };
+
+            // Add the field to the document's form
+            doc.Form.Add(hiddenField);
+
+            // Save the modified PDF via the Form facade
+            pdfForm.Save(outputPath);
+        }
+
+        Console.WriteLine($"Hidden field \"AuthToken\" added and saved to '{outputPath}'.");
+    }
+}

facades-forms/add-hidden-numeric-version-field.cs

@@ -0,0 +1,35 @@
+using System;
+using System.IO;
+using Aspose.Pdf.Facades;
+
+class Program
+{
+    static void Main()
+    {
+        const string inputPath  = "input.pdf";
+        const string outputPath = "output.pdf";
+
+        if (!File.Exists(inputPath))
+        {
+            Console.Error.WriteLine($"Input file not found: {inputPath}");
+            return;
+        }
+
+        // Initialize FormEditor and bind the existing PDF
+        using (FormEditor formEditor = new FormEditor())
+        {
+            formEditor.BindPdf(inputPath);
+
+            // Add a hidden numeric field named "Version" with initial value "2"
+            // Placed at a zero‑size rectangle on page 1 (effectively invisible)
+            formEditor.AddField(FieldType.Numeric, "Version", "2", 1, 0, 0, 0, 0);
+
+            // No need to set a hidden flag – the zero‑size rectangle makes the field invisible.
+
+            // Save the modified PDF
+            formEditor.Save(outputPath);
+        }
+
+        Console.WriteLine($"Hidden field added and saved to '{outputPath}'.");
+    }
+}

facades-forms/add-hidden-sessionid-field-with-guid-to-pdfs.cs

@@ -0,0 +1,64 @@
+using System;
+using System.IO;
+using Aspose.Pdf;
+using Aspose.Pdf.Facades;
+using Aspose.Pdf.Annotations;
+
+class BatchAddHiddenSessionId
+{
+    static void Main()
+    {
+        // Base directory of the running application (works on Windows, Linux, macOS)
+        string baseDir = AppDomain.CurrentDomain.BaseDirectory;
+
+        // Resolve input and output folders relative to the base directory
+        string inputFolder = Path.Combine(baseDir, "InputPdfs");
+        string outputFolder = Path.Combine(baseDir, "OutputPdfs");
+
+        // Ensure the folders exist (creates them if they are missing)
+        Directory.CreateDirectory(inputFolder);
+        Directory.CreateDirectory(outputFolder);
+
+        // Process each PDF file in the input folder
+        foreach (string inputPath in Directory.GetFiles(inputFolder, "*.pdf"))
+        {
+            string fileName = Path.GetFileName(inputPath);
+            string outputPath = Path.Combine(outputFolder, fileName);
+
+            // Load the PDF document
+            using (Document doc = new Document(inputPath))
+            {
+                // -----------------------------------------------------------------
+                // 1. Add a hidden text field named "SessionId" on the first page.
+                //    The field rectangle is set to zero size (0,0,0,0) to keep it
+                //    invisible, and the AnnotationFlags.Hidden flag is applied.
+                // -----------------------------------------------------------------
+                using (FormEditor editor = new FormEditor(doc))
+                {
+                    // Add a text field with zero‑size rectangle on page 1
+                    editor.AddField(FieldType.Text, "SessionId", 1, 0, 0, 0, 0);
+
+                    // Mark the field as hidden
+                    editor.SetFieldAppearance("SessionId", AnnotationFlags.Hidden);
+                }
+
+                // -----------------------------------------------------------------
+                // 2. Fill the newly created field with a generated GUID value.
+                // -----------------------------------------------------------------
+                using (Form form = new Form(doc))
+                {
+                    string guidValue = Guid.NewGuid().ToString();
+                    form.FillField("SessionId", guidValue);
+                }
+
+                // -----------------------------------------------------------------
+                // 3. Save the modified document to the output folder.
+                // -----------------------------------------------------------------
+                doc.Save(outputPath);
+                Console.WriteLine($"Processed: {fileName}");
+            }
+        }
+
+        Console.WriteLine("Batch processing completed.");
+    }
+}