Added options 'landscape' and 'format' (#81)

* Added landscape option * Added PaperFormat format option
by-pinja · Dec 2, 2024 · 0087ca6 · 0087ca6
1 parent a7a3b37
commit 0087ca6
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 2 deletions.
diff --git a/ApiDescription.md b/ApiDescription.md
@@ -42,9 +42,11 @@ Pdf can contain following options
 
 ```json
 {
+  "format": "A4",
   "footerTemplate": "<div style=\"color: black; font-size: 12px; width: 100%; margin-left: 28px;\"><span class=\"pageNumber\"></span>/<span class=\"totalPages\"></span></div>",
   "headerTemplate": "<div style=\"color: black; font-size: 12px; width: 100%; margin-left: 28px;\">Some header</div>",
   "printBackground": true,
+  "landscape": false,
   "preferCSSPageSize": false,
   "pageRanges": null,
   "marginTop": "120px",
@@ -56,6 +58,6 @@ Pdf can contain following options
   "scale": null
 }
 ```
-Values in width AND height (in inches) creates a custom sized paper. If omitted the default A4 paper size will be used.
+Format takes priority over width and height values. Values in width AND height (in inches) creates a custom sized paper. If format and size params are omitted the default A4 paper size will be used.
 
 For further information, see [https://www.puppeteersharp.com/api/PuppeteerSharp.PdfOptions.html](https://www.puppeteersharp.com/api/PuppeteerSharp.PdfOptions.html).
diff --git a/Pdf/PdfQueue.cs b/Pdf/PdfQueue.cs
@@ -99,11 +99,12 @@ await page.SetContentAsync(html,
 
                 return await page.PdfDataAsync(new PdfOptions
                 {
-                    Format = defaultPdfOptions.Format,
+                    Format = options.ContainsKey("format") ? Format(options["format"].Value<string>()) : defaultPdfOptions.Format,
                     DisplayHeaderFooter = options.ContainsKey("footerTemplate") || options.ContainsKey("headerTemplate"),
                     FooterTemplate = options.ContainsKey("footerTemplate") ? options["footerTemplate"].Value<string>() : defaultPdfOptions.FooterTemplate,
                     HeaderTemplate = options.ContainsKey("headerTemplate") ? options["headerTemplate"].Value<string>() : defaultPdfOptions.HeaderTemplate,
                     PrintBackground = options.ContainsKey("printBackground") ? options["printBackground"].Value<bool>() : defaultPdfOptions.PrintBackground,
+                    Landscape = options.ContainsKey("landscape") ? options["landscape"].Value<bool>() : defaultPdfOptions.Landscape,
                     PreferCSSPageSize = options.ContainsKey("preferCSSPageSize") ? options["preferCSSPageSize"].Value<bool>() : defaultPdfOptions.PreferCSSPageSize,
                     PageRanges = options.ContainsKey("pageRanges") ? options["pageRanges"].Value<string>() : defaultPdfOptions.PageRanges,
                     Scale = options.ContainsKey("scale") ? options["scale"].Value<decimal>() : defaultPdfOptions.Scale,
@@ -129,5 +130,20 @@ await page.SetContentAsync(html,
                 browser?.Dispose();
             }
         }
+
+        private static PaperFormat Format(string format) => format switch {
+            "Letter" => PaperFormat.Letter,
+            "Legal" => PaperFormat.Legal,
+            "Tabloid" => PaperFormat.Tabloid,
+            "Ledger" => PaperFormat.Ledger,
+            "A0" => PaperFormat.A0,
+            "A1" => PaperFormat.A1,
+            "A2" => PaperFormat.A2,
+            "A3" => PaperFormat.A3,
+            "A4" => PaperFormat.A4,
+            "A5" => PaperFormat.A5,
+            "A6" => PaperFormat.A6,
+            _ => PaperFormat.A4,
+        };
     }
 }