Add 163 example(s) for working-with-annotations

Author: agent-aspose-pdf-examples

working-with-annotations/add-js-button-export-annotations-json.cs

@@ -0,0 +1,58 @@
+using System;
+using System.IO;
+using Aspose.Pdf;
+using Aspose.Pdf.Forms;
+using Aspose.Pdf.Annotations;
+using Aspose.Pdf.Drawing;
+
+class Program
+{
+    static void Main()
+    {
+        const string inputPath = "input.pdf";
+        const string outputPath = "output_with_button.pdf";
+
+        if (!File.Exists(inputPath))
+        {
+            Console.Error.WriteLine($"File not found: {inputPath}");
+            return;
+        }
+
+        // Load the existing PDF document
+        using (Document doc = new Document(inputPath))
+        {
+            // Define the button rectangle (lower‑left‑x, lower‑left‑y, upper‑right‑x, upper‑right‑y)
+            Aspose.Pdf.Rectangle buttonRect = new Aspose.Pdf.Rectangle(100, 500, 200, 550);
+
+            // Create a push button field on the first page
+            ButtonField button = new ButtonField(doc.Pages[1], buttonRect)
+            {
+                Name = "ExportAnnotationsBtn",
+                PartialName = "ExportAnnotationsBtn",
+                NormalCaption = "Export JSON"
+            };
+
+            // JavaScript that gathers all annotations, converts them to JSON, and shows the result
+            string jsCode = @"
+var ann = this.getAnnots();
+if (ann != null) {
+    var json = JSON.stringify(ann);
+    app.alert(json);
+} else {
+    app.alert('No annotations found.');
+}";
+            JavascriptAction jsAction = new JavascriptAction(jsCode);
+
+            // Assign the JavaScript to the button's mouse‑press action
+            button.Actions.OnPressMouseBtn = jsAction;
+
+            // Add the button to the document's form fields collection
+            doc.Form.Add(button);
+
+            // Save the modified PDF
+            doc.Save(outputPath);
+        }
+
+        Console.WriteLine($"PDF saved with button annotation: {outputPath}");
+    }
+}

working-with-annotations/add-js-calculation-button-to-pdf-form.cs

@@ -0,0 +1,46 @@
+using System;
+using System.IO;
+using Aspose.Pdf;
+using Aspose.Pdf.Annotations;
+
+class Program
+{
+    static void Main()
+    {
+        const string outputPath = "output.pdf";
+        const string videoPath  = "sample.mp4";
+
+        // Verify that the video file exists before creating the annotation
+        if (!File.Exists(videoPath))
+        {
+            Console.Error.WriteLine($"Video file not found: {videoPath}");
+            return;
+        }
+
+        // Document lifecycle must be wrapped in a using block for deterministic disposal
+        using (Document doc = new Document())
+        {
+            // Add a blank page (pages are 1‑based)
+            Page page = doc.Pages.Add();
+
+            // Define the rectangle where the screen annotation will appear
+            // Rectangle(left, bottom, right, top) – fully qualified to avoid ambiguity
+            Aspose.Pdf.Rectangle rect = new Aspose.Pdf.Rectangle(100, 500, 400, 800);
+
+            // Create the ScreenAnnotation with the video file path
+            ScreenAnnotation screen = new ScreenAnnotation(page, rect, videoPath);
+
+            // Optional: set a title and contents for the annotation
+            screen.Title    = "Embedded Video";
+            screen.Contents = "Video plays in loop with controls disabled";
+
+            // Add the annotation to the page's annotation collection
+            page.Annotations.Add(screen);
+
+            // Save the PDF document
+            doc.Save(outputPath);
+        }
+
+        Console.WriteLine($"PDF with ScreenAnnotation saved to '{outputPath}'.");
+    }
+}

working-with-annotations/add-looping-video-screen-annotation.cs

@@ -0,0 +1,56 @@
+using System;
+using System.IO;
+using Aspose.Pdf;
+using Aspose.Pdf.Annotations;
+using Aspose.Pdf.Text;
+
+class Program
+{
+    static void Main()
+    {
+        const string inputPath  = "input.pdf";
+        const string outputPath = "output.pdf";
+
+        if (!File.Exists(inputPath))
+        {
+            Console.Error.WriteLine($"File not found: {inputPath}");
+            return;
+        }
+
+        // Load the PDF document (lifecycle rule: use using for disposal)
+        using (Document doc = new Document(inputPath))
+        {
+            // Choose the page where the annotation will be placed
+            Page page = doc.Pages[1];
+
+            // Define the rectangle for the free‑text annotation
+            // Fully qualified to avoid ambiguity with System.Drawing.Rectangle
+            Aspose.Pdf.Rectangle rect = new Aspose.Pdf.Rectangle(100, 500, 300, 600);
+
+            // Create a DefaultAppearance for the annotation (font, size, color)
+            // Note: DefaultAppearance constructor requires System.Drawing.Color for the third argument
+            DefaultAppearance appearance = new DefaultAppearance("Helvetica", 12, System.Drawing.Color.Black);
+
+            // Create the free‑text annotation on the selected page
+            FreeTextAnnotation freeText = new FreeTextAnnotation(page, rect, appearance)
+            {
+                // Set a background color for better visibility (optional)
+                Color = Aspose.Pdf.Color.LightGray,
+
+                // Multiline content – use newline characters for plain text
+                Contents = "First line of text\nSecond line of text\nThird line of text",
+
+                // Use RichText with CSS line-height to control line spacing (1.5 = 150%)
+                RichText = "<body style='line-height:1.5'>First line of text<br/>Second line of text<br/>Third line of text</body>"
+            };
+
+            // Add the annotation to the page
+            page.Annotations.Add(freeText);
+
+            // Save the modified PDF (lifecycle rule: save inside the using block)
+            doc.Save(outputPath);
+        }
+
+        Console.WriteLine($"Free‑text annotation added and saved to '{outputPath}'.");
+    }
+}

working-with-annotations/add-multiline-freetext-annotation.cs

@@ -0,0 +1,60 @@
+using System;
+using System.IO;
+using Aspose.Pdf;
+using Aspose.Pdf.Annotations;
+using Aspose.Pdf.Forms;
+
+class Program
+{
+    static void Main()
+    {
+        const string inputPath  = "input.pdf";
+        const string outputPath = "output_with_toggle_button.pdf";
+
+        if (!File.Exists(inputPath))
+        {
+            Console.Error.WriteLine($"File not found: {inputPath}");
+            return;
+        }
+
+        // Load the PDF document inside a using block for proper disposal
+        using (Document doc = new Document(inputPath))
+        {
+            // Get the first page (1‑based indexing)
+            Page page = doc.Pages[1];
+
+            // Define the button rectangle (llx, lly, urx, ury)
+            Aspose.Pdf.Rectangle btnRect = new Aspose.Pdf.Rectangle(100, 700, 200, 750);
+
+            // Create a push button field on the page
+            ButtonField toggleButton = new ButtonField(page, btnRect)
+            {
+                Name = "ToggleAnnotationsButton",
+                NormalCaption = "Toggle Annotations",
+                Color = Aspose.Pdf.Color.LightGray,
+                Highlighting = HighlightingMode.Push
+            };
+
+            // JavaScript that toggles the hidden flag of every annotation on the current page
+            string jsCode = @"
+var annots = this.getAnnots();
+if (annots != null) {
+    for (var i = 0; i < annots.length; i++) {
+        annots[i].hidden = !annots[i].hidden;
+    }
+}
+";
+
+            // Assign the JavaScript to the button's mouse‑press action
+            toggleButton.Actions.OnPressMouseBtn = new JavascriptAction(jsCode);
+
+            // Add the button to the page's annotation collection
+            page.Annotations.Add(toggleButton);
+
+            // Save the modified document
+            doc.Save(outputPath);
+        }
+
+        Console.WriteLine($"PDF saved with toggle button: '{outputPath}'");
+    }
+}