Merge pull request #208 from aspose-pdf/examples/9f94b342-graphs-zugferd-operators

Add 84 ZUGFeRD operator examples to Graphs API

Author: fahadadeel

graphs-zugferd-operators/add-auto-close-javascript-to-pdf.cs

@@ -0,0 +1,36 @@
+using System;
+using System.IO;
+using Aspose.Pdf;
+using Aspose.Pdf.Annotations; // optional, kept for consistency
+
+class Program
+{
+    static void Main()
+    {
+        const string inputPath = "input.pdf";
+        const string outputPath = "output.pdf";
+        const int timeoutMs = 5000; // close after 5 seconds
+
+        if (!File.Exists(inputPath))
+        {
+            Console.Error.WriteLine($"File not found: {inputPath}");
+            return;
+        }
+
+        // Load the PDF inside a using block for proper disposal
+        using (Document doc = new Document(inputPath))
+        {
+            // JavaScript that sets a timeout to close the document
+            string js = $"app.setTimeOut('this.closeDoc();', {timeoutMs});";
+
+            // Attach the script to the document's open action (correct property)
+            doc.OpenAction = new JavascriptAction(js);
+            // Alternatively you could use: doc.Actions.OnOpen = new JavascriptAction(js);
+
+            // Save the modified PDF
+            doc.Save(outputPath);
+        }
+
+        Console.WriteLine($"PDF saved with auto‑close script to '{outputPath}'.");
+    }
+}

graphs-zugferd-operators/add-auto-print-javascript-action-to-pdf.cs

@@ -0,0 +1,32 @@
+using System;
+using System.IO;
+using Aspose.Pdf;
+using Aspose.Pdf.Annotations;
+
+class Program
+{
+    static void Main()
+    {
+        const string inputPath  = "input.pdf";
+        const string outputPath = "output_with_print_action.pdf";
+
+        if (!File.Exists(inputPath))
+        {
+            Console.Error.WriteLine($"File not found: {inputPath}");
+            return;
+        }
+
+        // Load the existing PDF document
+        using (Document doc = new Document(inputPath))
+        {
+            // Add a JavaScript action that opens the print dialog when the document is opened
+            // The script "this.print(true);" triggers the print dialog immediately.
+            doc.OpenAction = new JavascriptAction("this.print(true);");
+
+            // Save the modified PDF
+            doc.Save(outputPath);
+        }
+
+        Console.WriteLine($"PDF saved with auto‑print action: {outputPath}");
+    }
+}

graphs-zugferd-operators/add-auto-save-javascript-to-pdf.cs

@@ -0,0 +1,39 @@
+global using System;
+global using System.IO;
+global using Aspose.Pdf;
+global using Aspose.Pdf.Annotations;
+
+// Program.cs
+using Aspose.Pdf.Annotations; // needed for JavascriptAction (kept for clarity)
+
+class Program
+{
+    static void Main()
+    {
+        const string inputPath = "input.pdf";
+        const string outputPath = "output_with_js.pdf";
+
+        // Verify source file exists
+        if (!File.Exists(inputPath))
+        {
+            Console.Error.WriteLine($"File not found: {inputPath}");
+            return;
+        }
+
+        // Load the PDF inside a using block (ensures proper disposal)
+        using (Document doc = new Document(inputPath))
+        {
+            // JavaScript that triggers an automatic save every 60 000 ms (1 minute)
+            // The script uses app.setTimeOut to schedule a saveAs operation.
+            string js = $"app.setTimeOut('this.saveAs({{cPath:\"{outputPath}\"}});', 60000);";
+
+            // Assign the script to the document‑level OpenAction (executed when the PDF is opened)
+            doc.OpenAction = new JavascriptAction(js);
+
+            // Save the modified PDF (no extra SaveOptions needed for PDF output)
+            doc.Save(outputPath);
+        }
+
+        Console.WriteLine($"PDF saved with auto‑save JavaScript to '{outputPath}'.");
+    }
+}

graphs-zugferd-operators/add-custom-metadata-to-zugferd-pdf.cs

@@ -0,0 +1,33 @@
+using System;
+using System.IO;
+using Aspose.Pdf;
+
+class Program
+{
+    static void Main()
+    {
+        const string inputPath  = "input_zugferd.pdf";
+        const string outputPath = "output_zugferd_with_metadata.pdf";
+
+        if (!File.Exists(inputPath))
+        {
+            Console.Error.WriteLine($"File not found: {inputPath}");
+            return;
+        }
+
+        // Load the existing ZUGFeRD PDF, modify metadata, and save.
+        using (Document doc = new Document(inputPath))
+        {
+            // Add custom metadata entries.
+            // The Metadata property implements IDictionary<string, XmpValue> and
+            // provides an Add(string, object) overload for simple values.
+            doc.Metadata.Add("ProjectCode", "PRJ-2023-001");
+            doc.Metadata.Add("Department", "Finance");
+
+            // Save the updated PDF.
+            doc.Save(outputPath);
+        }
+
+        Console.WriteLine($"PDF saved with custom metadata to '{outputPath}'.");
+    }
+}

graphs-zugferd-operators/add-document-expiry-javascript-action.cs

@@ -0,0 +1,39 @@
+using System;
+using System.IO;
+using Aspose.Pdf;
+using Aspose.Pdf.Annotations;
+
+class Program
+{
+    static void Main()
+    {
+        const string inputPath = "input.pdf";
+        const string outputPath = "output_expiry.pdf";
+
+        if (!File.Exists(inputPath))
+        {
+            Console.Error.WriteLine($"File not found: {inputPath}");
+            return;
+        }
+
+        // JavaScript that checks the current date against an expiry date.
+        string js = @"
+Date today = new Date();
+Date expiry = new Date('2025-12-31T23:59:59');
+if (today > expiry) {
+    app.alert('This document has expired.');
+    this.closeDoc();
+}
+";
+
+        using (Document doc = new Document(inputPath))
+        {
+            // Assign the JavaScript to run when the document is opened.
+            doc.OpenAction = new JavascriptAction(js);
+
+            doc.Save(outputPath);
+        }
+
+        Console.WriteLine($"PDF with expiry action saved to '{outputPath}'.");
+    }
+}

graphs-zugferd-operators/add-encrypted-attachment-to-pdf.cs

@@ -0,0 +1,65 @@
+using System;
+using System.IO;
+using Aspose.Pdf;
+
+class Program
+{
+    static void Main()
+    {
+        // Input PDF to which the attachment will be added
+        const string inputPdfPath = "input.pdf";
+        // File that will be attached (its content will be encrypted together with the PDF)
+        const string attachmentFilePath = "secret.txt";
+        // Output encrypted PDF
+        const string outputPdfPath = "output_encrypted.pdf";
+
+        // Passwords for PDF encryption
+        const string userPassword = "user123";   // password required to open the PDF
+        const string ownerPassword = "owner123"; // password with full permissions
+
+        // Verify that required files exist
+        if (!File.Exists(inputPdfPath))
+        {
+            Console.Error.WriteLine($"Input PDF not found: {inputPdfPath}");
+            return;
+        }
+        if (!File.Exists(attachmentFilePath))
+        {
+            Console.Error.WriteLine($"Attachment file not found: {attachmentFilePath}");
+            return;
+        }
+
+        // Load the existing PDF (lifecycle: load)
+        using (Document pdfDoc = new Document(inputPdfPath))
+        {
+            // ------------------------------------------------------------
+            // 1. Embed the file as an embedded file (portfolio entry).
+            // ------------------------------------------------------------
+            // Create a FileSpecification with a display name.
+            FileSpecification fileSpec = new FileSpecification(Path.GetFileName(attachmentFilePath));
+            // Set the file contents – this stream will be encrypted together with the PDF.
+            fileSpec.Contents = new MemoryStream(File.ReadAllBytes(attachmentFilePath));
+            // Optionally set a description.
+            fileSpec.Description = "Encrypted attachment";
+            // Add the specification to the document's EmbeddedFiles collection.
+            pdfDoc.EmbeddedFiles.Add(fileSpec);
+
+            // ------------------------------------------------------------
+            // 2. Define permissions for the encrypted PDF.
+            // ------------------------------------------------------------
+            Permissions permissions = Permissions.PrintDocument | Permissions.ModifyContent;
+
+            // ------------------------------------------------------------
+            // 3. Encrypt the whole document (including the embedded file).
+            // ------------------------------------------------------------
+            pdfDoc.Encrypt(userPassword, ownerPassword, permissions, CryptoAlgorithm.AESx256);
+
+            // ------------------------------------------------------------
+            // 4. Save the encrypted PDF.
+            // ------------------------------------------------------------
+            pdfDoc.Save(outputPdfPath);
+        }
+
+        Console.WriteLine($"Encrypted PDF with attachment saved to '{outputPdfPath}'.");
+    }
+}

graphs-zugferd-operators/add-file-attachment-annotation-to-pdf.cs

@@ -0,0 +1,56 @@
+using System;
+using System.IO;
+using Aspose.Pdf;
+using Aspose.Pdf.Annotations;
+
+class Program
+{
+    static void Main()
+    {
+        const string inputPdf   = "input.pdf";          // source PDF
+        const string outputPdf  = "output.pdf";         // PDF with attachment
+        const string attachFile = "document.pdf";       // file to attach
+
+        if (!File.Exists(inputPdf))
+        {
+            Console.Error.WriteLine($"Input PDF not found: {inputPdf}");
+            return;
+        }
+
+        if (!File.Exists(attachFile))
+        {
+            Console.Error.WriteLine($"Attachment file not found: {attachFile}");
+            return;
+        }
+
+        // Load the PDF document
+        using (Document doc = new Document(inputPdf))
+        {
+            // Choose the page where the annotation will be placed (first page)
+            Page page = doc.Pages[1];
+
+            // Define the rectangle that bounds the annotation icon (Aspose.Pdf.Rectangle, not System.Drawing.Rectangle)
+            Aspose.Pdf.Rectangle rect = new Aspose.Pdf.Rectangle(100, 500, 200, 600);
+
+            // Create a FileSpecification describing the attached file (description is optional)
+            FileSpecification fileSpec = new FileSpecification(attachFile, "Attached PDF document");
+            // NOTE: Aspose.Pdf.FileSpecification does not expose a MimeType property. The MIME type is inferred from the file extension.
+
+            // Create the file attachment annotation
+            FileAttachmentAnnotation fileAnnot = new FileAttachmentAnnotation(page, rect, fileSpec)
+            {
+                Title    = "Attachment",               // title shown in the popup
+                Contents = "Click the icon to open the attached PDF.", // tooltip text
+                Icon     = FileIcon.Paperclip          // use the correct enum for the icon
+            };
+
+            // Add the annotation to the page
+            page.Annotations.Add(fileAnnot);
+
+            // Save the modified PDF
+            doc.Save(outputPdf);
+        }
+
+        Console.WriteLine($"File attachment added and saved to '{outputPdf}'.");
+    }
+}

graphs-zugferd-operators/add-javascript-calculation-to-pdf-form-total.cs

@@ -0,0 +1,60 @@
+using System;
+using System.IO;
+using Aspose.Pdf;
+using Aspose.Pdf.Forms;
+using Aspose.Pdf.Annotations;
+
+class Program
+{
+    static void Main()
+    {
+        const string inputPath = "input_form.pdf";
+        const string outputPath = "output_form.pdf";
+
+        if (!File.Exists(inputPath))
+        {
+            Console.Error.WriteLine($"File not found: {inputPath}");
+            return;
+        }
+
+        // Load the PDF document containing the form fields
+        using (Document doc = new Document(inputPath))
+        {
+            // Access the form object
+            Form form = doc.Form;
+
+            // Ensure the form will recalculate when any field changes
+            form.AutoRecalculate = true;
+
+            // Retrieve the summary field where the total will be displayed
+            // (Assumes a field named "Total" already exists in the PDF)
+            Field totalField = doc.Form["Total"] as Field;
+            if (totalField == null)
+            {
+                Console.Error.WriteLine("Summary field 'Total' not found.");
+                return;
+            }
+
+            // JavaScript that sums the values of line‑item fields and writes the result
+            // Adjust the field names ("Item1", "Item2", "Item3") to match your PDF.
+            string jsCode = @"
+                var sum = 0;
+                var f1 = this.getField('Item1');
+                var f2 = this.getField('Item2');
+                var f3 = this.getField('Item3');
+                if (f1 && f1.value) sum += parseFloat(f1.value);
+                if (f2 && f2.value) sum += parseFloat(f2.value);
+                if (f3 && f3.value) sum += parseFloat(f3.value);
+                this.getField('Total').value = sum.toFixed(2);
+            ";
+
+            // Assign the JavaScript to the OnCalculate action of the summary field
+            totalField.Actions.OnCalculate = new JavascriptAction(jsCode);
+
+            // Save the modified PDF
+            doc.Save(outputPath);
+        }
+
+        Console.WriteLine($"PDF with JavaScript calculation saved to '{outputPath}'.");
+    }
+}