@ironsoftware/ironpdf-engine-windows-x64 2025.4.4 → 2025.5.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.js +1 -1
- package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/IronCefSubprocess.exe +0 -0
- package/ironpdf-engine-bin-2025.5.6/IronInterop.dll +0 -0
- package/ironpdf-engine-bin-2025.5.6/IronPdf.pdb +0 -0
- package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/IronPdf.xml +279 -2202
- package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/IronPdfEngine.Proto.pdb +0 -0
- package/ironpdf-engine-bin-2025.5.6/IronPdfEngine.pdb +0 -0
- package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/IronPdfEngineConsole.exe +0 -0
- package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/IronPdfEngineConsole.pdb +0 -0
- package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/IronPdfInterop.dll +0 -0
- package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/OpenXmlPowerTools.pdb +0 -0
- package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/api-ms-win-crt-convert-l1-1-0.dll +0 -0
- package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/api-ms-win-crt-environment-l1-1-0.dll +0 -0
- package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/api-ms-win-crt-filesystem-l1-1-0.dll +0 -0
- package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/api-ms-win-crt-heap-l1-1-0.dll +0 -0
- package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/api-ms-win-crt-locale-l1-1-0.dll +0 -0
- package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/api-ms-win-crt-math-l1-1-0.dll +0 -0
- package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/api-ms-win-crt-runtime-l1-1-0.dll +0 -0
- package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/api-ms-win-crt-stdio-l1-1-0.dll +0 -0
- package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/api-ms-win-crt-string-l1-1-0.dll +0 -0
- package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/api-ms-win-crt-time-l1-1-0.dll +0 -0
- package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/api-ms-win-crt-utility-l1-1-0.dll +0 -0
- package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/chrome_elf.dll +0 -0
- package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/concrt140.dll +0 -0
- package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/d3dcompiler_47.dll +0 -0
- package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/dxva2.dll +0 -0
- package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/libEGL.dll +0 -0
- package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/libGLESv2.dll +0 -0
- package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/libcef.dll +0 -0
- package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/libyara.dll +0 -0
- package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/msvcp140.dll +0 -0
- package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/msvcp140_1.dll +0 -0
- package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/msvcp140_2.dll +0 -0
- package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/msvcp140_atomic_wait.dll +0 -0
- package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/msvcp140_codecvt_ids.dll +0 -0
- package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/ucrtbase.dll +0 -0
- package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/vcruntime140.dll +0 -0
- package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/vcruntime140_1.dll +0 -0
- package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/vk_swiftshader.dll +0 -0
- package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/vulkan-1.dll +0 -0
- package/package.json +2 -2
- package/ironpdf-engine-bin-2025.4.4/IronInterop.dll +0 -0
- package/ironpdf-engine-bin-2025.4.4/IronPdf.pdb +0 -0
- package/ironpdf-engine-bin-2025.4.4/IronPdfEngine.pdb +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/Chrome.Native.deployment.json +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/MonoPosixHelper.dll +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/Pdfium.Native.deployment.json +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/chrome_100_percent.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/chrome_200_percent.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/grpc_csharp_ext.x64.dll +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/icudtl.dat +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/libMonoPosixHelper.dll +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/af.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/am.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/ar.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/bg.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/bn.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/ca.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/cs.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/da.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/de.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/el.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/en-GB.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/en-US.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/es-419.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/es.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/et.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/fa.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/fi.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/fil.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/fr.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/gu.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/he.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/hi.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/hr.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/hu.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/id.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/it.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/ja.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/kn.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/ko.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/lt.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/lv.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/ml.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/mr.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/ms.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/nb.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/nl.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/pl.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/pt-BR.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/pt-PT.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/ro.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/ru.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/sk.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/sl.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/sr.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/sv.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/sw.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/ta.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/te.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/th.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/tr.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/uk.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/ur.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/vi.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/zh-CN.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/locales/zh-TW.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/resources.pak +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/snapshot_blob.bin +0 -0
- /package/{ironpdf-engine-bin-2025.4.4 → ironpdf-engine-bin-2025.5.6}/v8_context_snapshot.bin +0 -0
|
@@ -494,86 +494,6 @@
|
|
|
494
494
|
Create a new chrome client accessor
|
|
495
495
|
</summary>
|
|
496
496
|
</member>
|
|
497
|
-
<member name="T:IronPdf.ChromeHttpLoginCredentials">
|
|
498
|
-
<summary>
|
|
499
|
-
Provides credentials for IronPdf's embedded Chrome browser to log-in to an intranet, extranet or website, impersonating a user. This
|
|
500
|
-
allows a unique ability to render web-pages as PDFs even on secure intranets, extranets and websites.
|
|
501
|
-
</summary>
|
|
502
|
-
</member>
|
|
503
|
-
<member name="M:IronPdf.ChromeHttpLoginCredentials.Finalize">
|
|
504
|
-
<summary>
|
|
505
|
-
Destructor cleans up all temporary cookies files for the HttpLoginCredentials instance.
|
|
506
|
-
</summary>
|
|
507
|
-
</member>
|
|
508
|
-
<member name="F:IronPdf.ChromeHttpLoginCredentials.CustomCookies">
|
|
509
|
-
<summary>
|
|
510
|
-
OBSOLETE! Use <see cref="F:IronPdf.ChromePdfRenderOptions.CustomCookies"/> instead"
|
|
511
|
-
RenderUriToHml methods.
|
|
512
|
-
</summary>
|
|
513
|
-
</member>
|
|
514
|
-
<member name="P:IronPdf.ChromeHttpLoginCredentials.NetworkPassword">
|
|
515
|
-
<summary>
|
|
516
|
-
Optional: Password credential for Windows / Linux network security authentication.
|
|
517
|
-
</summary>
|
|
518
|
-
</member>
|
|
519
|
-
<member name="P:IronPdf.ChromeHttpLoginCredentials.NetworkUsername">
|
|
520
|
-
<summary>
|
|
521
|
-
Optional: User-name credential for Windows / Linux network security authentication.
|
|
522
|
-
</summary>
|
|
523
|
-
</member>
|
|
524
|
-
<member name="F:IronPdf.ChromeHttpLoginCredentials.CustomHttpHeaders">
|
|
525
|
-
<summary>
|
|
526
|
-
A dictionary of custom HTTP headers to be sent with every HTTP request
|
|
527
|
-
</summary>
|
|
528
|
-
<exclude/>
|
|
529
|
-
</member>
|
|
530
|
-
<member name="F:IronPdf.ChromeHttpLoginCredentials.CustomPostFiles">
|
|
531
|
-
<summary>
|
|
532
|
-
Optional, Advanced Usage: Specifies a collection files to summited on every PDF rendering request. Allows
|
|
533
|
-
images and documents to be submitted to forms such that the output will be rendered as an PDF. <para>Note:
|
|
534
|
-
The Key is the name of the post field, The value is the full file path.. UrlEncoding is not required.</para>
|
|
535
|
-
</summary>
|
|
536
|
-
<exclude/>
|
|
537
|
-
</member>
|
|
538
|
-
<member name="F:IronPdf.ChromeHttpLoginCredentials.CustomPostVariables">
|
|
539
|
-
<summary>
|
|
540
|
-
Optional: Specifies a collection of HTTP 'POST' variables to submit on every PDF rendering request.
|
|
541
|
-
<para>Note: The 'key' is the name of the post field, The 'value' is its value. UrlEncoding is not
|
|
542
|
-
required.</para>
|
|
543
|
-
</summary>
|
|
544
|
-
<exclude/>
|
|
545
|
-
</member>
|
|
546
|
-
<member name="F:IronPdf.ChromeHttpLoginCredentials.EnableCookies">
|
|
547
|
-
<summary>
|
|
548
|
-
Enables cookies to be stored and sent when using RenderUriToHtml methods.
|
|
549
|
-
</summary>
|
|
550
|
-
<exclude/>
|
|
551
|
-
</member>
|
|
552
|
-
<member name="F:IronPdf.ChromeHttpLoginCredentials.LoginFormPostVariables">
|
|
553
|
-
<summary>
|
|
554
|
-
Optional: Specifies a collection of HTTP form variables to post/submit to <see cref="P:IronPdf.ChromeHttpLoginCredentials.LoginFormUrl"/>.
|
|
555
|
-
</summary>
|
|
556
|
-
<exclude/>
|
|
557
|
-
</member>
|
|
558
|
-
<member name="P:IronPdf.ChromeHttpLoginCredentials.LoginFormUrl">
|
|
559
|
-
<summary>
|
|
560
|
-
Optional: Gives the URL to post website login-form authentication. Should be the absolute Url which the
|
|
561
|
-
form's action attribute specifies.
|
|
562
|
-
</summary>
|
|
563
|
-
<exclude/>
|
|
564
|
-
</member>
|
|
565
|
-
<member name="P:IronPdf.ChromeHttpLoginCredentials.Proxy">
|
|
566
|
-
<summary>
|
|
567
|
-
Specifies an Http proxy server. Use the pattern: http(s)://user-name:password@host:port/
|
|
568
|
-
</summary>
|
|
569
|
-
<exclude/>
|
|
570
|
-
</member>
|
|
571
|
-
<member name="P:IronPdf.ChromeHttpLoginCredentials.UserAgent">
|
|
572
|
-
<summary>
|
|
573
|
-
The Http User-Agent header which will be used to fetch any remote HTML.
|
|
574
|
-
</summary>
|
|
575
|
-
<exclude/>
|
|
576
|
-
</member>
|
|
577
497
|
<member name="T:IronPdf.ChromePdfRenderer">
|
|
578
498
|
<summary>
|
|
579
499
|
IronPdf.ChromePdfRenderer allows any web page or Html 'snippet' to be turned into a PDF document using an up-to-date embedded Chrome browser.
|
|
@@ -982,7 +902,7 @@
|
|
|
982
902
|
</member>
|
|
983
903
|
<member name="M:IronPdf.ChromePdfRenderer.RenderHtmlAsPdfUA(System.String,IronPdf.NaturalLanguages)">
|
|
984
904
|
<summary>
|
|
985
|
-
Create a PDF/UA file from an Html string, and returns it as a <see cref="T:IronPdf.PdfDocument"/>.
|
|
905
|
+
Create a PDF/UA (ISO 14289-1) file from an Html string, and returns it as a <see cref="T:IronPdf.PdfDocument"/>.
|
|
986
906
|
<para>IronPDF is a W3C standards compliant HTML rendering based on Google's Chromium browser. If your output PDF does not look as expected:
|
|
987
907
|
<br/> - Validate your HTML using https://validator.w3.org/ & CSS https://jigsaw.w3.org/css-validator/
|
|
988
908
|
<br/> - To debug HTML, Save your HTML string to a file and view in Chrome web browser's print preview which will work almost exactly as IronPDF.
|
|
@@ -996,7 +916,7 @@
|
|
|
996
916
|
</member>
|
|
997
917
|
<member name="M:IronPdf.ChromePdfRenderer.RenderHtmlFileAsPdfUA(System.String,IronPdf.NaturalLanguages)">
|
|
998
918
|
<summary>
|
|
999
|
-
Creates a PDF/UA file from a local Html file, and returns it as a <see cref="T:IronPdf.PdfDocument"/>.
|
|
919
|
+
Creates a PDF/UA (ISO 14289-1) file from a local Html file, and returns it as a <see cref="T:IronPdf.PdfDocument"/>.
|
|
1000
920
|
<para>IronPDF is a W3C standards compliant HTML rendering based on Google's Chromium browser. If your output PDF does not look as expected:
|
|
1001
921
|
<br/> - Validate your HTML file using https://validator.w3.org/ & CSS https://jigsaw.w3.org/css-validator/
|
|
1002
922
|
<br/> - To debug HTML, view the file in Chrome web browser's print preview which will work almost exactly as IronPDF.
|
|
@@ -1008,959 +928,228 @@
|
|
|
1008
928
|
<returns>A <see cref="T:IronPdf.PdfDocument"/></returns>
|
|
1009
929
|
<remarks>Using <see cref="M:IronPdf.PdfDocument.SaveAs(System.String,System.Boolean)"/> for saving the output PDF/UA document.</remarks>
|
|
1010
930
|
</member>
|
|
1011
|
-
<member name="T:IronPdf.
|
|
931
|
+
<member name="T:IronPdf.Cleaner">
|
|
1012
932
|
<summary>
|
|
1013
|
-
|
|
1014
|
-
<para>
|
|
1015
|
-
Important for cookies and user preferences.
|
|
1016
|
-
</para>
|
|
933
|
+
The Cleaner class can be used to scan or sanitize (remove any potentially harmful content) PDF document.
|
|
1017
934
|
</summary>
|
|
1018
|
-
<remarks>Useful for guaranteeing isolation between individual renders</remarks>
|
|
1019
935
|
</member>
|
|
1020
|
-
<member name="
|
|
936
|
+
<member name="M:IronPdf.Cleaner.SanitizeWithSvg(System.String)">
|
|
1021
937
|
<summary>
|
|
1022
|
-
|
|
938
|
+
Sanitize PDF by convert PDF To an SVG image and convert it back to PDF.
|
|
939
|
+
Returns a new <see cref="T:IronPdf.PdfDocument"/> object.
|
|
940
|
+
<list type = "bullet" >
|
|
941
|
+
<item><description>Quicker than <see cref="M:IronPdf.Cleaner.SanitizeWithBitmap(IronPdf.PdfDocument)"/></description></item>
|
|
942
|
+
<item><description>Resulted as a serachable PDF</description></item>
|
|
943
|
+
<item><description>Layout might be inconsistency.</description></item>
|
|
944
|
+
</list>
|
|
1023
945
|
</summary>
|
|
1024
|
-
<
|
|
946
|
+
<param name="pdfFilePath">A PDF File path.</param>
|
|
1025
947
|
</member>
|
|
1026
|
-
<member name="
|
|
948
|
+
<member name="M:IronPdf.Cleaner.SanitizeWithSvg(IronPdf.PdfDocument)">
|
|
1027
949
|
<summary>
|
|
1028
|
-
|
|
950
|
+
Sanitize PDF by convert PDF To an SVG image and convert it back to PDF.
|
|
951
|
+
Returns a new <see cref="T:IronPdf.PdfDocument"/> object.
|
|
952
|
+
<list type = "bullet" >
|
|
953
|
+
<item><description>Quicker than <see cref="M:IronPdf.Cleaner.SanitizeWithBitmap(IronPdf.PdfDocument)"/></description></item>
|
|
954
|
+
<item><description>Resulted as a serachable PDF</description></item>
|
|
955
|
+
<item><description>Layout might be inconsistency.</description></item>
|
|
956
|
+
</list>
|
|
1029
957
|
</summary>
|
|
1030
|
-
<
|
|
958
|
+
<param name="pdfDocument">An <see cref="T:IronPdf.PdfDocument"/> of document.</param>
|
|
1031
959
|
</member>
|
|
1032
|
-
<member name="
|
|
960
|
+
<member name="M:IronPdf.Cleaner.SanitizeWithBitmap(System.String)">
|
|
1033
961
|
<summary>
|
|
1034
|
-
|
|
1035
|
-
<
|
|
1036
|
-
Uses <see cref="F:IronPdf.Rendering.RequestContexts.Global"/> if the user has ever invoked <see cref="T:IronPdf.Engines.Chrome.ChromeInterop.UnmanagedDelegates.ApplyCookies"/>
|
|
1037
|
-
</para>
|
|
962
|
+
Sanitize PDF by convert PDF To an Bitmap image and convert it back to PDF.
|
|
963
|
+
Returns a new <see cref="T:IronPdf.PdfDocument"/> object.
|
|
1038
964
|
</summary>
|
|
965
|
+
<list type = "bullet" >
|
|
966
|
+
<item><description>Slower than <see cref="M:IronPdf.Cleaner.SanitizeWithSvg(IronPdf.PdfDocument)"/></description></item>
|
|
967
|
+
<item><description>Visually look the same</description></item>
|
|
968
|
+
<item><description>Resulted as a non-serachable PDF</description></item>
|
|
969
|
+
</list>
|
|
970
|
+
<param name="pdfFilePath">A PDF File path.</param>
|
|
1039
971
|
</member>
|
|
1040
|
-
<member name="
|
|
972
|
+
<member name="M:IronPdf.Cleaner.SanitizeWithBitmap(IronPdf.PdfDocument)">
|
|
1041
973
|
<summary>
|
|
1042
|
-
|
|
1043
|
-
|
|
974
|
+
Sanitize PDF by convert PDF To an Bitmap image and convert it back to PDF.
|
|
975
|
+
Returns a new <see cref="T:IronPdf.PdfDocument"/> object.
|
|
1044
976
|
</summary>
|
|
977
|
+
<list type = "bullet" >
|
|
978
|
+
<item><description>Slower than <see cref="M:IronPdf.Cleaner.SanitizeWithSvg(IronPdf.PdfDocument)"/></description></item>
|
|
979
|
+
<item><description>Visually look the same</description></item>
|
|
980
|
+
<item><description>Resulted as a non-serachable PDF</description></item>
|
|
981
|
+
</list>
|
|
982
|
+
<param name="pdfDocument">An <see cref="T:IronPdf.PdfDocument"/> of document.</param>
|
|
1045
983
|
</member>
|
|
1046
|
-
<member name="
|
|
984
|
+
<member name="M:IronPdf.Cleaner.SanitizeByRemoveSomeElements(IronPdf.PdfDocument)">
|
|
1047
985
|
<summary>
|
|
1048
|
-
|
|
986
|
+
Sanitize PDF by remove some elements from the original PDF.
|
|
987
|
+
Returns a new <see cref="T:IronPdf.PdfDocument"/> object.
|
|
1049
988
|
</summary>
|
|
989
|
+
<list type = "bullet" >
|
|
990
|
+
<item><description>Some function of original PDF might not working</description></item>
|
|
991
|
+
<item><description>Some content might be missing</description></item>
|
|
992
|
+
</list>
|
|
993
|
+
<param name="pdfDocument">An <see cref="T:IronPdf.PdfDocument"/> of document.</param>
|
|
1050
994
|
</member>
|
|
1051
|
-
<member name="
|
|
995
|
+
<member name="M:IronPdf.Cleaner.SanitizeByRecreatePdf(IronPdf.PdfDocument)">
|
|
1052
996
|
<summary>
|
|
1053
|
-
|
|
997
|
+
Sanitize PDF by re-create PDF document with only text and image from the original PDF.
|
|
998
|
+
Returns a new <see cref="T:IronPdf.PdfDocument"/> object.
|
|
1054
999
|
</summary>
|
|
1000
|
+
<param name="pdfDocument">An <see cref="T:IronPdf.PdfDocument"/> of document.</param>
|
|
1055
1001
|
</member>
|
|
1056
|
-
<member name="
|
|
1057
|
-
|
|
1058
|
-
|
|
1059
|
-
|
|
1060
|
-
|
|
1002
|
+
<member name="M:IronPdf.Cleaner.ScanPdf(System.String,System.String[])">
|
|
1003
|
+
<summary>
|
|
1004
|
+
Scan for any risk that might exists in a PDF.
|
|
1005
|
+
</summary>
|
|
1006
|
+
<param name="pdfFilePath">A PDF File path</param>
|
|
1007
|
+
<param name="yaraFiles">Optional external yara rule files, this will override the default yara rules</param>
|
|
1008
|
+
<returns>scan result as an <see cref="T:IronPdf.CleanerScanResult"/> object</returns>
|
|
1061
1009
|
</member>
|
|
1062
|
-
<member name="
|
|
1063
|
-
|
|
1010
|
+
<member name="M:IronPdf.Cleaner.ScanPdf(System.Byte[],System.String[])">
|
|
1011
|
+
<summary>
|
|
1012
|
+
Scan for any risk that might exists in a PDF.
|
|
1013
|
+
</summary>
|
|
1014
|
+
<param name="pdfBytes">a PDF bytes</param>
|
|
1015
|
+
<param name="yaraFiles">Optional external yara rule files, this will override the default yara rules</param>
|
|
1016
|
+
<returns>scan result as an <see cref="T:IronPdf.CleanerScanResult"/> object</returns>
|
|
1064
1017
|
</member>
|
|
1065
|
-
<member name="
|
|
1066
|
-
|
|
1018
|
+
<member name="M:IronPdf.Cleaner.ScanPdf(IronPdf.PdfDocument,System.String[])">
|
|
1019
|
+
<summary>
|
|
1020
|
+
Scan for any risk that might exists in a PDF.
|
|
1021
|
+
</summary>
|
|
1022
|
+
<param name="pdfDocument">a PdfDocument object</param>
|
|
1023
|
+
<param name="yaraFiles">Optional external yara rule files, this will override the default yara rules</param>
|
|
1024
|
+
<returns>scan result as an <see cref="T:IronPdf.CleanerScanResult"/> object</returns>
|
|
1067
1025
|
</member>
|
|
1068
|
-
<member name="
|
|
1069
|
-
|
|
1026
|
+
<member name="T:IronPdf.CleanerScanResult">
|
|
1027
|
+
<summary>
|
|
1028
|
+
Result from Cleaner scan functions. E.g. <see cref="M:IronPdf.Cleaner.ScanPdf(IronPdf.PdfDocument,System.String[])"/>
|
|
1029
|
+
</summary>
|
|
1070
1030
|
</member>
|
|
1071
|
-
<member name="
|
|
1072
|
-
|
|
1031
|
+
<member name="P:IronPdf.CleanerScanResult.IsDetected">
|
|
1032
|
+
<summary>
|
|
1033
|
+
Is any risk was found
|
|
1034
|
+
</summary>
|
|
1073
1035
|
</member>
|
|
1074
|
-
<member name="
|
|
1075
|
-
|
|
1036
|
+
<member name="P:IronPdf.CleanerScanResult.Risks">
|
|
1037
|
+
<summary>
|
|
1038
|
+
A list of risk that has been detected.
|
|
1039
|
+
</summary>
|
|
1076
1040
|
</member>
|
|
1077
|
-
<member name="
|
|
1078
|
-
|
|
1041
|
+
<member name="M:IronPdf.CleanerScanResult.ToString">
|
|
1042
|
+
<summary>
|
|
1043
|
+
A text summary of CleanerScanResult
|
|
1044
|
+
</summary>
|
|
1045
|
+
<returns>A text summary of CleanerScanResult </returns>
|
|
1079
1046
|
</member>
|
|
1080
|
-
<member name="
|
|
1081
|
-
|
|
1047
|
+
<member name="T:IronPdf.Deployment.ExternalSettings">
|
|
1048
|
+
<summary>
|
|
1049
|
+
This class will search for a class named "IronPdfExternalSettings" in all assembly and try to get the settings from that class
|
|
1050
|
+
</summary>
|
|
1082
1051
|
</member>
|
|
1083
|
-
<member name="
|
|
1084
|
-
|
|
1052
|
+
<member name="T:IronPdf.DocxToPdfRenderer">
|
|
1053
|
+
<summary>
|
|
1054
|
+
IronPdf.DocxToPdfRenderer allows any Docx to be turned into a PDF document using an up-to-date embedded Chrome browser.
|
|
1055
|
+
</summary>
|
|
1085
1056
|
</member>
|
|
1086
|
-
<member name="
|
|
1087
|
-
|
|
1057
|
+
<member name="P:IronPdf.DocxToPdfRenderer.RenderingOptions">
|
|
1058
|
+
<summary>
|
|
1059
|
+
Rendering options
|
|
1060
|
+
</summary>
|
|
1088
1061
|
</member>
|
|
1089
|
-
<member name="
|
|
1090
|
-
|
|
1062
|
+
<member name="M:IronPdf.DocxToPdfRenderer.#ctor">
|
|
1063
|
+
<summary>
|
|
1064
|
+
Create a new Docx To PDF renderer.
|
|
1065
|
+
</summary>
|
|
1091
1066
|
</member>
|
|
1092
|
-
<member name="
|
|
1093
|
-
|
|
1067
|
+
<member name="M:IronPdf.DocxToPdfRenderer.#ctor(IronPdf.DocxPdfRenderOptions)">
|
|
1068
|
+
<summary>
|
|
1069
|
+
Create a new Docx to PDF renderer using the specified options
|
|
1070
|
+
</summary>
|
|
1071
|
+
<param name="Options">Rendering options</param>
|
|
1094
1072
|
</member>
|
|
1095
|
-
<member name="
|
|
1096
|
-
|
|
1073
|
+
<member name="M:IronPdf.DocxToPdfRenderer.RenderDocxAsPdf(System.String,IronPdf.DocxPdfRenderOptions)">
|
|
1074
|
+
<summary>
|
|
1075
|
+
Creates a PDF file from an Word document and returns it as an <see cref="T:IronPdf.PdfDocument"/> object which can be edited and saved to disk or served on a website.
|
|
1076
|
+
</summary>
|
|
1077
|
+
<param name="WordDocumentPath">The word document full path to be rendered as a PDF.</param>
|
|
1078
|
+
<param name="Options">An instance of <see cref="T:IronPdf.DocxPdfRenderOptions"/> that allows configuration of DocxRenderer "Docx to PDF" rendering parameters. </param>
|
|
1079
|
+
<returns>
|
|
1080
|
+
A <see cref="T:IronPdf.PdfDocument"/> with the Docx rendered as its contents.
|
|
1081
|
+
</returns>
|
|
1097
1082
|
</member>
|
|
1098
|
-
<member name="
|
|
1099
|
-
|
|
1083
|
+
<member name="M:IronPdf.DocxToPdfRenderer.RenderDocxAsPdf(System.Byte[],IronPdf.DocxPdfRenderOptions)">
|
|
1084
|
+
<summary>
|
|
1085
|
+
Creates a PDF file from an Word document and returns it as an <see cref="T:IronPdf.PdfDocument"/> object which can be edited and saved to disk or served on a website.
|
|
1086
|
+
</summary>
|
|
1087
|
+
<param name="WordDocumentBytes">The word document byte array to be rendered as a PDF.</param>
|
|
1088
|
+
<param name="Options">An instance of <see cref="T:IronPdf.DocxPdfRenderOptions"/> that allows configuration of DocxRenderer "Docx to PDF" rendering parameters. </param>
|
|
1089
|
+
<returns>
|
|
1090
|
+
A <see cref="T:IronPdf.PdfDocument"/> with the Docx rendered as its contents.
|
|
1091
|
+
</returns>
|
|
1100
1092
|
</member>
|
|
1101
|
-
<member name="
|
|
1102
|
-
|
|
1093
|
+
<member name="M:IronPdf.DocxToPdfRenderer.RenderDocxAsPdf(System.IO.Stream,IronPdf.DocxPdfRenderOptions)">
|
|
1094
|
+
<summary>
|
|
1095
|
+
Creates a PDF file from an Word document and returns it as an <see cref="T:IronPdf.PdfDocument"/> object which can be edited and saved to disk or served on a website.
|
|
1096
|
+
</summary>
|
|
1097
|
+
<param name="WordDocumentStream">The word document stream to be rendered as a PDF.</param>
|
|
1098
|
+
<param name="Options">An instance of <see cref="T:IronPdf.DocxPdfRenderOptions"/> that allows configuration of DocxRenderer "Docx to PDF" rendering parameters. </param>
|
|
1099
|
+
<returns>
|
|
1100
|
+
A <see cref="T:IronPdf.PdfDocument"/> with the Docx rendered as its contents.
|
|
1101
|
+
</returns>
|
|
1103
1102
|
</member>
|
|
1104
|
-
<member name="
|
|
1105
|
-
|
|
1103
|
+
<member name="M:IronPdf.DocxToPdfRenderer.RenderDocxAsPdfAsync(System.String,IronPdf.DocxPdfRenderOptions)">
|
|
1104
|
+
<summary>,
|
|
1105
|
+
Creates a PDF file from an Word document and returns it as an <see cref="T:IronPdf.PdfDocument"/> object which can be edited and saved to disk or served on a website.
|
|
1106
|
+
<para> Async version of the RenderDocxAsPdf method.</para>
|
|
1107
|
+
</summary>
|
|
1108
|
+
<param name="WordDocumentPath">The word document full path to be rendered as a PDF.</param>
|
|
1109
|
+
<param name="Options">An instance of <see cref="T:IronPdf.DocxPdfRenderOptions"/> that allows configuration of DocxRenderer "Docx to PDF" rendering parameters. </param>
|
|
1110
|
+
<returns>
|
|
1111
|
+
A <see cref="T:IronPdf.PdfDocument"/> with the Docx rendered as its contents.
|
|
1112
|
+
</returns>
|
|
1106
1113
|
</member>
|
|
1107
|
-
<member name="
|
|
1108
|
-
|
|
1114
|
+
<member name="M:IronPdf.DocxToPdfRenderer.RenderDocxMailMergeAsPdfAsync``1(System.Collections.Generic.List{``0},System.String,IronPdf.DocxPdfRenderOptions)">
|
|
1115
|
+
<summary>
|
|
1116
|
+
Creates a PDF file from an Word document and returns it as an <see cref="T:IronPdf.PdfDocument"/> object which can be edited and saved to disk or served on a website.
|
|
1117
|
+
<para> Async version of the RenderDocxAsPdf method.</para>
|
|
1118
|
+
</summary>
|
|
1119
|
+
<param name="RecipientsDataList">List of recepient data</param>
|
|
1120
|
+
<param name="WordDocumentPath">The word document full path to be rendered as a PDF.</param>
|
|
1121
|
+
<param name="Options">An instance of <see cref="T:IronPdf.DocxPdfRenderOptions"/> that allows configuration of DocxRenderer "Docx to PDF" rendering parameters. </param>
|
|
1122
|
+
<returns>
|
|
1123
|
+
A <see cref="T:IronPdf.PdfDocument"/> with the Docx rendered as its contents.
|
|
1124
|
+
</returns>
|
|
1109
1125
|
</member>
|
|
1110
|
-
<member name="
|
|
1111
|
-
|
|
1126
|
+
<member name="T:IronPdf.DocxPdfRenderOptions">
|
|
1127
|
+
<summary>
|
|
1128
|
+
Margin values which can be copied from the main document to headers and footers applied to the document
|
|
1129
|
+
</summary>
|
|
1130
|
+
<summary>
|
|
1131
|
+
Docx To PDF output options for <see cref="T:IronPdf.DocxToPdfRenderer"/>. Specifies options such as Paper-Size, DPI, Headers and Footers and other Chromium specific browser setup options.
|
|
1132
|
+
</summary>
|
|
1112
1133
|
</member>
|
|
1113
|
-
<member name="
|
|
1114
|
-
|
|
1134
|
+
<member name="M:IronPdf.DocxPdfRenderOptions.#ctor">
|
|
1135
|
+
<summary>
|
|
1136
|
+
Default Constructor. Creates a new instance of DocxPdfRenderOptions with default settings.
|
|
1137
|
+
</summary>
|
|
1115
1138
|
</member>
|
|
1116
|
-
<member name="
|
|
1117
|
-
|
|
1139
|
+
<member name="P:IronPdf.DocxPdfRenderOptions.CustomPaperHeight">
|
|
1140
|
+
<summary>
|
|
1141
|
+
Custom paper height, in mm
|
|
1142
|
+
</summary>
|
|
1118
1143
|
</member>
|
|
1119
|
-
<member name="
|
|
1120
|
-
|
|
1144
|
+
<member name="P:IronPdf.DocxPdfRenderOptions.CustomPaperWidth">
|
|
1145
|
+
<summary>
|
|
1146
|
+
Custom paper width, in mm
|
|
1147
|
+
</summary>
|
|
1121
1148
|
</member>
|
|
1122
|
-
<member name="
|
|
1123
|
-
|
|
1124
|
-
|
|
1125
|
-
|
|
1126
|
-
3.875in x 8.875in
|
|
1127
|
-
</member>
|
|
1128
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.Number10Envelope">
|
|
1129
|
-
4.125in x 9.5in
|
|
1130
|
-
</member>
|
|
1131
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.Number11Envelope">
|
|
1132
|
-
4.5in x 10.375in
|
|
1133
|
-
</member>
|
|
1134
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.Number12Envelope">
|
|
1135
|
-
4.75in x 11in
|
|
1136
|
-
</member>
|
|
1137
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.Number14Envelope">
|
|
1138
|
-
5in x 11.5in
|
|
1139
|
-
</member>
|
|
1140
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.DLEnvelope">
|
|
1141
|
-
110mm x 220mm
|
|
1142
|
-
</member>
|
|
1143
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.C5Envelope">
|
|
1144
|
-
162mm x 229mm
|
|
1145
|
-
</member>
|
|
1146
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.C3Envelope">
|
|
1147
|
-
324mm x 458mm
|
|
1148
|
-
</member>
|
|
1149
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.C4Envelope">
|
|
1150
|
-
229mm x 324mm
|
|
1151
|
-
</member>
|
|
1152
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.C6Envelope">
|
|
1153
|
-
114mm x 162mm
|
|
1154
|
-
</member>
|
|
1155
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.C65Envelope">
|
|
1156
|
-
114mm x 229mm
|
|
1157
|
-
</member>
|
|
1158
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.B4Envelope">
|
|
1159
|
-
250mm x 353mm
|
|
1160
|
-
</member>
|
|
1161
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.B5Envelope">
|
|
1162
|
-
176mm x 250mm
|
|
1163
|
-
</member>
|
|
1164
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.B6Envelope">
|
|
1165
|
-
176mm x 125mm
|
|
1166
|
-
</member>
|
|
1167
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.ItalyEnvelope">
|
|
1168
|
-
110mm x 230mm
|
|
1169
|
-
</member>
|
|
1170
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.MonarchEnvelope">
|
|
1171
|
-
3.875in x 7.5in
|
|
1172
|
-
</member>
|
|
1173
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.PersonalEnvelope">
|
|
1174
|
-
3.625in x 6.5in
|
|
1175
|
-
</member>
|
|
1176
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.USStandardFanfold">
|
|
1177
|
-
14.875in x 11in
|
|
1178
|
-
</member>
|
|
1179
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.GermanStandardFanfold">
|
|
1180
|
-
8.5in x 12in
|
|
1181
|
-
</member>
|
|
1182
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.GermanLegalFanfold">
|
|
1183
|
-
8.5in x 13in
|
|
1184
|
-
</member>
|
|
1185
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.IsoB4">
|
|
1186
|
-
250mm x 353mm
|
|
1187
|
-
</member>
|
|
1188
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.JapanesePostcard">
|
|
1189
|
-
100mm x 148mm
|
|
1190
|
-
</member>
|
|
1191
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.Standard9x11">
|
|
1192
|
-
9in x 11in
|
|
1193
|
-
</member>
|
|
1194
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.Standard10x11">
|
|
1195
|
-
10in x 11in
|
|
1196
|
-
</member>
|
|
1197
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.Standard15x11">
|
|
1198
|
-
15in x 11in
|
|
1199
|
-
</member>
|
|
1200
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.InviteEnvelope">
|
|
1201
|
-
220mm x 220mm
|
|
1202
|
-
</member>
|
|
1203
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.LetterExtra">
|
|
1204
|
-
9.275in x 12in
|
|
1205
|
-
</member>
|
|
1206
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.LegalExtra">
|
|
1207
|
-
9.275in x 15in
|
|
1208
|
-
</member>
|
|
1209
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.TabloidExtra">
|
|
1210
|
-
11.69in x 18in
|
|
1211
|
-
</member>
|
|
1212
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.A4Extra">
|
|
1213
|
-
236mm x 322mm
|
|
1214
|
-
</member>
|
|
1215
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.LetterTransverse">
|
|
1216
|
-
8.275in x 11in
|
|
1217
|
-
</member>
|
|
1218
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.A4Transverse">
|
|
1219
|
-
210mm x 297mm
|
|
1220
|
-
</member>
|
|
1221
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.LetterExtraTransverse">
|
|
1222
|
-
9.275in x 12in
|
|
1223
|
-
</member>
|
|
1224
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.APlus">
|
|
1225
|
-
227mm x 356mm
|
|
1226
|
-
</member>
|
|
1227
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.BPlus">
|
|
1228
|
-
305mm x 487mm
|
|
1229
|
-
</member>
|
|
1230
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.LetterPlus">
|
|
1231
|
-
8.5in x 12.69in
|
|
1232
|
-
</member>
|
|
1233
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.A4Plus">
|
|
1234
|
-
210mm x 330mm
|
|
1235
|
-
</member>
|
|
1236
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.A5Transverse">
|
|
1237
|
-
148mm x 210mm
|
|
1238
|
-
</member>
|
|
1239
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.B5Transverse">
|
|
1240
|
-
182mm x 257mm
|
|
1241
|
-
</member>
|
|
1242
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.A3Extra">
|
|
1243
|
-
322mm x 445mm
|
|
1244
|
-
</member>
|
|
1245
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.A5Extra">
|
|
1246
|
-
174mm x 235mm
|
|
1247
|
-
</member>
|
|
1248
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.B5Extra">
|
|
1249
|
-
201mm x 276mm
|
|
1250
|
-
</member>
|
|
1251
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.A2">
|
|
1252
|
-
420mm x 594mm
|
|
1253
|
-
</member>
|
|
1254
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.A3Transverse">
|
|
1255
|
-
297mm x 420mm
|
|
1256
|
-
</member>
|
|
1257
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.A3ExtraTransverse">
|
|
1258
|
-
322mm x 445mm
|
|
1259
|
-
</member>
|
|
1260
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.JapaneseDoublePostcard">
|
|
1261
|
-
200mm x 148mm
|
|
1262
|
-
</member>
|
|
1263
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.A6">
|
|
1264
|
-
105mm x 148mm
|
|
1265
|
-
</member>
|
|
1266
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.LetterRotated">
|
|
1267
|
-
11in x 8.5in
|
|
1268
|
-
</member>
|
|
1269
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.A3Rotated">
|
|
1270
|
-
420mm x 297mm
|
|
1271
|
-
</member>
|
|
1272
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.A4Rotated">
|
|
1273
|
-
297mm x 210mm
|
|
1274
|
-
</member>
|
|
1275
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.A5Rotated">
|
|
1276
|
-
210mm x 148mm
|
|
1277
|
-
</member>
|
|
1278
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.B4JisRotated">
|
|
1279
|
-
364mm x 257mm
|
|
1280
|
-
</member>
|
|
1281
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.B5JisRotated">
|
|
1282
|
-
257mm x 182mm
|
|
1283
|
-
</member>
|
|
1284
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.JapanesePostcardRotated">
|
|
1285
|
-
148mm x 100mm
|
|
1286
|
-
</member>
|
|
1287
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.JapaneseDoublePostcardRotated">
|
|
1288
|
-
148mm x 200mm
|
|
1289
|
-
</member>
|
|
1290
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.A6Rotated">
|
|
1291
|
-
148mm x 105mm
|
|
1292
|
-
</member>
|
|
1293
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.B6Jis">
|
|
1294
|
-
128mm x 182mm
|
|
1295
|
-
</member>
|
|
1296
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.B6JisRotated">
|
|
1297
|
-
182mm x 128mm
|
|
1298
|
-
</member>
|
|
1299
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.Standard12x11">
|
|
1300
|
-
12in x 11in
|
|
1301
|
-
</member>
|
|
1302
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.Prc16K">
|
|
1303
|
-
146mm x 215mm
|
|
1304
|
-
</member>
|
|
1305
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.Prc32K">
|
|
1306
|
-
97mm x 151mm
|
|
1307
|
-
</member>
|
|
1308
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.Prc32KBig">
|
|
1309
|
-
97mm x 151mm
|
|
1310
|
-
</member>
|
|
1311
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.PrcEnvelopeNumber1">
|
|
1312
|
-
102mm x 165mm
|
|
1313
|
-
</member>
|
|
1314
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.PrcEnvelopeNumber2">
|
|
1315
|
-
102mm x 176mm
|
|
1316
|
-
</member>
|
|
1317
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.PrcEnvelopeNumber3">
|
|
1318
|
-
125mm x 176mm
|
|
1319
|
-
</member>
|
|
1320
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.PrcEnvelopeNumber4">
|
|
1321
|
-
110mm x 208mm
|
|
1322
|
-
</member>
|
|
1323
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.PrcEnvelopeNumber5">
|
|
1324
|
-
110mm x 220mm
|
|
1325
|
-
</member>
|
|
1326
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.PrcEnvelopeNumber6">
|
|
1327
|
-
120mm x 230mm
|
|
1328
|
-
</member>
|
|
1329
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.PrcEnvelopeNumber7">
|
|
1330
|
-
160mm x 230mm
|
|
1331
|
-
</member>
|
|
1332
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.PrcEnvelopeNumber8">
|
|
1333
|
-
120mm x 309mm
|
|
1334
|
-
</member>
|
|
1335
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.PrcEnvelopeNumber9">
|
|
1336
|
-
229mm x 324mm
|
|
1337
|
-
</member>
|
|
1338
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.PrcEnvelopeNumber10">
|
|
1339
|
-
324mm x 458mm
|
|
1340
|
-
</member>
|
|
1341
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.Prc16KRotated">
|
|
1342
|
-
146mm x 215mm
|
|
1343
|
-
</member>
|
|
1344
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.Prc32KRotated">
|
|
1345
|
-
97mm x 151mm
|
|
1346
|
-
</member>
|
|
1347
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.Prc32KBigRotated">
|
|
1348
|
-
97mm x 151mm
|
|
1349
|
-
</member>
|
|
1350
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.PrcEnvelopeNumber1Rotated">
|
|
1351
|
-
165mm x 102mm
|
|
1352
|
-
</member>
|
|
1353
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.PrcEnvelopeNumber2Rotated">
|
|
1354
|
-
176mm x 102mm
|
|
1355
|
-
</member>
|
|
1356
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.PrcEnvelopeNumber3Rotated">
|
|
1357
|
-
176mm x 125mm
|
|
1358
|
-
</member>
|
|
1359
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.PrcEnvelopeNumber4Rotated">
|
|
1360
|
-
208mm x 110mm
|
|
1361
|
-
</member>
|
|
1362
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.PrcEnvelopeNumber5Rotated">
|
|
1363
|
-
220mm x 110mm
|
|
1364
|
-
</member>
|
|
1365
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.PrcEnvelopeNumber6Rotated">
|
|
1366
|
-
230mm x 120mm
|
|
1367
|
-
</member>
|
|
1368
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.PrcEnvelopeNumber7Rotated">
|
|
1369
|
-
230mm x 160mm
|
|
1370
|
-
</member>
|
|
1371
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.PrcEnvelopeNumber8Rotated">
|
|
1372
|
-
309mm x 120mm
|
|
1373
|
-
</member>
|
|
1374
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.PrcEnvelopeNumber9Rotated">
|
|
1375
|
-
324mm x 229mm
|
|
1376
|
-
</member>
|
|
1377
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.PrcEnvelopeNumber10Rotated">
|
|
1378
|
-
458mm x 324mm
|
|
1379
|
-
</member>
|
|
1380
|
-
<member name="F:IronPdf.Rendering.PdfPaperSize.Custom">
|
|
1381
|
-
Set using SetCustomPaperSizeInInches or SetCustomPaperSizeInMillimeters
|
|
1382
|
-
</member>
|
|
1383
|
-
<member name="T:IronPdf.Rendering.PdfPaperSizeConverter">
|
|
1384
|
-
<summary>
|
|
1385
|
-
Class for converting PDF paper sizes from the <see cref="T:IronPdf.Rendering.PdfPaperSize"/> enum to millimeters.
|
|
1386
|
-
</summary>
|
|
1387
|
-
</member>
|
|
1388
|
-
<member name="M:IronPdf.Rendering.PdfPaperSizeConverter.ToMillimeters(IronPdf.Rendering.PdfPaperSize)">
|
|
1389
|
-
<summary>
|
|
1390
|
-
Converts the given <see cref="T:IronPdf.Rendering.PdfPaperSize"/> value to its equivalent size in millimeters.
|
|
1391
|
-
</summary>
|
|
1392
|
-
<param name="paperSize">The <see cref="T:IronPdf.Rendering.PdfPaperSize"/> value to convert.</param>
|
|
1393
|
-
<returns>A tuple that contains the width and height in millimeters for the specified <see cref="T:IronPdf.Rendering.PdfPaperSize"/> enum value.</returns>
|
|
1394
|
-
</member>
|
|
1395
|
-
<member name="T:IronPdf.Rendering.PdfRenderingEngine">
|
|
1396
|
-
<summary>
|
|
1397
|
-
Specifies which "HTML to PDF" rendering engine to use.
|
|
1398
|
-
</summary>
|
|
1399
|
-
</member>
|
|
1400
|
-
<member name="F:IronPdf.Rendering.PdfRenderingEngine.Default">
|
|
1401
|
-
<summary>Chooses the first renderer in this list which is currently available at runtime.</summary>
|
|
1402
|
-
</member>
|
|
1403
|
-
<member name="F:IronPdf.Rendering.PdfRenderingEngine.Chrome">
|
|
1404
|
-
<summary>Recommended as our most capable, multithreaded and standards compliant rendering engine. Chooses the IronPDf embedded Chrome browser rendering engine.</summary>
|
|
1405
|
-
</member>
|
|
1406
|
-
<member name="T:IronPdf.UseMargins">
|
|
1407
|
-
<summary>
|
|
1408
|
-
Margin values which can be copied from the main document to headers and footers applied to the document
|
|
1409
|
-
</summary>
|
|
1410
|
-
</member>
|
|
1411
|
-
<member name="F:IronPdf.UseMargins.None">
|
|
1412
|
-
<summary>
|
|
1413
|
-
No margins values will be used
|
|
1414
|
-
</summary>
|
|
1415
|
-
</member>
|
|
1416
|
-
<member name="F:IronPdf.UseMargins.Top">
|
|
1417
|
-
<summary>
|
|
1418
|
-
Top margin value will be used
|
|
1419
|
-
</summary>
|
|
1420
|
-
</member>
|
|
1421
|
-
<member name="F:IronPdf.UseMargins.Bottom">
|
|
1422
|
-
<summary>
|
|
1423
|
-
Bottom margin value will be used
|
|
1424
|
-
</summary>
|
|
1425
|
-
</member>
|
|
1426
|
-
<member name="F:IronPdf.UseMargins.Left">
|
|
1427
|
-
<summary>
|
|
1428
|
-
Left margin value will be used
|
|
1429
|
-
</summary>
|
|
1430
|
-
</member>
|
|
1431
|
-
<member name="F:IronPdf.UseMargins.Right">
|
|
1432
|
-
<summary>
|
|
1433
|
-
Right margin value will be used
|
|
1434
|
-
</summary>
|
|
1435
|
-
</member>
|
|
1436
|
-
<member name="F:IronPdf.UseMargins.TopAndBottom">
|
|
1437
|
-
<summary>
|
|
1438
|
-
Top and bottom margin values will be used
|
|
1439
|
-
</summary>
|
|
1440
|
-
</member>
|
|
1441
|
-
<member name="F:IronPdf.UseMargins.LeftAndRight">
|
|
1442
|
-
<summary>
|
|
1443
|
-
Left and right margin values will be used
|
|
1444
|
-
</summary>
|
|
1445
|
-
</member>
|
|
1446
|
-
<member name="F:IronPdf.UseMargins.All">
|
|
1447
|
-
<summary>
|
|
1448
|
-
All margin values will be used
|
|
1449
|
-
</summary>
|
|
1450
|
-
</member>
|
|
1451
|
-
<member name="T:IronPdf.ChromePdfRenderOptions">
|
|
1452
|
-
<summary>
|
|
1453
|
-
Html To PDF output options for <see cref="T:IronPdf.ChromePdfRenderer"/>. Specifies options such as Paper-Size, DPI, Headers and Footers and other Chromium specific browser setup options.
|
|
1454
|
-
</summary>
|
|
1455
|
-
</member>
|
|
1456
|
-
<member name="M:IronPdf.ChromePdfRenderOptions.#ctor">
|
|
1457
|
-
<summary>
|
|
1458
|
-
Default Constructor. Creates a new instance of ChromePdfRenderOptions with default settings.
|
|
1459
|
-
</summary>
|
|
1460
|
-
</member>
|
|
1461
|
-
<member name="P:IronPdf.ChromePdfRenderOptions.DefaultChrome">
|
|
1462
|
-
<summary>
|
|
1463
|
-
A <see cref="T:IronPdf.ChromePdfRenderOptions"/> preset with default settings that match the vanilla PDF viewer in Chrome.
|
|
1464
|
-
<br/>
|
|
1465
|
-
<para>These values are: <br/>
|
|
1466
|
-
<see cref="P:IronPdf.ChromePdfRenderOptions.CssMediaType"/>: <see cref="F:IronPdf.Rendering.PdfCssMediaType.Print"/>, <see cref="P:IronPdf.ChromePdfRenderOptions.FirstPageNumber"/>: 1, <see cref="P:IronPdf.ChromePdfRenderOptions.FitToPaperMode"/>: <see cref="F:IronPdf.Engines.Chrome.FitToPaperModes.None"/>,
|
|
1467
|
-
Top and left margin: 0.39 in, Bottom and Right margin: 0.38 in, PaperSize: <see cref="F:IronPdf.Rendering.PdfPaperSize.A4"/>,
|
|
1468
|
-
<see cref="P:IronPdf.ChromePdfRenderOptions.PaperOrientation"/>: <see cref="F:IronPdf.Rendering.PdfPaperOrientation.Portrait"/>, <see cref="P:IronPdf.ChromePdfRenderOptions.PrintHtmlBackgrounds"/>: false, <see cref="P:IronPdf.ChromePdfRenderOptions.RenderDelay"/>: 20
|
|
1469
|
-
</para>
|
|
1470
|
-
</summary>
|
|
1471
|
-
</member>
|
|
1472
|
-
<member name="P:IronPdf.ChromePdfRenderOptions.UseMarginsOnHeaderAndFooter">
|
|
1473
|
-
<summary>
|
|
1474
|
-
Use margin values from the main document when rendering headers and footers.
|
|
1475
|
-
<para>This value is ignored when header and footer heights are autosized. Autosizing occurs when a header or footer <see cref="P:IronPdf.HtmlHeaderFooter.MaxHeight">MaxHeight</see> value is null.</para>
|
|
1476
|
-
<para>The default value is <see cref="F:IronPdf.UseMargins.LeftAndRight"/>. To apply margins on all edges, use <see cref="F:IronPdf.UseMargins.All"/>.</para>
|
|
1477
|
-
</summary>
|
|
1478
|
-
</member>
|
|
1479
|
-
<member name="P:IronPdf.ChromePdfRenderOptions.CreatePdfFormsFromHtml">
|
|
1480
|
-
<summary>
|
|
1481
|
-
Turns all Html forms elements into editable PDF forms.
|
|
1482
|
-
<para>Default value is true.</para>
|
|
1483
|
-
</summary>
|
|
1484
|
-
</member>
|
|
1485
|
-
<member name="P:IronPdf.ChromePdfRenderOptions.CssMediaType">
|
|
1486
|
-
<summary>
|
|
1487
|
-
Enables Media="screen" CSS Styles and StyleSheets <para>Note: By setting AllowScreenCss=false, IronPdf
|
|
1488
|
-
renders PDFs from HTML using CSS for media="print" as if printing a web page in a browser print dialog.</para>
|
|
1489
|
-
<para>Default value is PdfCssMediaType.Screen.</para>
|
|
1490
|
-
</summary>
|
|
1491
|
-
</member>
|
|
1492
|
-
<member name="F:IronPdf.ChromePdfRenderOptions.CustomCookies">
|
|
1493
|
-
<summary>
|
|
1494
|
-
Custom cookies for this HTML render. Cookies do not persist in between renders and must be set each time.
|
|
1495
|
-
</summary>
|
|
1496
|
-
</member>
|
|
1497
|
-
<member name="P:IronPdf.ChromePdfRenderOptions.CustomCssUrl">
|
|
1498
|
-
<summary>
|
|
1499
|
-
Allows a custom CSS style-sheet to be applied to Html before rendering. May be a local file path or a remote url.
|
|
1500
|
-
</summary>
|
|
1501
|
-
<remarks>Only applicable when rendering Html to Pdf</remarks>
|
|
1502
|
-
</member>
|
|
1503
|
-
<member name="P:IronPdf.ChromePdfRenderOptions.CustomPaperHeight">
|
|
1504
|
-
<summary>
|
|
1505
|
-
Custom paper height, in mm
|
|
1506
|
-
</summary>
|
|
1507
|
-
</member>
|
|
1508
|
-
<member name="P:IronPdf.ChromePdfRenderOptions.CustomPaperWidth">
|
|
1509
|
-
<summary>
|
|
1510
|
-
Custom paper width, in mm
|
|
1511
|
-
</summary>
|
|
1512
|
-
</member>
|
|
1513
|
-
<member name="P:IronPdf.ChromePdfRenderOptions.EnableJavaScript">
|
|
1514
|
-
<summary>
|
|
1515
|
-
Enables JavaScript and Json to be executed before the page is rendered. Ideal for printing from Ajax /
|
|
1516
|
-
Angular Applications. <para>Also see <see cref="P:IronPdf.ChromePdfRenderOptions.RenderDelay"/></para>
|
|
1517
|
-
<para>Default value is false.</para>
|
|
1518
|
-
</summary>
|
|
1519
|
-
</member>
|
|
1520
|
-
<member name="P:IronPdf.ChromePdfRenderOptions.EnableMathematicalLaTex">
|
|
1521
|
-
<summary>
|
|
1522
|
-
Enables Mathematical LaTeX Elements Rendering
|
|
1523
|
-
</summary>
|
|
1524
|
-
</member>
|
|
1525
|
-
<member name="P:IronPdf.ChromePdfRenderOptions.Javascript">
|
|
1526
|
-
<summary>
|
|
1527
|
-
A custom javascript string to be executed after all HTML has loaded but before PDf rendering.
|
|
1528
|
-
</summary>
|
|
1529
|
-
</member>
|
|
1530
|
-
<member name="P:IronPdf.ChromePdfRenderOptions.JavascriptMessageListener">
|
|
1531
|
-
<summary>
|
|
1532
|
-
Method callback to be invoked whenever a browser JavaScript console message becomes available.
|
|
1533
|
-
</summary>
|
|
1534
|
-
</member>
|
|
1535
|
-
<member name="P:IronPdf.ChromePdfRenderOptions.FirstPageNumber">
|
|
1536
|
-
<summary>
|
|
1537
|
-
First page number to be used in PDF Headers and Footers.
|
|
1538
|
-
<para><seealso cref="P:IronPdf.ChromePdfRenderOptions.TextHeader"/></para>
|
|
1539
|
-
<para><seealso cref="P:IronPdf.ChromePdfRenderOptions.HtmlHeader"/></para>
|
|
1540
|
-
<para><seealso cref="P:IronPdf.ChromePdfRenderOptions.TextFooter"/></para>
|
|
1541
|
-
<para><seealso cref="P:IronPdf.ChromePdfRenderOptions.HtmlFooter"/></para>
|
|
1542
|
-
<para>Default value is 1.</para>
|
|
1543
|
-
</summary>
|
|
1544
|
-
</member>
|
|
1545
|
-
<member name="P:IronPdf.ChromePdfRenderOptions.TableOfContents">
|
|
1546
|
-
<summary>
|
|
1547
|
-
Generate a table of contents at the location in the HTML document where an element is found with id "ironpdf-toc".
|
|
1548
|
-
</summary>
|
|
1549
|
-
</member>
|
|
1550
|
-
<member name="P:IronPdf.ChromePdfRenderOptions.GrayScale">
|
|
1551
|
-
<summary>
|
|
1552
|
-
Outputs a black-and-white PDF
|
|
1553
|
-
<para>Default value is false.</para>
|
|
1554
|
-
</summary>
|
|
1555
|
-
</member>
|
|
1556
|
-
<member name="P:IronPdf.ChromePdfRenderOptions.HtmlHeader">
|
|
1557
|
-
<summary>
|
|
1558
|
-
Sets the header content for every PDF page as Html. Supports 'mail-merge'.
|
|
1559
|
-
</summary>
|
|
1560
|
-
</member>
|
|
1561
|
-
<member name="P:IronPdf.ChromePdfRenderOptions.HtmlFooter">
|
|
1562
|
-
<summary>
|
|
1563
|
-
Sets the footer content for every PDF page as Html. Supports 'mail-merge'.
|
|
1564
|
-
</summary>
|
|
1565
|
-
</member>
|
|
1566
|
-
<member name="P:IronPdf.ChromePdfRenderOptions.InputEncoding">
|
|
1567
|
-
<summary>
|
|
1568
|
-
The input character encoding as a string;
|
|
1569
|
-
<para>Default value is Encoding.UTF8.</para>
|
|
1570
|
-
</summary>
|
|
1571
|
-
</member>
|
|
1572
|
-
<member name="P:IronPdf.ChromePdfRenderOptions.MarginBottom">
|
|
1573
|
-
<summary>
|
|
1574
|
-
Bottom PDF "paper" margin in millimeters. Set to zero for border-less and commercial printing applications.
|
|
1575
|
-
<para>Default value is 25. However, this value will be ignored unless <see cref="P:IronPdf.ChromePdfRenderOptions.UseMarginsOnHeaderAndFooter"/> is set to <see cref="F:IronPdf.UseMargins.Bottom"/>, <see cref="F:IronPdf.UseMargins.TopAndBottom"/>, or <see cref="F:IronPdf.UseMargins.All"/>.</para>
|
|
1576
|
-
</summary>
|
|
1577
|
-
</member>
|
|
1578
|
-
<member name="P:IronPdf.ChromePdfRenderOptions.MarginLeft">
|
|
1579
|
-
<summary>
|
|
1580
|
-
Left PDF "paper" margin in millimeters. Set to zero for border-less and commercial printing applications.
|
|
1581
|
-
<para>Default value is 25. This value is enabled by default, as <see cref="P:IronPdf.ChromePdfRenderOptions.UseMarginsOnHeaderAndFooter"/> defaults to <see cref="F:IronPdf.UseMargins.LeftAndRight"/>. To explicitly disable, set <see cref="P:IronPdf.ChromePdfRenderOptions.UseMarginsOnHeaderAndFooter"/> to a value that excludes <see cref="F:IronPdf.UseMargins.Left"/>.</para>
|
|
1582
|
-
</summary>
|
|
1583
|
-
</member>
|
|
1584
|
-
<member name="P:IronPdf.ChromePdfRenderOptions.MarginRight">
|
|
1585
|
-
<summary>
|
|
1586
|
-
Right PDF "paper" margin in millimeters. Set to zero for border-less and commercial printing applications.
|
|
1587
|
-
<para>Default value is 25. This value is enabled by default, as <see cref="P:IronPdf.ChromePdfRenderOptions.UseMarginsOnHeaderAndFooter"/> defaults to <see cref="F:IronPdf.UseMargins.LeftAndRight"/>. To explicitly disable, set <see cref="P:IronPdf.ChromePdfRenderOptions.UseMarginsOnHeaderAndFooter"/> to a value that excludes <see cref="F:IronPdf.UseMargins.Right"/>.</para>
|
|
1588
|
-
</summary>
|
|
1589
|
-
</member>
|
|
1590
|
-
<member name="P:IronPdf.ChromePdfRenderOptions.MarginTop">
|
|
1591
|
-
<summary>
|
|
1592
|
-
Top PDF "paper" margin in millimeters. Set to zero for border-less and commercial printing applications.
|
|
1593
|
-
<para>Default value is 25. However, this value will be ignored unless <see cref="P:IronPdf.ChromePdfRenderOptions.UseMarginsOnHeaderAndFooter"/> is set to <see cref="F:IronPdf.UseMargins.Top"/>, <see cref="F:IronPdf.UseMargins.TopAndBottom"/>, or <see cref="F:IronPdf.UseMargins.All"/>.</para>
|
|
1594
|
-
</summary>
|
|
1595
|
-
</member>
|
|
1596
|
-
<member name="P:IronPdf.ChromePdfRenderOptions.PaperOrientation">
|
|
1597
|
-
<summary>
|
|
1598
|
-
The PDF paper orientation. E.g. Portrait or Landscape.
|
|
1599
|
-
<para>Default value is Portrait.</para>
|
|
1600
|
-
</summary>
|
|
1601
|
-
</member>
|
|
1602
|
-
<member name="P:IronPdf.ChromePdfRenderOptions.PaperSize">
|
|
1603
|
-
<summary>
|
|
1604
|
-
Set an output paper size for PDF pages. System.Drawing.Printing.PaperKind. <para>Use SetCustomPaperSize(int
|
|
1605
|
-
width, int height) for custom sizes.</para>
|
|
1606
|
-
<para>Default value is A4.</para>
|
|
1607
|
-
</summary>
|
|
1608
|
-
</member>
|
|
1609
|
-
<member name="P:IronPdf.ChromePdfRenderOptions.PrintHtmlBackgrounds">
|
|
1610
|
-
<summary>
|
|
1611
|
-
Prints background-colors and images from Html.
|
|
1612
|
-
<para>Default value is true.</para>
|
|
1613
|
-
</summary>
|
|
1614
|
-
</member>
|
|
1615
|
-
<member name="P:IronPdf.ChromePdfRenderOptions.RequestContext">
|
|
1616
|
-
<summary>
|
|
1617
|
-
Request context for this render. Determines isolation of certain resources such as cookies.
|
|
1618
|
-
<para>
|
|
1619
|
-
See <see cref="T:IronPdf.Rendering.RequestContexts"/> for more information
|
|
1620
|
-
</para>
|
|
1621
|
-
</summary>
|
|
1622
|
-
</member>
|
|
1623
|
-
<member name="P:IronPdf.ChromePdfRenderOptions.TextFooter">
|
|
1624
|
-
<summary>
|
|
1625
|
-
Sets the footer content for every PDF page as text. Supports 'mail-merge' and automatically turns urls into hyperlinks..
|
|
1626
|
-
</summary>
|
|
1627
|
-
</member>
|
|
1628
|
-
<member name="P:IronPdf.ChromePdfRenderOptions.TextHeader">
|
|
1629
|
-
<summary>
|
|
1630
|
-
Sets the header content for every PDF page as text. Supports 'mail-merge' and automatically turns urls into hyperlinks..
|
|
1631
|
-
</summary>
|
|
1632
|
-
</member>
|
|
1633
|
-
<member name="P:IronPdf.ChromePdfRenderOptions.Timeout">
|
|
1634
|
-
<summary>
|
|
1635
|
-
Render timeout in seconds
|
|
1636
|
-
<para>Default value is 60.</para>
|
|
1637
|
-
</summary>
|
|
1638
|
-
</member>
|
|
1639
|
-
<member name="P:IronPdf.ChromePdfRenderOptions.Title">
|
|
1640
|
-
<summary>
|
|
1641
|
-
PDF Document Name and Title meta-data. Not required. Useful for mail-merge and automatic file naming in the IronPdf MVC and Razor extensions.
|
|
1642
|
-
</summary>
|
|
1643
|
-
</member>
|
|
1644
|
-
<member name="F:IronPdf.ChromePdfRenderOptions.PaperFit">
|
|
1645
|
-
<summary>
|
|
1646
|
-
A html-to-virtual paper setup manager allowing the developer to control how content will be laid out on PDF "paper" pages.
|
|
1647
|
-
<para>Include options for: Deafult Chrome Behavior, Zoomed, Responsive CSS3 Layouts, SCale-To-Page & Continuous Feed (e.g. reciept) style PDF page setups.</para>
|
|
1648
|
-
</summary>
|
|
1649
|
-
</member>
|
|
1650
|
-
<member name="P:IronPdf.ChromePdfRenderOptions.ForcePaperSize">
|
|
1651
|
-
<summary>
|
|
1652
|
-
Force page sizes to be exactly what is specified via <see cref="P:IronPdf.ChromePdfRenderOptions.PaperSize"/> by resizing the page after generating a PDF from HTML
|
|
1653
|
-
<para>Useful for bypassing CSS rules which specify paper size</para>
|
|
1654
|
-
</summary>
|
|
1655
|
-
<remarks>Helps correct small errors in page size when rendering HTML to PDF</remarks>
|
|
1656
|
-
</member>
|
|
1657
|
-
<member name="F:IronPdf.ChromePdfRenderOptions.HttpRequestHeaders">
|
|
1658
|
-
<summary>
|
|
1659
|
-
Custom HTTP request headers to be sent with the HTML
|
|
1660
|
-
</summary>
|
|
1661
|
-
</member>
|
|
1662
|
-
<member name="P:IronPdf.ChromePdfRenderOptions.WaitFor">
|
|
1663
|
-
<summary>
|
|
1664
|
-
A wrapper object that holds configuration for wait-for mechanism for user to wait for certain events before rendering.
|
|
1665
|
-
</summary>
|
|
1666
|
-
<remarks>By default, it will wait for nothing.</remarks>
|
|
1667
|
-
</member>
|
|
1668
|
-
<member name="M:IronPdf.ChromePdfRenderOptions.Clone">
|
|
1669
|
-
<summary>
|
|
1670
|
-
Supports <see cref="T:System.ICloneable"/>. Creates a deep copy of this class instance.
|
|
1671
|
-
</summary>
|
|
1672
|
-
<returns>A deep clone of this instance. Use explicit casting to convert object back to the intended type. </returns>
|
|
1673
|
-
</member>
|
|
1674
|
-
<member name="M:IronPdf.ChromePdfRenderOptions.SetCustomPaperSizeinCentimeters(System.Double,System.Double)">
|
|
1675
|
-
<summary>
|
|
1676
|
-
Set an output paper size for PDF pages. Dimensions are in Centimeters.
|
|
1677
|
-
</summary>
|
|
1678
|
-
<param name="width">Custom paper width in cm.</param>
|
|
1679
|
-
<param name="height">>Custom paper height in cm.</param>
|
|
1680
|
-
</member>
|
|
1681
|
-
<member name="M:IronPdf.ChromePdfRenderOptions.SetCustomPaperSizeInInches(System.Double,System.Double)">
|
|
1682
|
-
<summary>
|
|
1683
|
-
Set an output paper size for PDF pages. Dimensions are in Inches.
|
|
1684
|
-
</summary>
|
|
1685
|
-
<param name="width">Custom paper width in Inches.</param>
|
|
1686
|
-
<param name="height">>Custom paper height in Inches.</param>
|
|
1687
|
-
</member>
|
|
1688
|
-
<member name="M:IronPdf.ChromePdfRenderOptions.SetCustomPaperSizeinMilimeters(System.Double,System.Double)">
|
|
1689
|
-
<summary>
|
|
1690
|
-
Set an output paper size for PDF pages. Dimensions are in millimeters.
|
|
1691
|
-
</summary>
|
|
1692
|
-
<param name="width">Custom paper width in millimeters.</param>
|
|
1693
|
-
<param name="height">>Custom paper height in millimeters.</param>
|
|
1694
|
-
</member>
|
|
1695
|
-
<member name="M:IronPdf.ChromePdfRenderOptions.SetCustomPaperSizeinPixelsOrPoints(System.Double,System.Double,System.Int32)">
|
|
1696
|
-
<summary>
|
|
1697
|
-
Set an output paper size for PDF pages. Dimensions are in screen Pixels or printer Points.
|
|
1698
|
-
</summary>
|
|
1699
|
-
<param name="width">Custom paper width in pixels/points.</param>
|
|
1700
|
-
<param name="height">>Custom paper height in pixels/points.</param>
|
|
1701
|
-
<param name="DPI">>Intended print resolution of the PDF. To be clear PDFs have no fixed DPI/PPI value for rendering. 72 and 96 are common onscreen values. 300 is a comon value used in commercial printing. </param>
|
|
1702
|
-
</member>
|
|
1703
|
-
<member name="P:IronPdf.ChromePdfRenderOptions.RenderDelay">
|
|
1704
|
-
<exclude/>
|
|
1705
|
-
<summary>
|
|
1706
|
-
Milliseconds to wait after Html is rendered before printing. This can use useful when considering the
|
|
1707
|
-
rendering of JavaScript, Ajax or animations.
|
|
1708
|
-
<para>Default value is 0.</para>
|
|
1709
|
-
</summary>
|
|
1710
|
-
<exclude/>
|
|
1711
|
-
</member>
|
|
1712
|
-
<member name="P:IronPdf.ChromePdfRenderOptions.ViewPortHeight">
|
|
1713
|
-
<exclude/>
|
|
1714
|
-
</member>
|
|
1715
|
-
<member name="P:IronPdf.ChromePdfRenderOptions.ViewPortWidth">
|
|
1716
|
-
<exclude/>
|
|
1717
|
-
</member>
|
|
1718
|
-
<member name="P:IronPdf.ChromePdfRenderOptions.Zoom">
|
|
1719
|
-
<exclude/>
|
|
1720
|
-
</member>
|
|
1721
|
-
<member name="P:IronPdf.ChromePdfRenderOptions.FitToPaperMode">
|
|
1722
|
-
<exclude/>
|
|
1723
|
-
</member>
|
|
1724
|
-
<member name="P:IronPdf.ChromePdfRenderOptions.ApplyMarginToHeaderAndFooter">
|
|
1725
|
-
<summary>
|
|
1726
|
-
Apply margin option to Html Headers and Footers. default is false which make Html Headers and Footers have 0 margin.
|
|
1727
|
-
Only support ChromeRender
|
|
1728
|
-
<para>Default value is false.</para>
|
|
1729
|
-
</summary>
|
|
1730
|
-
<seealso cref="P:IronPdf.ChromePdfRenderOptions.UseMarginsOnHeaderAndFooter"/>
|
|
1731
|
-
<exclude/>
|
|
1732
|
-
</member>
|
|
1733
|
-
<member name="P:IronPdf.ChromePdfRenderOptions.FitToPaperWidth">
|
|
1734
|
-
<exclude/>
|
|
1735
|
-
</member>
|
|
1736
|
-
<member name="P:IronPdf.ChromePdfRenderOptions.DPI">
|
|
1737
|
-
<exclude/>
|
|
1738
|
-
</member>
|
|
1739
|
-
<member name="P:IronPdf.ChromePdfRenderOptions.JpegQuality">
|
|
1740
|
-
<exclude/>
|
|
1741
|
-
</member>
|
|
1742
|
-
<member name="T:IronPdf.Cleaner">
|
|
1743
|
-
<summary>
|
|
1744
|
-
The Cleaner class can be used to scan or sanitize (remove any potentially harmful content) PDF document.
|
|
1745
|
-
</summary>
|
|
1746
|
-
</member>
|
|
1747
|
-
<member name="M:IronPdf.Cleaner.SanitizeWithSvg(System.String)">
|
|
1748
|
-
<summary>
|
|
1749
|
-
Sanitize PDF by convert PDF To an SVG image and convert it back to PDF.
|
|
1750
|
-
Returns a new <see cref="T:IronPdf.PdfDocument"/> object.
|
|
1751
|
-
<list type = "bullet" >
|
|
1752
|
-
<item><description>Quicker than <see cref="M:IronPdf.Cleaner.SanitizeWithBitmap(IronPdf.PdfDocument)"/></description></item>
|
|
1753
|
-
<item><description>Resulted as a serachable PDF</description></item>
|
|
1754
|
-
<item><description>Layout might be inconsistency.</description></item>
|
|
1755
|
-
</list>
|
|
1756
|
-
</summary>
|
|
1757
|
-
<param name="pdfFilePath">A PDF File path.</param>
|
|
1758
|
-
</member>
|
|
1759
|
-
<member name="M:IronPdf.Cleaner.SanitizeWithSvg(IronPdf.PdfDocument)">
|
|
1760
|
-
<summary>
|
|
1761
|
-
Sanitize PDF by convert PDF To an SVG image and convert it back to PDF.
|
|
1762
|
-
Returns a new <see cref="T:IronPdf.PdfDocument"/> object.
|
|
1763
|
-
<list type = "bullet" >
|
|
1764
|
-
<item><description>Quicker than <see cref="M:IronPdf.Cleaner.SanitizeWithBitmap(IronPdf.PdfDocument)"/></description></item>
|
|
1765
|
-
<item><description>Resulted as a serachable PDF</description></item>
|
|
1766
|
-
<item><description>Layout might be inconsistency.</description></item>
|
|
1767
|
-
</list>
|
|
1768
|
-
</summary>
|
|
1769
|
-
<param name="pdfDocument">An <see cref="T:IronPdf.PdfDocument"/> of document.</param>
|
|
1770
|
-
</member>
|
|
1771
|
-
<member name="M:IronPdf.Cleaner.SanitizeWithBitmap(System.String)">
|
|
1772
|
-
<summary>
|
|
1773
|
-
Sanitize PDF by convert PDF To an Bitmap image and convert it back to PDF.
|
|
1774
|
-
Returns a new <see cref="T:IronPdf.PdfDocument"/> object.
|
|
1775
|
-
</summary>
|
|
1776
|
-
<list type = "bullet" >
|
|
1777
|
-
<item><description>Slower than <see cref="M:IronPdf.Cleaner.SanitizeWithSvg(IronPdf.PdfDocument)"/></description></item>
|
|
1778
|
-
<item><description>Visually look the same</description></item>
|
|
1779
|
-
<item><description>Resulted as a non-serachable PDF</description></item>
|
|
1780
|
-
</list>
|
|
1781
|
-
<param name="pdfFilePath">A PDF File path.</param>
|
|
1782
|
-
</member>
|
|
1783
|
-
<member name="M:IronPdf.Cleaner.SanitizeWithBitmap(IronPdf.PdfDocument)">
|
|
1784
|
-
<summary>
|
|
1785
|
-
Sanitize PDF by convert PDF To an Bitmap image and convert it back to PDF.
|
|
1786
|
-
Returns a new <see cref="T:IronPdf.PdfDocument"/> object.
|
|
1787
|
-
</summary>
|
|
1788
|
-
<list type = "bullet" >
|
|
1789
|
-
<item><description>Slower than <see cref="M:IronPdf.Cleaner.SanitizeWithSvg(IronPdf.PdfDocument)"/></description></item>
|
|
1790
|
-
<item><description>Visually look the same</description></item>
|
|
1791
|
-
<item><description>Resulted as a non-serachable PDF</description></item>
|
|
1792
|
-
</list>
|
|
1793
|
-
<param name="pdfDocument">An <see cref="T:IronPdf.PdfDocument"/> of document.</param>
|
|
1794
|
-
</member>
|
|
1795
|
-
<member name="M:IronPdf.Cleaner.SanitizeByRemoveSomeElements(IronPdf.PdfDocument)">
|
|
1796
|
-
<summary>
|
|
1797
|
-
Sanitize PDF by remove some elements from the original PDF.
|
|
1798
|
-
Returns a new <see cref="T:IronPdf.PdfDocument"/> object.
|
|
1799
|
-
</summary>
|
|
1800
|
-
<list type = "bullet" >
|
|
1801
|
-
<item><description>Some function of original PDF might not working</description></item>
|
|
1802
|
-
<item><description>Some content might be missing</description></item>
|
|
1803
|
-
</list>
|
|
1804
|
-
<param name="pdfDocument">An <see cref="T:IronPdf.PdfDocument"/> of document.</param>
|
|
1805
|
-
</member>
|
|
1806
|
-
<member name="M:IronPdf.Cleaner.SanitizeByRecreatePdf(IronPdf.PdfDocument)">
|
|
1807
|
-
<summary>
|
|
1808
|
-
Sanitize PDF by re-create PDF document with only text and image from the original PDF.
|
|
1809
|
-
Returns a new <see cref="T:IronPdf.PdfDocument"/> object.
|
|
1810
|
-
</summary>
|
|
1811
|
-
<param name="pdfDocument">An <see cref="T:IronPdf.PdfDocument"/> of document.</param>
|
|
1812
|
-
</member>
|
|
1813
|
-
<member name="M:IronPdf.Cleaner.ScanPdf(System.String,System.String[])">
|
|
1814
|
-
<summary>
|
|
1815
|
-
Scan for any risk that might exists in a PDF.
|
|
1816
|
-
</summary>
|
|
1817
|
-
<param name="pdfFilePath">A PDF File path</param>
|
|
1818
|
-
<param name="yaraFiles">Optional external yara rule files, this will override the default yara rules</param>
|
|
1819
|
-
<returns>scan result as an <see cref="T:IronPdf.CleanerScanResult"/> object</returns>
|
|
1820
|
-
</member>
|
|
1821
|
-
<member name="M:IronPdf.Cleaner.ScanPdf(System.Byte[],System.String[])">
|
|
1822
|
-
<summary>
|
|
1823
|
-
Scan for any risk that might exists in a PDF.
|
|
1824
|
-
</summary>
|
|
1825
|
-
<param name="pdfBytes">a PDF bytes</param>
|
|
1826
|
-
<param name="yaraFiles">Optional external yara rule files, this will override the default yara rules</param>
|
|
1827
|
-
<returns>scan result as an <see cref="T:IronPdf.CleanerScanResult"/> object</returns>
|
|
1828
|
-
</member>
|
|
1829
|
-
<member name="M:IronPdf.Cleaner.ScanPdf(IronPdf.PdfDocument,System.String[])">
|
|
1830
|
-
<summary>
|
|
1831
|
-
Scan for any risk that might exists in a PDF.
|
|
1832
|
-
</summary>
|
|
1833
|
-
<param name="pdfDocument">a PdfDocument object</param>
|
|
1834
|
-
<param name="yaraFiles">Optional external yara rule files, this will override the default yara rules</param>
|
|
1835
|
-
<returns>scan result as an <see cref="T:IronPdf.CleanerScanResult"/> object</returns>
|
|
1836
|
-
</member>
|
|
1837
|
-
<member name="T:IronPdf.CleanerScanResult">
|
|
1838
|
-
<summary>
|
|
1839
|
-
Result from Cleaner scan functions. E.g. <see cref="M:IronPdf.Cleaner.ScanPdf(IronPdf.PdfDocument,System.String[])"/>
|
|
1840
|
-
</summary>
|
|
1841
|
-
</member>
|
|
1842
|
-
<member name="P:IronPdf.CleanerScanResult.IsDetected">
|
|
1843
|
-
<summary>
|
|
1844
|
-
Is any risk was found
|
|
1845
|
-
</summary>
|
|
1846
|
-
</member>
|
|
1847
|
-
<member name="P:IronPdf.CleanerScanResult.Risks">
|
|
1848
|
-
<summary>
|
|
1849
|
-
A list of risk that has been detected.
|
|
1850
|
-
</summary>
|
|
1851
|
-
</member>
|
|
1852
|
-
<member name="M:IronPdf.CleanerScanResult.ToString">
|
|
1853
|
-
<summary>
|
|
1854
|
-
A text summary of CleanerScanResult
|
|
1855
|
-
</summary>
|
|
1856
|
-
<returns>A text summary of CleanerScanResult </returns>
|
|
1857
|
-
</member>
|
|
1858
|
-
<member name="T:IronPdf.Deployment.ExternalSettings">
|
|
1859
|
-
<summary>
|
|
1860
|
-
This class will search for a class named "IronPdfExternalSettings" in all assembly and try to get the settings from that class
|
|
1861
|
-
</summary>
|
|
1862
|
-
</member>
|
|
1863
|
-
<member name="T:IronPdf.DocxToPdfRenderer">
|
|
1864
|
-
<summary>
|
|
1865
|
-
IronPdf.DocxToPdfRenderer allows any Docx to be turned into a PDF document using an up-to-date embedded Chrome browser.
|
|
1866
|
-
</summary>
|
|
1867
|
-
</member>
|
|
1868
|
-
<member name="P:IronPdf.DocxToPdfRenderer.RenderingOptions">
|
|
1869
|
-
<summary>
|
|
1870
|
-
Rendering options
|
|
1871
|
-
</summary>
|
|
1872
|
-
</member>
|
|
1873
|
-
<member name="M:IronPdf.DocxToPdfRenderer.#ctor">
|
|
1874
|
-
<summary>
|
|
1875
|
-
Create a new Docx To PDF renderer.
|
|
1876
|
-
</summary>
|
|
1877
|
-
</member>
|
|
1878
|
-
<member name="M:IronPdf.DocxToPdfRenderer.#ctor(IronPdf.DocxPdfRenderOptions)">
|
|
1879
|
-
<summary>
|
|
1880
|
-
Create a new Docx to PDF renderer using the specified options
|
|
1881
|
-
</summary>
|
|
1882
|
-
<param name="Options">Rendering options</param>
|
|
1883
|
-
</member>
|
|
1884
|
-
<member name="M:IronPdf.DocxToPdfRenderer.RenderDocxAsPdf(System.String,IronPdf.DocxPdfRenderOptions)">
|
|
1885
|
-
<summary>
|
|
1886
|
-
Creates a PDF file from an Word document and returns it as an <see cref="T:IronPdf.PdfDocument"/> object which can be edited and saved to disk or served on a website.
|
|
1887
|
-
</summary>
|
|
1888
|
-
<param name="WordDocumentPath">The word document full path to be rendered as a PDF.</param>
|
|
1889
|
-
<param name="Options">An instance of <see cref="T:IronPdf.DocxPdfRenderOptions"/> that allows configuration of DocxRenderer "Docx to PDF" rendering parameters. </param>
|
|
1890
|
-
<returns>
|
|
1891
|
-
A <see cref="T:IronPdf.PdfDocument"/> with the Docx rendered as its contents.
|
|
1892
|
-
</returns>
|
|
1893
|
-
</member>
|
|
1894
|
-
<member name="M:IronPdf.DocxToPdfRenderer.RenderDocxAsPdf(System.Byte[],IronPdf.DocxPdfRenderOptions)">
|
|
1895
|
-
<summary>
|
|
1896
|
-
Creates a PDF file from an Word document and returns it as an <see cref="T:IronPdf.PdfDocument"/> object which can be edited and saved to disk or served on a website.
|
|
1897
|
-
</summary>
|
|
1898
|
-
<param name="WordDocumentBytes">The word document byte array to be rendered as a PDF.</param>
|
|
1899
|
-
<param name="Options">An instance of <see cref="T:IronPdf.DocxPdfRenderOptions"/> that allows configuration of DocxRenderer "Docx to PDF" rendering parameters. </param>
|
|
1900
|
-
<returns>
|
|
1901
|
-
A <see cref="T:IronPdf.PdfDocument"/> with the Docx rendered as its contents.
|
|
1902
|
-
</returns>
|
|
1903
|
-
</member>
|
|
1904
|
-
<member name="M:IronPdf.DocxToPdfRenderer.RenderDocxAsPdf(System.IO.Stream,IronPdf.DocxPdfRenderOptions)">
|
|
1905
|
-
<summary>
|
|
1906
|
-
Creates a PDF file from an Word document and returns it as an <see cref="T:IronPdf.PdfDocument"/> object which can be edited and saved to disk or served on a website.
|
|
1907
|
-
</summary>
|
|
1908
|
-
<param name="WordDocumentStream">The word document stream to be rendered as a PDF.</param>
|
|
1909
|
-
<param name="Options">An instance of <see cref="T:IronPdf.DocxPdfRenderOptions"/> that allows configuration of DocxRenderer "Docx to PDF" rendering parameters. </param>
|
|
1910
|
-
<returns>
|
|
1911
|
-
A <see cref="T:IronPdf.PdfDocument"/> with the Docx rendered as its contents.
|
|
1912
|
-
</returns>
|
|
1913
|
-
</member>
|
|
1914
|
-
<member name="M:IronPdf.DocxToPdfRenderer.RenderDocxAsPdfAsync(System.String,IronPdf.DocxPdfRenderOptions)">
|
|
1915
|
-
<summary>,
|
|
1916
|
-
Creates a PDF file from an Word document and returns it as an <see cref="T:IronPdf.PdfDocument"/> object which can be edited and saved to disk or served on a website.
|
|
1917
|
-
<para> Async version of the RenderDocxAsPdf method.</para>
|
|
1918
|
-
</summary>
|
|
1919
|
-
<param name="WordDocumentPath">The word document full path to be rendered as a PDF.</param>
|
|
1920
|
-
<param name="Options">An instance of <see cref="T:IronPdf.DocxPdfRenderOptions"/> that allows configuration of DocxRenderer "Docx to PDF" rendering parameters. </param>
|
|
1921
|
-
<returns>
|
|
1922
|
-
A <see cref="T:IronPdf.PdfDocument"/> with the Docx rendered as its contents.
|
|
1923
|
-
</returns>
|
|
1924
|
-
</member>
|
|
1925
|
-
<member name="M:IronPdf.DocxToPdfRenderer.RenderDocxMailMergeAsPdfAsync``1(System.Collections.Generic.List{``0},System.String,IronPdf.DocxPdfRenderOptions)">
|
|
1926
|
-
<summary>
|
|
1927
|
-
Creates a PDF file from an Word document and returns it as an <see cref="T:IronPdf.PdfDocument"/> object which can be edited and saved to disk or served on a website.
|
|
1928
|
-
<para> Async version of the RenderDocxAsPdf method.</para>
|
|
1929
|
-
</summary>
|
|
1930
|
-
<param name="RecipientsDataList">List of recepient data</param>
|
|
1931
|
-
<param name="WordDocumentPath">The word document full path to be rendered as a PDF.</param>
|
|
1932
|
-
<param name="Options">An instance of <see cref="T:IronPdf.DocxPdfRenderOptions"/> that allows configuration of DocxRenderer "Docx to PDF" rendering parameters. </param>
|
|
1933
|
-
<returns>
|
|
1934
|
-
A <see cref="T:IronPdf.PdfDocument"/> with the Docx rendered as its contents.
|
|
1935
|
-
</returns>
|
|
1936
|
-
</member>
|
|
1937
|
-
<member name="T:IronPdf.DocxPdfRenderOptions">
|
|
1938
|
-
<summary>
|
|
1939
|
-
Margin values which can be copied from the main document to headers and footers applied to the document
|
|
1940
|
-
</summary>
|
|
1941
|
-
<summary>
|
|
1942
|
-
Docx To PDF output options for <see cref="T:IronPdf.DocxToPdfRenderer"/>. Specifies options such as Paper-Size, DPI, Headers and Footers and other Chromium specific browser setup options.
|
|
1943
|
-
</summary>
|
|
1944
|
-
</member>
|
|
1945
|
-
<member name="M:IronPdf.DocxPdfRenderOptions.#ctor">
|
|
1946
|
-
<summary>
|
|
1947
|
-
Default Constructor. Creates a new instance of DocxPdfRenderOptions with default settings.
|
|
1948
|
-
</summary>
|
|
1949
|
-
</member>
|
|
1950
|
-
<member name="P:IronPdf.DocxPdfRenderOptions.CustomPaperHeight">
|
|
1951
|
-
<summary>
|
|
1952
|
-
Custom paper height, in mm
|
|
1953
|
-
</summary>
|
|
1954
|
-
</member>
|
|
1955
|
-
<member name="P:IronPdf.DocxPdfRenderOptions.CustomPaperWidth">
|
|
1956
|
-
<summary>
|
|
1957
|
-
Custom paper width, in mm
|
|
1958
|
-
</summary>
|
|
1959
|
-
</member>
|
|
1960
|
-
<member name="P:IronPdf.DocxPdfRenderOptions.FirstPageNumber">
|
|
1961
|
-
<summary>
|
|
1962
|
-
Method callback to be invoked whenever a browser JavaScript console message becomes available.
|
|
1963
|
-
</summary>
|
|
1149
|
+
<member name="P:IronPdf.DocxPdfRenderOptions.FirstPageNumber">
|
|
1150
|
+
<summary>
|
|
1151
|
+
Method callback to be invoked whenever a browser JavaScript console message becomes available.
|
|
1152
|
+
</summary>
|
|
1964
1153
|
</member>
|
|
1965
1154
|
<member name="P:IronPdf.DocxPdfRenderOptions.GrayScale">
|
|
1966
1155
|
<summary>
|
|
@@ -2149,278 +1338,80 @@
|
|
|
2149
1338
|
Supported characters include: All numeric, alphanumeric, byte/binary, and Japanese kanji.
|
|
2150
1339
|
</summary>
|
|
2151
1340
|
</member>
|
|
2152
|
-
<member name="T:IronPdf.Editing.HorizontalAlignment">
|
|
2153
|
-
<summary>
|
|
2154
|
-
The horizontal alignment relative to the page.
|
|
2155
|
-
</summary>
|
|
2156
|
-
</member>
|
|
2157
|
-
<member name="F:IronPdf.Editing.HorizontalAlignment.Left">
|
|
2158
|
-
<summary>Alignment along the left side of the page.</summary>
|
|
2159
|
-
</member>
|
|
2160
|
-
<member name="F:IronPdf.Editing.HorizontalAlignment.Center">
|
|
2161
|
-
<summary>Alignment along the center of the page.</summary>
|
|
2162
|
-
</member>
|
|
2163
|
-
<member name="F:IronPdf.Editing.HorizontalAlignment.Right">
|
|
2164
|
-
<summary>Alignment along the right side of the page.</summary>
|
|
2165
|
-
</member>
|
|
2166
1341
|
<member name="T:IronPdf.Editing.HtmlStamper">
|
|
2167
1342
|
<summary>
|
|
2168
1343
|
This allows the user to edit an existing PDF by adding an HTML stamp.<div/>
|
|
2169
1344
|
A subclass of <see cref="T:IronPdf.Editing.Stamper"/>. Defines an HTML PDF Stamper. Can be applied with: <see cref="M:IronPdf.PdfDocument.ApplyStamp(IronPdf.Editing.Stamper)"/>
|
|
2170
|
-
<br/><para>To see usage and an example of HtmlStamper, visit: https://ironpdf.com/tutorials/csharp-edit-pdf-complete-tutorial/#stamp-html-onto-a-pdf</para>
|
|
2171
|
-
</summary>
|
|
2172
|
-
</member>
|
|
2173
|
-
<member name="M:IronPdf.Editing.HtmlStamper.#ctor(System.String)">
|
|
2174
|
-
<summary>
|
|
2175
|
-
Initializes a new instance of the <see cref="T:IronPdf.Editing.HtmlStamper"/> class.
|
|
2176
|
-
</summary>
|
|
2177
|
-
<param name="html">The HTML string.</param>
|
|
2178
|
-
</member>
|
|
2179
|
-
<member name="M:IronPdf.Editing.HtmlStamper.#ctor(System.String,System.String)">
|
|
2180
|
-
<summary>
|
|
2181
|
-
Initializes a new instance of the <see cref="T:IronPdf.Editing.HtmlStamper"/> class.
|
|
2182
|
-
</summary>
|
|
2183
|
-
<param name="html">The HTML string.</param>
|
|
2184
|
-
<param name="baseUrlString">The HTML base URL for which references to external CSS, Javascript and Image files will be relative.</param>
|
|
2185
|
-
</member>
|
|
2186
|
-
<member name="M:IronPdf.Editing.HtmlStamper.#ctor(System.String,System.Uri)">
|
|
2187
|
-
<summary>
|
|
2188
|
-
Initializes a new instance of the <see cref="T:IronPdf.Editing.HtmlStamper"/> class.
|
|
2189
|
-
</summary>
|
|
2190
|
-
<param name="html">The HTML string.</param>
|
|
2191
|
-
<param name="baseUrl">The HTML base URL for which references to external CSS, Javascript and Image files will be relative.</param>
|
|
2192
|
-
</member>
|
|
2193
|
-
<member name="M:IronPdf.Editing.HtmlStamper.#ctor">
|
|
2194
|
-
<summary>
|
|
2195
|
-
Initializes a new instance of the <see cref="T:IronPdf.Editing.HtmlStamper"/> class.
|
|
2196
|
-
</summary>
|
|
2197
|
-
</member>
|
|
2198
|
-
<member name="P:IronPdf.Editing.HtmlStamper.HtmlBaseUrl">
|
|
2199
|
-
<summary>
|
|
2200
|
-
The HTML base URL for which references to external CSS, Javascript and Image files will be relative. <para>A
|
|
2201
|
-
trick to make references relative to a your project file is <code>InnerHtmlBaseUrl = new
|
|
2202
|
-
Uri(System.Reflection.Assembly.GetEntryAssembly().Location).AbsoluteUri</code></para>
|
|
2203
|
-
</summary>
|
|
2204
|
-
</member>
|
|
2205
|
-
<member name="P:IronPdf.Editing.HtmlStamper.CssMediaType">
|
|
2206
|
-
<summary>
|
|
2207
|
-
Enables Media="screen" CSS Styles and StyleSheets <para>Note: By setting AllowScreenCss=false, IronPdf
|
|
2208
|
-
renders Stamp from HTML using CSS for media="print" as if printing a web page in a browser print dialog.</para>
|
|
2209
|
-
<para>Default value is PdfCssMediaType.Screen.</para>
|
|
2210
|
-
</summary>
|
|
2211
|
-
</member>
|
|
2212
|
-
<member name="T:IronPdf.Editing.ImageStamper">
|
|
2213
|
-
<summary>
|
|
2214
|
-
This allows the user to edit an existing PDF by adding an image.<div/>
|
|
2215
|
-
A subclass of <see cref="T:IronPdf.Editing.Stamper"/>. Defines an Image PDF Stamper. Can be applied with: <see cref="M:IronPdf.PdfDocument.ApplyStamp(IronPdf.Editing.Stamper)"/>
|
|
2216
|
-
<br/><para>To see usage and an example of ImageStamper, visit: https://ironpdf.com/tutorials/csharp-edit-pdf-complete-tutorial/#stamp-an-image-onto-a-pdf</para>
|
|
2217
|
-
</summary>
|
|
2218
|
-
</member>
|
|
2219
|
-
<member name="M:IronPdf.Editing.ImageStamper.#ctor(System.String)">
|
|
2220
|
-
<summary>
|
|
2221
|
-
Initializes a new instance of the <see cref="T:IronPdf.Editing.ImageStamper"/> class.
|
|
2222
|
-
</summary>
|
|
2223
|
-
<param name="imagePath">The path of the image to be stamped by this stamper</param>
|
|
2224
|
-
</member>
|
|
2225
|
-
<member name="M:IronPdf.Editing.ImageStamper.#ctor(System.Uri)">
|
|
2226
|
-
<summary>
|
|
2227
|
-
Initializes a new instance of the <see cref="T:IronPdf.Editing.ImageStamper"/> class.
|
|
2228
|
-
</summary>
|
|
2229
|
-
<param name="imageUri">The uri of the image to be stamped by this stamper</param>
|
|
2230
|
-
</member>
|
|
2231
|
-
<member name="M:IronPdf.Editing.ImageStamper.#ctor(IronSoftware.Drawing.AnyBitmap)">
|
|
2232
|
-
<summary>
|
|
2233
|
-
Initializes a new instance of the <see cref="T:IronPdf.Editing.ImageStamper"/> class.
|
|
2234
|
-
</summary>
|
|
2235
|
-
<param name="bitmap">The image to be stamped by this stamper</param>
|
|
2236
|
-
</member>
|
|
2237
|
-
<member name="P:IronPdf.Editing.ImageStamper.ImageUri">
|
|
2238
|
-
<summary>
|
|
2239
|
-
The path of the image to be stamped by this stamper
|
|
2240
|
-
</summary>
|
|
2241
|
-
</member>
|
|
2242
|
-
<member name="T:IronPdf.Editing.Length">
|
|
2243
|
-
<summary>
|
|
2244
|
-
Represents a value with a specific measurement unit.
|
|
2245
|
-
</summary>
|
|
2246
|
-
</member>
|
|
2247
|
-
<member name="P:IronPdf.Editing.Length.Value">
|
|
2248
|
-
<summary>
|
|
2249
|
-
Gets or sets the value of this length.
|
|
2250
|
-
</summary>
|
|
2251
|
-
</member>
|
|
2252
|
-
<member name="P:IronPdf.Editing.Length.Unit">
|
|
2253
|
-
<summary>
|
|
2254
|
-
Gets or sets the measurement unit of this length.
|
|
2255
|
-
</summary>
|
|
2256
|
-
</member>
|
|
2257
|
-
<member name="P:IronPdf.Editing.Length.DPI">
|
|
2258
|
-
<summary>
|
|
2259
|
-
Gets or sets the DPI of this length.
|
|
2260
|
-
</summary>
|
|
2261
|
-
</member>
|
|
2262
|
-
<member name="M:IronPdf.Editing.Length.#ctor(System.Double,IronPdf.Editing.MeasurementUnit,System.Int32)">
|
|
2263
|
-
<summary>
|
|
2264
|
-
Initializes a new instance of the Length class with a specified value and measurement unit.
|
|
2265
|
-
</summary>
|
|
2266
|
-
<param name="value">The value of the length in the specified measurement unit. The default value is 0.</param>
|
|
2267
|
-
<param name="unit">The measurement unit of the length. The default value is `MeasurementUnit.Percentage`.</param>
|
|
2268
|
-
<param name="dpi">The DPI of the length. The default value is 96.</param>
|
|
2269
|
-
</member>
|
|
2270
|
-
<member name="M:IronPdf.Editing.Length.ToPoints(System.Nullable{System.Double})">
|
|
2271
|
-
<summary>
|
|
2272
|
-
Converts the `Length` value to points.
|
|
2273
|
-
</summary>
|
|
2274
|
-
<param name="refValue">Reference value (points). Required when Unit is <see cref="F:IronPdf.Editing.MeasurementUnit.Percentage"/></param>
|
|
2275
|
-
<returns>The converted value in points.</returns>
|
|
2276
|
-
</member>
|
|
2277
|
-
<member name="M:IronPdf.Editing.Length.ToMillimeter(System.Nullable{System.Double})">
|
|
2278
|
-
<summary>
|
|
2279
|
-
Converts the `Length` value to millimeters.
|
|
2280
|
-
</summary>
|
|
2281
|
-
<param name="refValue">Reference value (mm). Required when Unit is <see cref="F:IronPdf.Editing.MeasurementUnit.Percentage"/></param>
|
|
2282
|
-
<returns>The converted value in millimeters.</returns>
|
|
2283
|
-
</member>
|
|
2284
|
-
<member name="M:IronPdf.Editing.Length.ToInch(System.Nullable{System.Double})">
|
|
2285
|
-
<summary>
|
|
2286
|
-
Converts the `Length` value to inches.
|
|
2287
|
-
</summary>
|
|
2288
|
-
<param name="refValue">Reference value (inch). Required when Unit is <see cref="F:IronPdf.Editing.MeasurementUnit.Percentage"/></param>
|
|
2289
|
-
<returns>The converted value in inches.</returns>
|
|
2290
|
-
</member>
|
|
2291
|
-
<member name="M:IronPdf.Editing.Length.ToCentimeter(System.Nullable{System.Double})">
|
|
2292
|
-
<summary>
|
|
2293
|
-
Converts the `Length` value to centimeters.
|
|
2294
|
-
</summary>
|
|
2295
|
-
<param name="refValue">Reference value (cm). Required when Unit is <see cref="F:IronPdf.Editing.MeasurementUnit.Percentage"/></param>
|
|
2296
|
-
<returns>The converted value in centimeters.</returns>
|
|
2297
|
-
</member>
|
|
2298
|
-
<member name="M:IronPdf.Editing.Length.ToPixel(System.Nullable{System.Double})">
|
|
2299
|
-
<summary>
|
|
2300
|
-
Converts the `Length` value to pixel.
|
|
2301
|
-
</summary>
|
|
2302
|
-
<param name="refValue">Reference value (pixel). Required when Unit is <see cref="F:IronPdf.Editing.MeasurementUnit.Percentage"/></param>
|
|
2303
|
-
<returns>The converted value in pixel.</returns>
|
|
2304
|
-
</member>
|
|
2305
|
-
<member name="T:IronPdf.Editing.Stamper">
|
|
2306
|
-
<summary>
|
|
2307
|
-
Defines a PDF Stamper. <seealso cref="M:IronPdf.PdfDocument.ApplyStamp(IronPdf.Editing.Stamper)"/>
|
|
2308
|
-
<br/><para>To see a full class walkthrough with diagrams and examples visit: https://ironpdf.com/tutorials/csharp-edit-pdf-complete-tutorial/#stamping-and-watermarking</para>
|
|
2309
|
-
<seealso cref="M:IronPdf.PdfDocument.ApplyStamp(IronPdf.Editing.Stamper)"/>
|
|
2310
|
-
</summary>
|
|
2311
|
-
</member>
|
|
2312
|
-
<member name="P:IronPdf.Editing.Stamper.Html">
|
|
2313
|
-
<summary>
|
|
2314
|
-
The HTML fragment which will be stamped onto your PDF. All external references to JavaScript, CSS, and
|
|
2315
|
-
image files will be relative to <see cref="P:IronPdf.Editing.Stamper.InnerHtmlBaseUrl"/>.
|
|
2316
|
-
</summary>
|
|
2317
|
-
</member>
|
|
2318
|
-
<member name="P:IronPdf.Editing.Stamper.Opacity">
|
|
2319
|
-
<summary>
|
|
2320
|
-
Allows the stamp to be transparent. 0 is fully invisible, 100 if fully opaque.
|
|
2321
|
-
</summary>
|
|
2322
|
-
</member>
|
|
2323
|
-
<member name="P:IronPdf.Editing.Stamper.Rotation">
|
|
2324
|
-
<summary>
|
|
2325
|
-
Rotates the stamp clockwise from 0 to 360 degrees as specified.
|
|
2326
|
-
</summary>
|
|
2327
|
-
</member>
|
|
2328
|
-
<member name="P:IronPdf.Editing.Stamper.HorizontalAlignment">
|
|
2329
|
-
<summary>
|
|
2330
|
-
The horizontal alignment of the stamp relative to the page.
|
|
2331
|
-
<para>Documentation: <a href="https://ironpdf.com/tutorials/csharp-edit-pdf-complete-tutorial/#anchor-stamping-and-watermarking">Stamper layout</a></para>
|
|
2332
|
-
</summary>
|
|
2333
|
-
</member>
|
|
2334
|
-
<member name="P:IronPdf.Editing.Stamper.VerticalAlignment">
|
|
2335
|
-
<summary>
|
|
2336
|
-
The vertical alignment of the stamp relative to the page.
|
|
2337
|
-
<para>Documentation: <a href="https://ironpdf.com/tutorials/csharp-edit-pdf-complete-tutorial/#anchor-stamping-and-watermarking">Stamper layout</a></para>
|
|
2338
|
-
</summary>
|
|
2339
|
-
</member>
|
|
2340
|
-
<member name="P:IronPdf.Editing.Stamper.HorizontalOffset">
|
|
2341
|
-
<summary>
|
|
2342
|
-
<para>The horizontal offset. Default value is 0, and default unit is <see cref="F:IronPdf.Editing.MeasurementUnit.Percentage"/>.</para>
|
|
2343
|
-
Value of 0 has no effect.<div/>
|
|
2344
|
-
Positive indicates an offset to the right direction.<div/>
|
|
2345
|
-
Negative indicates an offset to the left direction.
|
|
2346
|
-
<para>Documentation: <a href="https://ironpdf.com/tutorials/csharp-edit-pdf-complete-tutorial/#anchor-stamping-and-watermarking">Stamper layout</a></para>
|
|
2347
|
-
</summary>
|
|
2348
|
-
</member>
|
|
2349
|
-
<member name="P:IronPdf.Editing.Stamper.VerticalOffset">
|
|
2350
|
-
<summary>
|
|
2351
|
-
<para>The vertical offset. Default value is 0, and default unit is <see cref="F:IronPdf.Editing.MeasurementUnit.Percentage"/>.</para>
|
|
2352
|
-
Value of 0 has no effect.<div/>
|
|
2353
|
-
Positive indicates an offset in the downward direction.<div/>
|
|
2354
|
-
Negative indicates an offset in the upward direction.
|
|
2355
|
-
<para>Documentation: <a href="https://ironpdf.com/tutorials/csharp-edit-pdf-complete-tutorial/#anchor-stamping-and-watermarking">Stamper layout</a></para>
|
|
1345
|
+
<br/><para>To see usage and an example of HtmlStamper, visit: https://ironpdf.com/tutorials/csharp-edit-pdf-complete-tutorial/#stamp-html-onto-a-pdf</para>
|
|
2356
1346
|
</summary>
|
|
2357
1347
|
</member>
|
|
2358
|
-
<member name="
|
|
1348
|
+
<member name="M:IronPdf.Editing.HtmlStamper.#ctor(System.String)">
|
|
2359
1349
|
<summary>
|
|
2360
|
-
|
|
1350
|
+
Initializes a new instance of the <see cref="T:IronPdf.Editing.HtmlStamper"/> class.
|
|
2361
1351
|
</summary>
|
|
1352
|
+
<param name="html">The HTML string.</param>
|
|
2362
1353
|
</member>
|
|
2363
|
-
<member name="
|
|
1354
|
+
<member name="M:IronPdf.Editing.HtmlStamper.#ctor(System.String,System.String)">
|
|
2364
1355
|
<summary>
|
|
2365
|
-
|
|
1356
|
+
Initializes a new instance of the <see cref="T:IronPdf.Editing.HtmlStamper"/> class.
|
|
2366
1357
|
</summary>
|
|
1358
|
+
<param name="html">The HTML string.</param>
|
|
1359
|
+
<param name="baseUrlString">The HTML base URL for which references to external CSS, Javascript and Image files will be relative.</param>
|
|
2367
1360
|
</member>
|
|
2368
|
-
<member name="
|
|
1361
|
+
<member name="M:IronPdf.Editing.HtmlStamper.#ctor(System.String,System.Uri)">
|
|
2369
1362
|
<summary>
|
|
2370
|
-
|
|
1363
|
+
Initializes a new instance of the <see cref="T:IronPdf.Editing.HtmlStamper"/> class.
|
|
2371
1364
|
</summary>
|
|
1365
|
+
<param name="html">The HTML string.</param>
|
|
1366
|
+
<param name="baseUrl">The HTML base URL for which references to external CSS, Javascript and Image files will be relative.</param>
|
|
2372
1367
|
</member>
|
|
2373
|
-
<member name="
|
|
1368
|
+
<member name="M:IronPdf.Editing.HtmlStamper.#ctor">
|
|
2374
1369
|
<summary>
|
|
2375
|
-
|
|
1370
|
+
Initializes a new instance of the <see cref="T:IronPdf.Editing.HtmlStamper"/> class.
|
|
2376
1371
|
</summary>
|
|
2377
1372
|
</member>
|
|
2378
|
-
<member name="P:IronPdf.Editing.
|
|
1373
|
+
<member name="P:IronPdf.Editing.HtmlStamper.HtmlBaseUrl">
|
|
2379
1374
|
<summary>
|
|
2380
1375
|
The HTML base URL for which references to external CSS, Javascript and Image files will be relative. <para>A
|
|
2381
1376
|
trick to make references relative to a your project file is <code>InnerHtmlBaseUrl = new
|
|
2382
1377
|
Uri(System.Reflection.Assembly.GetEntryAssembly().Location).AbsoluteUri</code></para>
|
|
2383
1378
|
</summary>
|
|
2384
1379
|
</member>
|
|
2385
|
-
<member name="P:IronPdf.Editing.
|
|
2386
|
-
<summary>
|
|
2387
|
-
Makes stamped elements of this Stamper have an on-click hyperlink.<div/>
|
|
2388
|
-
Note: HTML links created by <a href=''> tags are not reserved by stamping.
|
|
2389
|
-
</summary>
|
|
2390
|
-
</member>
|
|
2391
|
-
<member name="P:IronPdf.Editing.Stamper.Scale">
|
|
1380
|
+
<member name="P:IronPdf.Editing.HtmlStamper.CssMediaType">
|
|
2392
1381
|
<summary>
|
|
2393
|
-
|
|
2394
|
-
|
|
1382
|
+
Enables Media="screen" CSS Styles and StyleSheets <para>Note: By setting AllowScreenCss=false, IronPdf
|
|
1383
|
+
renders Stamp from HTML using CSS for media="print" as if printing a web page in a browser print dialog.</para>
|
|
1384
|
+
<para>Default value is PdfCssMediaType.Screen.</para>
|
|
2395
1385
|
</summary>
|
|
2396
1386
|
</member>
|
|
2397
|
-
<member name="
|
|
1387
|
+
<member name="T:IronPdf.Editing.ImageStamper">
|
|
2398
1388
|
<summary>
|
|
2399
|
-
|
|
1389
|
+
This allows the user to edit an existing PDF by adding an image.<div/>
|
|
1390
|
+
A subclass of <see cref="T:IronPdf.Editing.Stamper"/>. Defines an Image PDF Stamper. Can be applied with: <see cref="M:IronPdf.PdfDocument.ApplyStamp(IronPdf.Editing.Stamper)"/>
|
|
1391
|
+
<br/><para>To see usage and an example of ImageStamper, visit: https://ironpdf.com/tutorials/csharp-edit-pdf-complete-tutorial/#stamp-an-image-onto-a-pdf</para>
|
|
2400
1392
|
</summary>
|
|
2401
1393
|
</member>
|
|
2402
|
-
<member name="
|
|
1394
|
+
<member name="M:IronPdf.Editing.ImageStamper.#ctor(System.String)">
|
|
2403
1395
|
<summary>
|
|
2404
|
-
|
|
1396
|
+
Initializes a new instance of the <see cref="T:IronPdf.Editing.ImageStamper"/> class.
|
|
2405
1397
|
</summary>
|
|
1398
|
+
<param name="imagePath">The path of the image to be stamped by this stamper</param>
|
|
2406
1399
|
</member>
|
|
2407
|
-
<member name="
|
|
1400
|
+
<member name="M:IronPdf.Editing.ImageStamper.#ctor(System.Uri)">
|
|
2408
1401
|
<summary>
|
|
2409
|
-
|
|
2410
|
-
rendering of JavaScript, Ajax or animations.
|
|
2411
|
-
<para>Default value for HtmlStamper is 100, The other Stamper is 0.</para>
|
|
1402
|
+
Initializes a new instance of the <see cref="T:IronPdf.Editing.ImageStamper"/> class.
|
|
2412
1403
|
</summary>
|
|
1404
|
+
<param name="imageUri">The uri of the image to be stamped by this stamper</param>
|
|
2413
1405
|
</member>
|
|
2414
|
-
<member name="
|
|
1406
|
+
<member name="M:IronPdf.Editing.ImageStamper.#ctor(IronSoftware.Drawing.AnyBitmap)">
|
|
2415
1407
|
<summary>
|
|
2416
|
-
|
|
2417
|
-
<para>Default value is 60.</para>
|
|
1408
|
+
Initializes a new instance of the <see cref="T:IronPdf.Editing.ImageStamper"/> class.
|
|
2418
1409
|
</summary>
|
|
1410
|
+
<param name="bitmap">The image to be stamped by this stamper</param>
|
|
2419
1411
|
</member>
|
|
2420
|
-
<member name="P:IronPdf.Editing.
|
|
1412
|
+
<member name="P:IronPdf.Editing.ImageStamper.ImageUri">
|
|
2421
1413
|
<summary>
|
|
2422
|
-
|
|
2423
|
-
<para>Default is fault.</para>
|
|
1414
|
+
The path of the image to be stamped by this stamper
|
|
2424
1415
|
</summary>
|
|
2425
1416
|
</member>
|
|
2426
1417
|
<member name="T:IronPdf.Editing.StampLayer">
|
|
@@ -2581,20 +1572,6 @@
|
|
|
2581
1572
|
<exception cref="T:System.ArgumentNullException"></exception>
|
|
2582
1573
|
<exception cref="T:System.ArgumentOutOfRangeException"></exception>
|
|
2583
1574
|
</member>
|
|
2584
|
-
<member name="T:IronPdf.Editing.VerticalAlignment">
|
|
2585
|
-
<summary>
|
|
2586
|
-
The vertical alignment relative to the page.
|
|
2587
|
-
</summary>
|
|
2588
|
-
</member>
|
|
2589
|
-
<member name="F:IronPdf.Editing.VerticalAlignment.Top">
|
|
2590
|
-
<summary>The top of the page.</summary>
|
|
2591
|
-
</member>
|
|
2592
|
-
<member name="F:IronPdf.Editing.VerticalAlignment.Middle">
|
|
2593
|
-
<summary>The middle of the page.</summary>
|
|
2594
|
-
</member>
|
|
2595
|
-
<member name="F:IronPdf.Editing.VerticalAlignment.Bottom">
|
|
2596
|
-
<summary>The bottom of the page.</summary>
|
|
2597
|
-
</member>
|
|
2598
1575
|
<member name="T:IronPdf.Editing.WaterMarkLocation">
|
|
2599
1576
|
<exclude/>
|
|
2600
1577
|
</member>
|
|
@@ -2759,14 +1736,14 @@
|
|
|
2759
1736
|
<member name="P:IronPdf.Editing.HtmlStamp.ZIndex">
|
|
2760
1737
|
<exclude/>
|
|
2761
1738
|
</member>
|
|
2762
|
-
<member name="T:IronPdf.Engines.Chrome.
|
|
1739
|
+
<member name="T:IronPdf.Engines.Chrome.ChromeDeployment">
|
|
2763
1740
|
<summary>
|
|
2764
|
-
|
|
1741
|
+
Deployment class for native Pdfium binaries in IronPdf
|
|
2765
1742
|
</summary>
|
|
2766
1743
|
</member>
|
|
2767
|
-
<member name="T:IronPdf.Engines.Chrome.
|
|
1744
|
+
<member name="T:IronPdf.Engines.Chrome.ChromeInjectionModule">
|
|
2768
1745
|
<summary>
|
|
2769
|
-
|
|
1746
|
+
Ninject module for determining which Chrome client to use
|
|
2770
1747
|
</summary>
|
|
2771
1748
|
</member>
|
|
2772
1749
|
<member name="T:IronPdf.Engines.Chrome.ProcessManager">
|
|
@@ -2788,365 +1765,6 @@
|
|
|
2788
1765
|
<param name="name">Process name</param>
|
|
2789
1766
|
<returns>Number of processes killed</returns>
|
|
2790
1767
|
</member>
|
|
2791
|
-
<member name="T:IronPdf.Engines.Chrome.ChromeGpuModes">
|
|
2792
|
-
<summary>
|
|
2793
|
-
Chrome GPU hardware utilization when rendering HTML to PDF
|
|
2794
|
-
</summary>
|
|
2795
|
-
</member>
|
|
2796
|
-
<member name="F:IronPdf.Engines.Chrome.ChromeGpuModes.Disabled">
|
|
2797
|
-
<summary>
|
|
2798
|
-
Disable GPU hardware utilization
|
|
2799
|
-
</summary>
|
|
2800
|
-
</member>
|
|
2801
|
-
<member name="F:IronPdf.Engines.Chrome.ChromeGpuModes.Software">
|
|
2802
|
-
<summary>
|
|
2803
|
-
Enable software acceleration
|
|
2804
|
-
</summary>
|
|
2805
|
-
</member>
|
|
2806
|
-
<member name="F:IronPdf.Engines.Chrome.ChromeGpuModes.Hardware">
|
|
2807
|
-
<summary>
|
|
2808
|
-
Enable hardware acceleration
|
|
2809
|
-
</summary>
|
|
2810
|
-
</member>
|
|
2811
|
-
<member name="F:IronPdf.Engines.Chrome.ChromeGpuModes.HardwareFull">
|
|
2812
|
-
<summary>
|
|
2813
|
-
Enable hardware acceleration with Vulkan features
|
|
2814
|
-
</summary>
|
|
2815
|
-
</member>
|
|
2816
|
-
<member name="T:IronPdf.Engines.Chrome.FitToPaperModes">
|
|
2817
|
-
<exclude/>
|
|
2818
|
-
</member>
|
|
2819
|
-
<member name="F:IronPdf.Engines.Chrome.FitToPaperModes.None">
|
|
2820
|
-
<summary>
|
|
2821
|
-
Default Chrome PDF printing behavior. Uses <see cref="P:IronPdf.ChromePdfRenderOptions.Zoom"/> to specify zoom level.
|
|
2822
|
-
<para><see cref="P:IronPdf.ChromePdfRenderOptions.ViewPortWidth"/> has no effect.
|
|
2823
|
-
Instead, Chrome will automatically set the view port based on <see cref="P:IronPdf.ChromePdfRenderOptions.PaperSize"/>.</para>
|
|
2824
|
-
Use <see cref="P:IronPdf.ChromePdfRenderOptions.CssMediaType"/> to specify CSS media style.
|
|
2825
|
-
</summary>
|
|
2826
|
-
<remarks>Useful when using 'print' CSS media style or printing documents to match the Chrome browser print preview.</remarks>
|
|
2827
|
-
</member>
|
|
2828
|
-
<member name="F:IronPdf.Engines.Chrome.FitToPaperModes.Zoom">
|
|
2829
|
-
<summary>
|
|
2830
|
-
Default Chrome PDF printing behavior. Uses <see cref="P:IronPdf.ChromePdfRenderOptions.Zoom"/> to specify zoom level.
|
|
2831
|
-
<para><see cref="P:IronPdf.ChromePdfRenderOptions.ViewPortWidth"/> has no effect.
|
|
2832
|
-
Instead, Chrome will automatically set the view port based on <see cref="P:IronPdf.ChromePdfRenderOptions.PaperSize"/>.</para>
|
|
2833
|
-
Use <see cref="P:IronPdf.ChromePdfRenderOptions.CssMediaType"/> to specify CSS media style.
|
|
2834
|
-
</summary>
|
|
2835
|
-
<remarks>Useful when using 'print' CSS media style or printing documents to match the Chrome browser print preview.</remarks>
|
|
2836
|
-
</member>
|
|
2837
|
-
<member name="F:IronPdf.Engines.Chrome.FitToPaperModes.FixedPixelWidth">
|
|
2838
|
-
<summary>
|
|
2839
|
-
Fit an exact number of pixels onto each PDF page.
|
|
2840
|
-
<para>Uses <see cref="P:IronPdf.ChromePdfRenderOptions.ViewPortWidth"/> to specify the pixel width to fit on each PDF page.</para>
|
|
2841
|
-
<para><see cref="P:IronPdf.ChromePdfRenderOptions.Zoom"/> has no effect. Instead, IronPdf will calculate the zoom level based on
|
|
2842
|
-
<see cref="P:IronPdf.ChromePdfRenderOptions.ViewPortWidth"/> and <see cref="P:IronPdf.ChromePdfRenderOptions.PaperSize"/></para>
|
|
2843
|
-
</summary>
|
|
2844
|
-
<remarks>Useful when an optimal pixel width is known or printing documents to match a Chrome browser window display</remarks>
|
|
2845
|
-
</member>
|
|
2846
|
-
<member name="F:IronPdf.Engines.Chrome.FitToPaperModes.Automatic">
|
|
2847
|
-
<summary>
|
|
2848
|
-
Measures minimum HTML content width after it is rendered by the browser and calculates <see cref="P:IronPdf.ChromePdfRenderOptions.Zoom"/>
|
|
2849
|
-
based on the width of the content.
|
|
2850
|
-
<para><see cref="P:IronPdf.ChromePdfRenderOptions.Zoom"/> and <see cref="P:IronPdf.ChromePdfRenderOptions.ViewPortWidth"/> have no effect and are calculated automatically by IronPdf.</para>
|
|
2851
|
-
</summary>
|
|
2852
|
-
<remarks>Useful when fitting a wide content or content of unknown width onto a PDF page</remarks>
|
|
2853
|
-
</member>
|
|
2854
|
-
<member name="F:IronPdf.Engines.Chrome.FitToPaperModes.AutomaticFit">
|
|
2855
|
-
<summary>
|
|
2856
|
-
Measures minimum HTML content width after it is rendered by the browser using the smallest view port possible, and calculates
|
|
2857
|
-
<see cref="P:IronPdf.ChromePdfRenderOptions.Zoom"/> based on the width of the content.
|
|
2858
|
-
<para>Use <see cref="P:IronPdf.ChromePdfRenderOptions.ViewPortWidth"/> to specify the minimum number of pixels to be fit on each PDF page.</para>
|
|
2859
|
-
<para><see cref="P:IronPdf.ChromePdfRenderOptions.Zoom"/> has no effect and is calculated automatically by IronPdf.</para>
|
|
2860
|
-
</summary>
|
|
2861
|
-
<remarks>Useful when fitting smaller content onto a wide page</remarks>
|
|
2862
|
-
</member>
|
|
2863
|
-
<member name="F:IronPdf.Engines.Chrome.FitToPaperModes.ContinuousFeed">
|
|
2864
|
-
<summary>
|
|
2865
|
-
Creates a single page PDF which will force its entire content's width and height to fit into one page. Can be used for a consumer bill or receipt.
|
|
2866
|
-
</summary>
|
|
2867
|
-
<remarks>Useful when printing bill or receipt</remarks>
|
|
2868
|
-
</member>
|
|
2869
|
-
<member name="T:IronPdf.Engines.Chrome.WaitForType">
|
|
2870
|
-
<summary>
|
|
2871
|
-
Type of wait-for for the user to have a chance to control when to commit rendering.
|
|
2872
|
-
</summary>
|
|
2873
|
-
</member>
|
|
2874
|
-
<member name="F:IronPdf.Engines.Chrome.WaitForType.None">
|
|
2875
|
-
<summary>
|
|
2876
|
-
Default type, no condition, no special need to do anything prior to rendering.
|
|
2877
|
-
</summary>
|
|
2878
|
-
</member>
|
|
2879
|
-
<member name="F:IronPdf.Engines.Chrome.WaitForType.ManualTrigger">
|
|
2880
|
-
<summary>
|
|
2881
|
-
This mode will wait until user calls internal IronPdf's JavaScript function <code>window.ironpdf.notifyRender()</code> that will trigger the rendering.
|
|
2882
|
-
</summary>
|
|
2883
|
-
</member>
|
|
2884
|
-
<member name="F:IronPdf.Engines.Chrome.WaitForType.RenderDelay">
|
|
2885
|
-
<summary>
|
|
2886
|
-
This mode will delay for specified amount of time before begin rendering.
|
|
2887
|
-
This option supercedes <see cref="P:IronPdf.ChromePdfRenderOptions.RenderDelay"/>
|
|
2888
|
-
</summary>
|
|
2889
|
-
</member>
|
|
2890
|
-
<member name="F:IronPdf.Engines.Chrome.WaitForType.NetworkIdle0">
|
|
2891
|
-
<summary>
|
|
2892
|
-
This mode will begin rendering when there is no new network request for 500ms as well as no inflight (outstanding) network requests.
|
|
2893
|
-
</summary>
|
|
2894
|
-
<remarks>This mode is suitable for SPA (Single-Page Application) or web page that that doesn't have any on-going long polling network request.</remarks>
|
|
2895
|
-
</member>
|
|
2896
|
-
<member name="F:IronPdf.Engines.Chrome.WaitForType.NetworkIdle2">
|
|
2897
|
-
<summary>
|
|
2898
|
-
This mode will begin rendering when there is no new network request for 500ms but allowed to have no more than 2 inflight (outstanding)
|
|
2899
|
-
network requests.
|
|
2900
|
-
</summary>
|
|
2901
|
-
<remarks>This mode is suitable for web application or web page that has on-going long-polling or heartbeart ping request.</remarks>
|
|
2902
|
-
</member>
|
|
2903
|
-
<member name="F:IronPdf.Engines.Chrome.WaitForType.NetworkIdleN">
|
|
2904
|
-
<summary>
|
|
2905
|
-
This mode will begin rendering when there is no new network request as per specified by user according to networkidle duration (in millisecond),
|
|
2906
|
-
and number of maximum allowed inflight (oustanding) network requests.
|
|
2907
|
-
</summary>
|
|
2908
|
-
<remarks>This mode is suitable for customized type of web application or web page as per user's requirement that doesn't fit by using
|
|
2909
|
-
<list type="bullet">
|
|
2910
|
-
<item><see cref="F:IronPdf.Engines.Chrome.WaitForType.NetworkIdle0"/></item>
|
|
2911
|
-
<item><see cref="F:IronPdf.Engines.Chrome.WaitForType.NetworkIdle2"/></item>
|
|
2912
|
-
</list></remarks>
|
|
2913
|
-
</member>
|
|
2914
|
-
<member name="F:IronPdf.Engines.Chrome.WaitForType.HtmlElement">
|
|
2915
|
-
<summary>
|
|
2916
|
-
This mode will begin rendering when the specified HTML element becomes existent.
|
|
2917
|
-
</summary>
|
|
2918
|
-
</member>
|
|
2919
|
-
<member name="F:IronPdf.Engines.Chrome.WaitForType.AllFontsLoaded">
|
|
2920
|
-
<summary>
|
|
2921
|
-
This mode will begin rendering after all fonts have been loaded; be it local, remote, or google web fonts.
|
|
2922
|
-
</summary>
|
|
2923
|
-
</member>
|
|
2924
|
-
<member name="T:IronPdf.Engines.Chrome.Internal.HtmlValidator">
|
|
2925
|
-
<summary>
|
|
2926
|
-
A simple HTML related validator.
|
|
2927
|
-
</summary>
|
|
2928
|
-
</member>
|
|
2929
|
-
<member name="M:IronPdf.Engines.Chrome.Internal.HtmlValidator.ValidateHtmlNameAndIdToken(System.String)">
|
|
2930
|
-
<summary>
|
|
2931
|
-
Validate whether the specified HTML name or id is valid according to the following rule.
|
|
2932
|
-
<para>Name or ID token begins with a letter ([A-Za-z]), and maybe followed by any number of letters, digits ([0-9]), hyphens ("-"), underscores ("_"), colons (":"), and periods (".").</para>
|
|
2933
|
-
</summary>
|
|
2934
|
-
<param name="nameOrId">Name of Id to validate according to HTML's Name and Id naming rule.</param>
|
|
2935
|
-
<returns>Return true if the specified name or Id is valid, otherwise return false.</returns>
|
|
2936
|
-
</member>
|
|
2937
|
-
<member name="M:IronPdf.Engines.Chrome.Internal.HtmlValidator.ValidateHtmlClassAttribName(System.String)">
|
|
2938
|
-
<summary>
|
|
2939
|
-
Validate whether the specified HTML class attribute name is valid according to the following rule.
|
|
2940
|
-
<para>Name or ID token begins with a letter ([A-Za-z]), and maybe followed by any number of letters, digits ([0-9]), hyphens ("-"), and underscores ("_").</para>
|
|
2941
|
-
</summary>
|
|
2942
|
-
<param name="classAttribName">Class attribute name to validate according to HTML's class attribute name naming rule.</param>
|
|
2943
|
-
<returns>Return true if the specified class attribute name is valid, otherwise return false.</returns>
|
|
2944
|
-
</member>
|
|
2945
|
-
<member name="T:IronPdf.Engines.Chrome.WaitFor">
|
|
2946
|
-
<summary>
|
|
2947
|
-
A managed wrapper of wait-for configurations.
|
|
2948
|
-
It also provides factory methods to set all related configurations as per desire waitfor type.
|
|
2949
|
-
</summary>
|
|
2950
|
-
</member>
|
|
2951
|
-
<member name="F:IronPdf.Engines.Chrome.WaitFor.DefaultMaxWaitTime">
|
|
2952
|
-
<summary>
|
|
2953
|
-
Default maximum wait time in milliseconds
|
|
2954
|
-
</summary>
|
|
2955
|
-
</member>
|
|
2956
|
-
<member name="F:IronPdf.Engines.Chrome.WaitFor.DefaultRenderDelayDuration">
|
|
2957
|
-
<summary>
|
|
2958
|
-
Default render delay duration in milliseconds.
|
|
2959
|
-
</summary>
|
|
2960
|
-
</member>
|
|
2961
|
-
<member name="P:IronPdf.Engines.Chrome.WaitFor.Type">
|
|
2962
|
-
<summary>
|
|
2963
|
-
Get type of wait-for.
|
|
2964
|
-
</summary>
|
|
2965
|
-
<remarks>Read-only, its value is meant to be set via factory method this class provides.</remarks>
|
|
2966
|
-
</member>
|
|
2967
|
-
<member name="P:IronPdf.Engines.Chrome.WaitFor.Timeout">
|
|
2968
|
-
<summary>
|
|
2969
|
-
Get timeout duration in milliseconds.
|
|
2970
|
-
</summary>
|
|
2971
|
-
<remarks>Read-only, its value is meant to be set via factory method this class provides.</remarks>
|
|
2972
|
-
</member>
|
|
2973
|
-
<member name="P:IronPdf.Engines.Chrome.WaitFor.NetworkIdleDuration">
|
|
2974
|
-
<summary>
|
|
2975
|
-
Get network idle duration in milliseconds to be regarded as part of network idle event.
|
|
2976
|
-
</summary>
|
|
2977
|
-
<remarks>Read-only, its value is meant to be set via factory method this class provides.</remarks>
|
|
2978
|
-
</member>
|
|
2979
|
-
<member name="P:IronPdf.Engines.Chrome.WaitFor.NumAllowedInFlight">
|
|
2980
|
-
<summary>
|
|
2981
|
-
Get number of allowed inflight network request to be regarded as part of network idle event.
|
|
2982
|
-
</summary>
|
|
2983
|
-
<remarks>Read-only, its value is meant to be set via factory method this class provides.</remarks>
|
|
2984
|
-
</member>
|
|
2985
|
-
<member name="P:IronPdf.Engines.Chrome.WaitFor.RenderDelayDuration">
|
|
2986
|
-
<summary>
|
|
2987
|
-
Get amount of delay in milliseconds before rendering.
|
|
2988
|
-
</summary>
|
|
2989
|
-
<remarks>Read-only, its value is meant to be set via factory method this class provides.</remarks>
|
|
2990
|
-
</member>
|
|
2991
|
-
<member name="P:IronPdf.Engines.Chrome.WaitFor.HtmlElementQueryStr">
|
|
2992
|
-
<summary>
|
|
2993
|
-
Get HTML element query string.
|
|
2994
|
-
</summary>
|
|
2995
|
-
</member>
|
|
2996
|
-
<member name="M:IronPdf.Engines.Chrome.WaitFor.#ctor(System.Int32,System.Int32)">
|
|
2997
|
-
<summary>
|
|
2998
|
-
Default construct WaitFor object.
|
|
2999
|
-
Convenient method to construct a WaitFor object with default values.
|
|
3000
|
-
</summary>
|
|
3001
|
-
<param name="maxWaitTime">Maximum wait time in milliseconds until it forces rendering. Default value is <see cref="F:IronPdf.Engines.Chrome.WaitFor.DefaultMaxWaitTime"/></param>
|
|
3002
|
-
<param name="renderDelay">Render delay in milliseconds. It will delay before rendering. Default value is <see cref="F:IronPdf.Engines.Chrome.WaitFor.DefaultRenderDelayDuration"/></param>
|
|
3003
|
-
<remarks>This will set to<see cref="F:IronPdf.Engines.Chrome.WaitForType.RenderDelay"/>.</remarks>
|
|
3004
|
-
</member>
|
|
3005
|
-
<member name="M:IronPdf.Engines.Chrome.WaitFor.#ctor(IronPdf.Engines.Chrome.WaitForType,System.Int32,System.Int32,System.Int32,System.Int32,System.String)">
|
|
3006
|
-
<summary>
|
|
3007
|
-
Intended to be used internally as our API recommends user to use convenient methods e.g. <see cref="M:IronPdf.Engines.Chrome.WaitFor.JavaScript(System.Int32)"/>,
|
|
3008
|
-
<see cref="M:IronPdf.Engines.Chrome.WaitFor.NetworkIdle0(System.Int32)"/> and others to construct the WaitFor object instead of manually setting each data fields.
|
|
3009
|
-
</summary>
|
|
3010
|
-
<remarks>We use this internally as part of parsing ProtoBuf structure.</remarks>
|
|
3011
|
-
<param name="type">WaitFor type</param>
|
|
3012
|
-
<param name="maxWaitTime">Maximum wait time in milliseconds until it forces rendering.</param>
|
|
3013
|
-
<param name="networkIdleDuration">Network idle duration to be regarded as network idle event.</param>
|
|
3014
|
-
<param name="numAllowedInflight">Number of inflight network request allowed to have while still regarded it as network idle event.</param>
|
|
3015
|
-
<param name="renderDelayDuration">Amount of time to delay before rendering (in ms)</param>
|
|
3016
|
-
<param name="htmlElementQueryStr">HTML element query string that will be passed to JavaScript's document.querySelector().</param>
|
|
3017
|
-
</member>
|
|
3018
|
-
<member name="M:IronPdf.Engines.Chrome.WaitFor.PageLoad">
|
|
3019
|
-
<summary>
|
|
3020
|
-
Basically it waits for nothing, but will render as soon as the page loaded.
|
|
3021
|
-
<para>There is no need to call this method if user desires to normally render the page. It is mostly useful to reset WaitFor configurations back to wait for nothing.</para>
|
|
3022
|
-
<remarks>Page loaded in this case means only loaded in DOM, not the resource loaded.</remarks>
|
|
3023
|
-
</summary>
|
|
3024
|
-
</member>
|
|
3025
|
-
<member name="M:IronPdf.Engines.Chrome.WaitFor.RenderDelay(System.Int32)">
|
|
3026
|
-
<summary>
|
|
3027
|
-
This method proceeds rendering by introducing an initial delay before rendering.
|
|
3028
|
-
</summary>
|
|
3029
|
-
<param name="delay">Delay time in milliseconds before rendering</param>
|
|
3030
|
-
</member>
|
|
3031
|
-
<member name="M:IronPdf.Engines.Chrome.WaitFor.JavaScript(System.Int32)">
|
|
3032
|
-
<summary>
|
|
3033
|
-
This method proceeds rendering by waiting until user calls IronPdf's internal JavaScript function <code>window.ironpdf.notifyRender()</code>.
|
|
3034
|
-
</summary>
|
|
3035
|
-
<param name="maxWaitTime">Maximum wait time in milliseconds until it forces rendering. Default value is <see cref="F:IronPdf.Engines.Chrome.WaitFor.DefaultMaxWaitTime"/></param>
|
|
3036
|
-
</member>
|
|
3037
|
-
<member name="M:IronPdf.Engines.Chrome.WaitFor.NetworkIdle0(System.Int32)">
|
|
3038
|
-
<summary>
|
|
3039
|
-
This method proceeds rendering by waiting until it internally detects a network idle event when there is no network activity.
|
|
3040
|
-
after at least 500ms as well as no inflight (outstanding) network requests.
|
|
3041
|
-
</summary>
|
|
3042
|
-
<param name="maxWaitTime">Maximum wait time in milliseconds until it forces rendering. Default value is <see cref="F:IronPdf.Engines.Chrome.WaitFor.DefaultMaxWaitTime"/></param>
|
|
3043
|
-
</member>
|
|
3044
|
-
<member name="M:IronPdf.Engines.Chrome.WaitFor.NetworkIdle2(System.Int32)">
|
|
3045
|
-
<summary>
|
|
3046
|
-
This method proceeds rendering by waiting until it internally detects a network idle event when there is no network activity
|
|
3047
|
-
after at least 500ms as well as at maximum of 2 inflight (outstanding) network request.
|
|
3048
|
-
</summary>
|
|
3049
|
-
<param name="maxWaitTime">Maximum wait time in milliseconds until it forces rendering. Default value is <see cref="F:IronPdf.Engines.Chrome.WaitFor.DefaultMaxWaitTime"/></param>
|
|
3050
|
-
</member>
|
|
3051
|
-
<member name="M:IronPdf.Engines.Chrome.WaitFor.NetworkIdle(System.Int32,System.Int32,System.Int32)">
|
|
3052
|
-
<summary>
|
|
3053
|
-
This method proceeds rendering by waiting until it internally detects a network idle event when there is no network activity
|
|
3054
|
-
after at least specified <em>networkIdleDuration</em> as well as at maximum of <em>maxNumAllowedInflight</em> inflight (outstanding) network requests.
|
|
3055
|
-
</summary>
|
|
3056
|
-
<param name="networkIdleDuration">Duration of time in milliseconds to regard as network idle event</param>
|
|
3057
|
-
<param name="maxNumAllowedInflight">Maximum number of allowed inflight network requests to not invalidate network idle event</param>
|
|
3058
|
-
<param name="maxWaitTime">Maximum wait time in milliseconds until it forces rendering. Default value is <see cref="F:IronPdf.Engines.Chrome.WaitFor.DefaultMaxWaitTime"/></param>
|
|
3059
|
-
</member>
|
|
3060
|
-
<member name="M:IronPdf.Engines.Chrome.WaitFor.HtmlQuerySelector(System.String,System.Int32)">
|
|
3061
|
-
<summary>
|
|
3062
|
-
This method proceeds rendering by waiting until it finds the HTML element via the specified query string which is executed by a JavaScript function <code>document.querySelector()</code>.
|
|
3063
|
-
<para><a href='https://developer.mozilla.org/en-US/docs/Web/API/Document/querySelector'>Read querySelector() documentation</a>.</para>
|
|
3064
|
-
</summary>
|
|
3065
|
-
<param name="htmlQueryStr">HTML element query string to query for with Javascript's document.querySelector()</param>
|
|
3066
|
-
<param name="maxWaitTime">Maximum wait time (in ms) until it forces rendering. Default is <see cref="F:IronPdf.Engines.Chrome.WaitFor.DefaultMaxWaitTime"/>.</param>
|
|
3067
|
-
</member>
|
|
3068
|
-
<member name="M:IronPdf.Engines.Chrome.WaitFor.HtmlElementById(System.String,System.Int32)">
|
|
3069
|
-
<summary>
|
|
3070
|
-
This method proceeds rendering by waiting until it finds the HTML element that has the same id as specified one.
|
|
3071
|
-
<para>Related JavaScript API that works similarly to this method is <a href="https://developer.mozilla.org/en-US/docs/Web/API/Document/getElementById">getElementById()</a>
|
|
3072
|
-
but instead it makes a query directly via <code>document.querySelector()</code> as it calls <see cref="M:IronPdf.Engines.Chrome.WaitFor.HtmlQuerySelector(System.String,System.Int32)"/> internally.</para>
|
|
3073
|
-
</summary>
|
|
3074
|
-
<exception cref="T:IronSoftware.Exceptions.IronPdfInputException">Thrown if input id is invalid not according to HTML name and Id naming rule.</exception>
|
|
3075
|
-
<param name="id">Target element Id. Id token must begin with a letter ([A-Za-z]) and may be followed by any number of letters, digits ([0-9]), hyphens ("-"), underscores ("_"), colons (":"), and periods (".").</param>
|
|
3076
|
-
<param name="maxWaitTime">Maximum wait time (in ms) until it forces rendering. Default is <see cref="F:IronPdf.Engines.Chrome.WaitFor.DefaultMaxWaitTime"/>.</param>
|
|
3077
|
-
</member>
|
|
3078
|
-
<member name="M:IronPdf.Engines.Chrome.WaitFor.HtmlElementByName(System.String,System.Int32)">
|
|
3079
|
-
<summary>
|
|
3080
|
-
This method proceeds rendering by waiting until it finds the element with the attribute name as of the specified one.
|
|
3081
|
-
<para>Related JavaScript API that works similarly to this method is <a href="https://developer.mozilla.org/en-US/docs/Web/API/Document/getElementsByName">getElementsByName()</a>
|
|
3082
|
-
but effective only for first found element from the result. Instead it makes a query directly via <code>document.querySelector()</code> as it calls <see cref="M:IronPdf.Engines.Chrome.WaitFor.HtmlQuerySelector(System.String,System.Int32)"/> internally.</para>
|
|
3083
|
-
</summary>
|
|
3084
|
-
<exception cref="T:IronSoftware.Exceptions.IronPdfInputException">Thrown if input name is invalid not according to HTML name and Id naming rule.</exception>
|
|
3085
|
-
<param name="name">Target element name. Name token must begin with a letter ([A-Za-z]) and may be followed by any number of letters, digits ([0-9]), hyphens ("-"), underscores ("_"), colons (":"), and periods (".").</param>
|
|
3086
|
-
<param name="maxWaitTime">Maximum wait time (in ms) until it forces rendering. Default is <see cref="F:IronPdf.Engines.Chrome.WaitFor.DefaultMaxWaitTime"/>.</param>
|
|
3087
|
-
</member>
|
|
3088
|
-
<member name="M:IronPdf.Engines.Chrome.WaitFor.HtmlElementByTagName(System.String,System.Int32)">
|
|
3089
|
-
<summary>
|
|
3090
|
-
This method proceeds rendering by waiting until it finds the HTML element that itself has the same tag name as of specified one.
|
|
3091
|
-
<para>Related JavaScript API that works similarly to this method is <a href="https://developer.mozilla.org/en-US/docs/Web/API/Element/getElementsByTagName">getElementsByTagName()</a>
|
|
3092
|
-
but effective only for first found element from the result. Instead it makes a query directly via <code>document.querySelector()</code> as it calls <see cref="M:IronPdf.Engines.Chrome.WaitFor.HtmlQuerySelector(System.String,System.Int32)"/> internally.</para>
|
|
3093
|
-
</summary>
|
|
3094
|
-
<exception cref="T:IronSoftware.Exceptions.IronPdfInputException">Thrown if input name is invalid not according to HTML name and Id naming rule.</exception>
|
|
3095
|
-
<param name="tagName">Target element's tag name. Tag name token must begin with a letter ([A-Za-z]) and may be followed by any number of letters, digits ([0-9]), hyphens ("-"), underscores ("_"), colons (":"), and periods (".").</param>
|
|
3096
|
-
<param name="maxWaitTime">Maximum wait time (in ms) until it forces rendering. Default is <see cref="F:IronPdf.Engines.Chrome.WaitFor.DefaultMaxWaitTime"/>.</param>
|
|
3097
|
-
</member>
|
|
3098
|
-
<member name="M:IronPdf.Engines.Chrome.WaitFor.HtmlElementByClassName(System.String,System.Int32)">
|
|
3099
|
-
<summary>
|
|
3100
|
-
This method proceeds rendering by waiting until it finds the HTML element whose the class name as of the specified one.
|
|
3101
|
-
<para>Related JavaScript API that works similarly to this method is <a href="https://developer.mozilla.org/en-US/docs/Web/API/Element/getElementsByClassName">getElementsByClassName()</a>
|
|
3102
|
-
but effective only for first found element from the result. Instead it makes a query directly via <code>document.querySelector()</code> as it calls <see cref="M:IronPdf.Engines.Chrome.WaitFor.HtmlQuerySelector(System.String,System.Int32)"/> internally.</para>
|
|
3103
|
-
</summary>
|
|
3104
|
-
<exception cref="T:IronSoftware.Exceptions.IronPdfInputException">Thrown if input name is invalid not according to HTML name and Id naming rule.</exception>
|
|
3105
|
-
<param name="classAttribName">Target element's class attribute name. Class attribute name token must begin with a letter ([A-Za-z]) and may be followed by any number of letters, digits ([0-9]), hyphens ("-"), and underscores ("_").</param>
|
|
3106
|
-
<param name="maxWaitTime">Maximum wait time (in ms) until it forces rendering. Default is <see cref="F:IronPdf.Engines.Chrome.WaitFor.DefaultMaxWaitTime"/>.</param>
|
|
3107
|
-
</member>
|
|
3108
|
-
<member name="M:IronPdf.Engines.Chrome.WaitFor.AllFontsLoaded(System.Int32)">
|
|
3109
|
-
<summary>
|
|
3110
|
-
This method proceeds rendering by waiting until all of its fonts have been loaded. Such font types can local, remote, or google web fonts.
|
|
3111
|
-
</summary>
|
|
3112
|
-
<param name="maxWaitTime">maximum wait time (in ms) until it forces rendering. Default is <see cref="F:IronPdf.Engines.Chrome.WaitFor.DefaultMaxWaitTime"/>.</param>
|
|
3113
|
-
</member>
|
|
3114
|
-
<member name="T:IronPdf.Engines.Chrome.CefBrowserSettings.InteropStruct">
|
|
3115
|
-
<summary>
|
|
3116
|
-
Cef browser settings struct
|
|
3117
|
-
</summary>
|
|
3118
|
-
<remarks>Layout must match C++ counterpart</remarks>
|
|
3119
|
-
</member>
|
|
3120
|
-
<member name="M:IronPdf.Engines.Chrome.CefRenderSettings.TranslateMarginType(System.String)">
|
|
3121
|
-
<summary>
|
|
3122
|
-
Translate a margin type string into an enum value
|
|
3123
|
-
</summary>
|
|
3124
|
-
<param name="type">Margin type string</param>
|
|
3125
|
-
<returns>Equivalent enum value</returns>
|
|
3126
|
-
</member>
|
|
3127
|
-
<member name="P:IronPdf.Engines.Chrome.CefRenderSettings.EnableEmulateScreenMediaType">
|
|
3128
|
-
<summary>
|
|
3129
|
-
Enable emulation of "screen" css media type
|
|
3130
|
-
</summary>
|
|
3131
|
-
</member>
|
|
3132
|
-
<member name="P:IronPdf.Engines.Chrome.CefRenderSettings.EnableLandscapeOrientation">
|
|
3133
|
-
<summary>
|
|
3134
|
-
Enable landscape orientation
|
|
3135
|
-
</summary>
|
|
3136
|
-
</member>
|
|
3137
|
-
<member name="P:IronPdf.Engines.Chrome.CefRenderSettings.MaxHeaderHeight">
|
|
3138
|
-
<summary>
|
|
3139
|
-
Max header height in pixels
|
|
3140
|
-
</summary>
|
|
3141
|
-
</member>
|
|
3142
|
-
<member name="P:IronPdf.Engines.Chrome.CefRenderSettings.MaxFooterHeight">
|
|
3143
|
-
<summary>
|
|
3144
|
-
Max footer height in pixels
|
|
3145
|
-
</summary>
|
|
3146
|
-
</member>
|
|
3147
|
-
<member name="M:IronPdf.Engines.Chrome.CefRenderSettings.GetPointer">
|
|
3148
|
-
<exclude/>
|
|
3149
|
-
</member>
|
|
3150
1768
|
<member name="T:IronPdf.Engines.Chrome.GrpcChromeClient">
|
|
3151
1769
|
<summary>
|
|
3152
1770
|
Chrome client implementation which facilitates requests with a remote server via gRPC
|
|
@@ -3157,91 +1775,6 @@
|
|
|
3157
1775
|
Create a new gRPC Chrome client
|
|
3158
1776
|
</summary>
|
|
3159
1777
|
</member>
|
|
3160
|
-
<member name="T:IronPdf.Engines.Chrome.IChromeClient">
|
|
3161
|
-
<summary>
|
|
3162
|
-
Chrome-related functionality definitions
|
|
3163
|
-
</summary>
|
|
3164
|
-
<remarks>Should contain any functionality directly related to Chrome, and should NOT contain functionality related to Pdfium</remarks>
|
|
3165
|
-
</member>
|
|
3166
|
-
<member name="T:IronPdf.Engines.Chrome.LocalChromeClient">
|
|
3167
|
-
<summary>
|
|
3168
|
-
Chrome client implementation which uses interop to satisfy functionality using native code
|
|
3169
|
-
</summary>
|
|
3170
|
-
<remarks>All HTML-to-PDF related logic should go here</remarks>
|
|
3171
|
-
</member>
|
|
3172
|
-
<member name="M:IronPdf.Engines.Chrome.LocalChromeClient.#ctor">
|
|
3173
|
-
<summary>
|
|
3174
|
-
Create a new local chrome client
|
|
3175
|
-
</summary>
|
|
3176
|
-
</member>
|
|
3177
|
-
<member name="M:IronPdf.Engines.Chrome.LocalChromeClient.MeasureHTML(System.String,System.Uri,System.String,IronPdf.ChromePdfRenderOptions)">
|
|
3178
|
-
<summary>
|
|
3179
|
-
Measure the size of an HTML fragment.
|
|
3180
|
-
</summary>
|
|
3181
|
-
<param name="html">The HTML fragment to measure.</param>
|
|
3182
|
-
<param name="baseUrl">Optional: a base URL.</param>
|
|
3183
|
-
<param name="proxy">Optional: a proxy.</param>
|
|
3184
|
-
<param name="renderOptions">Render options to use when rendering the HTML fragment.</param>
|
|
3185
|
-
<returns>The size of the HTML fragment.</returns>
|
|
3186
|
-
</member>
|
|
3187
|
-
<member name="M:IronPdf.Engines.Chrome.LocalChromeClient.TrySubprocess(System.String)">
|
|
3188
|
-
<summary>
|
|
3189
|
-
Try to access CEF subprocess executable
|
|
3190
|
-
</summary>
|
|
3191
|
-
<param name="path">Subprocess executable path</param>
|
|
3192
|
-
<returns>True if the subprocess can be successfully executed, false otherwise</returns>
|
|
3193
|
-
</member>
|
|
3194
|
-
<member name="M:IronPdf.Engines.Chrome.LocalChromeClient.CreateStaticHtmlHeadersAndFooters(IronSoftware.IDocumentId,IronPdf.ChromePdfRenderOptions,IronPdf.Engines.Chrome.CefRenderSettings,IronPdf.Engines.Chrome.CefBrowserSettings,System.Collections.Generic.IEnumerable{System.Int32},System.Int32,System.String,System.String,System.Int32,System.Int32,IronSoftware.Drawing.Color,IronSoftware.Drawing.Color)">
|
|
3195
|
-
<summary>
|
|
3196
|
-
Creates HTML Headers and Footers that do not change. The method renders the header/footer based on page size, caches it, merges all the renders to their respective pages, then
|
|
3197
|
-
destroys the renders.
|
|
3198
|
-
</summary>
|
|
3199
|
-
</member>
|
|
3200
|
-
<member name="M:IronPdf.Engines.Chrome.LocalChromeClient.CreateDynamicHtmlHeadersAndFooters(IronSoftware.IDocumentId,IronPdf.ChromePdfRenderOptions,IronPdf.Engines.Chrome.CefRenderSettings,IronPdf.Engines.Chrome.CefBrowserSettings,System.Collections.Generic.IEnumerable{System.Int32},System.Int32,System.String,System.String,System.Int32,System.Int32,IronSoftware.Drawing.Color,IronSoftware.Drawing.Color)">
|
|
3201
|
-
<summary>
|
|
3202
|
-
Creates HTML Headers and Footers that differ from page to page (e.g. headers/footers with page numbers). This method renders each header/footer, merges them with their respective page,
|
|
3203
|
-
then destroys the render.
|
|
3204
|
-
</summary>
|
|
3205
|
-
</member>
|
|
3206
|
-
<member name="M:IronPdf.Engines.Chrome.LocalChromeClient.FormatAndRenderHtmlHeaderFooter(IronSoftware.IDocumentId,IronPdf.ChromePdfRenderOptions,IronPdf.Engines.Chrome.CefRenderSettings,IronPdf.Engines.Chrome.CefBrowserSettings,System.Int32,System.String,System.String,System.Int32,System.Int32,IronSoftware.Drawing.Color,IronSoftware.Drawing.Color,System.ValueTuple{System.Double,System.Double},System.Collections.Generic.List{System.Int32})">
|
|
3207
|
-
<summary>
|
|
3208
|
-
Performs the actual formatting and rendering of a dynamic HTML Header/Footer. Involves setting the correct dimensions on the page, replacing text, and performing the actual rendering.
|
|
3209
|
-
</summary>
|
|
3210
|
-
</member>
|
|
3211
|
-
<member name="T:IronPdf.Engines.Chrome.PersistentThreadLocalChromeClient">
|
|
3212
|
-
<summary>
|
|
3213
|
-
This is A wrapper of LocalChromeClient That force to invoke any chrome interop as a single persistent thread
|
|
3214
|
-
Useful for macOS, because CEF initialize and CEF function (render) in macOS required the same thread.
|
|
3215
|
-
</summary>
|
|
3216
|
-
</member>
|
|
3217
|
-
<member name="M:IronPdf.Engines.Chrome.PersistentThreadLocalChromeClient.#ctor">
|
|
3218
|
-
<summary>
|
|
3219
|
-
internal ctor
|
|
3220
|
-
</summary>
|
|
3221
|
-
</member>
|
|
3222
|
-
<member name="M:IronPdf.Engines.Chrome.PersistentThreadLocalChromeClient.ProcessTasks">
|
|
3223
|
-
a loop that wait for task that pass to this thread
|
|
3224
|
-
</member>
|
|
3225
|
-
<member name="M:IronPdf.Engines.Chrome.PersistentThreadLocalChromeClient.InvokeInPersistentThread(System.Action)">
|
|
3226
|
-
<summary>
|
|
3227
|
-
run action in this thread
|
|
3228
|
-
</summary>
|
|
3229
|
-
<param name="action"></param>
|
|
3230
|
-
<returns></returns>
|
|
3231
|
-
</member>
|
|
3232
|
-
<member name="M:IronPdf.Engines.Chrome.PersistentThreadLocalChromeClient.InvokeInPersistentThread``1(System.Func{``0})">
|
|
3233
|
-
<summary>
|
|
3234
|
-
run function in this thread and get result as a task
|
|
3235
|
-
</summary>
|
|
3236
|
-
<param name="func"></param>
|
|
3237
|
-
<typeparam name="T"></typeparam>
|
|
3238
|
-
<returns></returns>
|
|
3239
|
-
</member>
|
|
3240
|
-
<member name="M:IronPdf.Engines.Chrome.PersistentThreadLocalChromeClient.Dispose">
|
|
3241
|
-
<summary>
|
|
3242
|
-
stop the persistent thread
|
|
3243
|
-
</summary>
|
|
3244
|
-
</member>
|
|
3245
1778
|
<member name="T:IronPdf.Engines.Chrome.VirtualPaperLayoutManager">
|
|
3246
1779
|
<summary>
|
|
3247
1780
|
Manages HtmlToPdf page layout behavior when rendering HTML to <see cref="P:IronPdf.ChromePdfRenderOptions.PaperSize">virtual PDF paper</see>.
|
|
@@ -3297,27 +1830,6 @@
|
|
|
3297
1830
|
If user set Options.Title This method will set it to Document.MetaData
|
|
3298
1831
|
</summary>
|
|
3299
1832
|
</member>
|
|
3300
|
-
<member name="M:IronPdf.Engines.HtmlHelper.HtmlStructTreeDOM(System.String)">
|
|
3301
|
-
<summary>
|
|
3302
|
-
Convert the input html to html structree DOM used for create Pdf StructTree
|
|
3303
|
-
</summary>
|
|
3304
|
-
<param name="Html">input html</param>
|
|
3305
|
-
<returns>string of html structree DOM</returns>
|
|
3306
|
-
</member>
|
|
3307
|
-
<!-- Badly formed XML comment ignored for member "T:IronPdf.Engines.HtmlHelper.HtmlPagePopulate" -->
|
|
3308
|
-
<!-- Badly formed XML comment ignored for member "M:IronPdf.Engines.HtmlHelper.HtmlPagePopulate.#ctor(System.Int32,System.String,System.String,System.String,System.String,System.Int32,System.Int32)" -->
|
|
3309
|
-
<!-- Badly formed XML comment ignored for member "P:IronPdf.Engines.HtmlHelper.HtmlPagePopulate.Page" -->
|
|
3310
|
-
<!-- Badly formed XML comment ignored for member "P:IronPdf.Engines.HtmlHelper.HtmlPagePopulate.TagName" -->
|
|
3311
|
-
<!-- Badly formed XML comment ignored for member "P:IronPdf.Engines.HtmlHelper.HtmlPagePopulate.ParentName" -->
|
|
3312
|
-
<!-- Badly formed XML comment ignored for member "P:IronPdf.Engines.HtmlHelper.HtmlPagePopulate.ElemName" -->
|
|
3313
|
-
<!-- Badly formed XML comment ignored for member "P:IronPdf.Engines.HtmlHelper.HtmlPagePopulate.ElemValue" -->
|
|
3314
|
-
<!-- Badly formed XML comment ignored for member "P:IronPdf.Engines.HtmlHelper.HtmlPagePopulate.ElemNum" -->
|
|
3315
|
-
<!-- Badly formed XML comment ignored for member "P:IronPdf.Engines.HtmlHelper.HtmlPagePopulate.ChildCount" -->
|
|
3316
|
-
<member name="T:IronPdf.Engines.HtmlHelper.HtmlTagToStandardStruct">
|
|
3317
|
-
<summary>
|
|
3318
|
-
Class contain dictionary for conversion of htmlTag to Pdf object strct type
|
|
3319
|
-
</summary>
|
|
3320
|
-
</member>
|
|
3321
1833
|
<member name="T:IronPdf.Engines.IDocumentPostProcessor">
|
|
3322
1834
|
<summary>
|
|
3323
1835
|
Process newly rendered documents
|
|
@@ -3352,12 +1864,6 @@
|
|
|
3352
1864
|
<param name="render_options">Render options</param>
|
|
3353
1865
|
<param name="url">Url</param>
|
|
3354
1866
|
</member>
|
|
3355
|
-
<member name="T:IronPdf.Engines.Marshalers.StringDelegate">
|
|
3356
|
-
<summary>
|
|
3357
|
-
Callback delegate for a method containing a single string parameter
|
|
3358
|
-
</summary>
|
|
3359
|
-
<param name="text">Text value</param>
|
|
3360
|
-
</member>
|
|
3361
1867
|
<member name="T:IronPdf.Engines.NinjectKernelFactory">
|
|
3362
1868
|
<summary>
|
|
3363
1869
|
Creates kernel singleton for Ninject
|
|
@@ -3401,19 +1907,6 @@
|
|
|
3401
1907
|
Ninject module for determining which Pdfium client to use
|
|
3402
1908
|
</summary>
|
|
3403
1909
|
</member>
|
|
3404
|
-
<member name="M:IronPdf.Engines.Pdfium.PdfTextVariableInserter.ReplacePdfVariableText(System.String,System.Int32,System.Int32,System.Int32,System.String,System.String,System.String)">
|
|
3405
|
-
<summary>
|
|
3406
|
-
Replace pre-defined tokens with their associated values
|
|
3407
|
-
</summary>
|
|
3408
|
-
<param name="text">String which contains the tokens to replace</param>
|
|
3409
|
-
<param name="page_count">Total page count</param>
|
|
3410
|
-
<param name="first_page">First page index</param>
|
|
3411
|
-
<param name="page_index">Current page index</param>
|
|
3412
|
-
<param name="url">Url</param>
|
|
3413
|
-
<param name="htmlTitle">Html title</param>
|
|
3414
|
-
<param name="pdfTitle">Pdf title</param>
|
|
3415
|
-
<returns>String with tokens replaced</returns>
|
|
3416
|
-
</member>
|
|
3417
1910
|
<member name="T:IronPdf.Engines.ISystemClient">
|
|
3418
1911
|
<summary>
|
|
3419
1912
|
System client functionality
|
|
@@ -3451,70 +1944,6 @@
|
|
|
3451
1944
|
Ninject module for determining which System client to use
|
|
3452
1945
|
</summary>
|
|
3453
1946
|
</member>
|
|
3454
|
-
<member name="T:IronPdf.Exceptions.IronPdfAssemblyVersionMismatchException">
|
|
3455
|
-
<summary>
|
|
3456
|
-
Represents errors that occur while loading assemblies during IronPdf deployment.
|
|
3457
|
-
</summary>
|
|
3458
|
-
</member>
|
|
3459
|
-
<member name="P:IronPdf.Exceptions.IronPdfAssemblyVersionMismatchException.Message">
|
|
3460
|
-
<inheritdoc/>
|
|
3461
|
-
</member>
|
|
3462
|
-
<member name="T:IronPdf.Exceptions.IronPdfNativeException">
|
|
3463
|
-
<summary>
|
|
3464
|
-
Represents errors that occur in IronPDF native code
|
|
3465
|
-
</summary>
|
|
3466
|
-
</member>
|
|
3467
|
-
<member name="M:IronPdf.Exceptions.IronPdfNativeException.#ctor">
|
|
3468
|
-
<summary>
|
|
3469
|
-
Initializes a new instance of the <see cref="T:IronPdf.Exceptions.IronPdfNativeException"/> class.
|
|
3470
|
-
</summary>
|
|
3471
|
-
</member>
|
|
3472
|
-
<member name="M:IronPdf.Exceptions.IronPdfNativeException.#ctor(System.String)">
|
|
3473
|
-
<summary>
|
|
3474
|
-
Initializes a new instance of the <see cref="T:IronPdf.Exceptions.IronPdfNativeException"/> class with a
|
|
3475
|
-
specified error message.
|
|
3476
|
-
</summary>
|
|
3477
|
-
<param name="message">The message that describes the error.</param>
|
|
3478
|
-
</member>
|
|
3479
|
-
<member name="M:IronPdf.Exceptions.IronPdfNativeException.#ctor(System.String,System.Exception)">
|
|
3480
|
-
<summary>
|
|
3481
|
-
Initializes a new instance of the <see cref="T:IronPdf.Exceptions.IronPdfNativeException"/> class with a
|
|
3482
|
-
specified error message and a reference to the inner exception that is the cause of this exception.
|
|
3483
|
-
</summary>
|
|
3484
|
-
<param name="message">The error message that explains the reason for the exception.</param>
|
|
3485
|
-
<param name="innerException">
|
|
3486
|
-
The exception that is the cause of the current exception, or a <see langword="null"/> reference (<see
|
|
3487
|
-
langword="Nothing"/> in Visual Basic) if no inner exception is specified.
|
|
3488
|
-
</param>
|
|
3489
|
-
</member>
|
|
3490
|
-
<member name="T:IronPdf.Exceptions.IronPdfProductException">
|
|
3491
|
-
<summary>
|
|
3492
|
-
Represents errors that occur during IronPDF execution.
|
|
3493
|
-
</summary>
|
|
3494
|
-
</member>
|
|
3495
|
-
<member name="M:IronPdf.Exceptions.IronPdfProductException.#ctor">
|
|
3496
|
-
<summary>
|
|
3497
|
-
Initializes a new instance of the <see cref="T:IronPdf.Exceptions.IronPdfProductException"/> class.
|
|
3498
|
-
</summary>
|
|
3499
|
-
</member>
|
|
3500
|
-
<member name="M:IronPdf.Exceptions.IronPdfProductException.#ctor(System.String)">
|
|
3501
|
-
<summary>
|
|
3502
|
-
Initializes a new instance of the <see cref="T:IronPdf.Exceptions.IronPdfProductException"/> class with a
|
|
3503
|
-
specified error message.
|
|
3504
|
-
</summary>
|
|
3505
|
-
<param name="message">The message that describes the error.</param>
|
|
3506
|
-
</member>
|
|
3507
|
-
<member name="M:IronPdf.Exceptions.IronPdfProductException.#ctor(System.String,System.Exception)">
|
|
3508
|
-
<summary>
|
|
3509
|
-
Initializes a new instance of the <see cref="T:IronPdf.Exceptions.IronPdfProductException"/> class with a
|
|
3510
|
-
specified error message and a reference to the inner exception that is the cause of this exception.
|
|
3511
|
-
</summary>
|
|
3512
|
-
<param name="message">The error message that explains the reason for the exception.</param>
|
|
3513
|
-
<param name="innerException">
|
|
3514
|
-
The exception that is the cause of the current exception, or a <see langword="null"/> reference (<see
|
|
3515
|
-
langword="Nothing"/> in Visual Basic) if no inner exception is specified.
|
|
3516
|
-
</param>
|
|
3517
|
-
</member>
|
|
3518
1947
|
<member name="T:IronPdf.Exceptions.PlatformAssertions">
|
|
3519
1948
|
<summary>
|
|
3520
1949
|
Platform-specific assertions
|
|
@@ -3574,25 +2003,6 @@
|
|
|
3574
2003
|
Methods for RTF file
|
|
3575
2004
|
</summary>
|
|
3576
2005
|
</member>
|
|
3577
|
-
<member name="T:IronPdf.Extensions.Util">
|
|
3578
|
-
<summary>
|
|
3579
|
-
Useful methods for working with HTML and PDF files.
|
|
3580
|
-
</summary>
|
|
3581
|
-
</member>
|
|
3582
|
-
<member name="M:IronPdf.Extensions.Util.ToUri(IronSoftware.Drawing.AnyBitmap,System.Boolean)">
|
|
3583
|
-
<summary>
|
|
3584
|
-
Turns a <see cref="T:IronSoftware.Drawing.AnyBitmap"/> into a DataUri which can used to embed the Image
|
|
3585
|
-
directly into an HTML document. <para>Read standard <see
|
|
3586
|
-
href="https://en.wikipedia.org/wiki/Data_URI_scheme">https://en.wikipedia.org/wiki/Data_URI_scheme</see></para>
|
|
3587
|
-
|
|
3588
|
-
</summary>
|
|
3589
|
-
<param name="Image">A non-null <see cref="T:IronSoftware.Drawing.AnyBitmap"/></param>
|
|
3590
|
-
<param name="Rasterize">
|
|
3591
|
-
Optional flag to flatten the image to raw pixels to increase compatibility with HTML (may affect PDF file
|
|
3592
|
-
size and rendering time)
|
|
3593
|
-
</param>
|
|
3594
|
-
<returns>A data URL which can be used as the src attribute of an HTML <img tag</returns>
|
|
3595
|
-
</member>
|
|
3596
2006
|
<member name="T:IronPdf.GrpcLayer.Bookmark.GrpcBookmark">
|
|
3597
2007
|
<summary>
|
|
3598
2008
|
Represents a PDF bookmark as seen in the sidebar of PDF reader software to help user's navigate.
|
|
@@ -3781,118 +2191,6 @@
|
|
|
3781
2191
|
<paramref name="size" /> is below 1.
|
|
3782
2192
|
</exception>
|
|
3783
2193
|
</member>
|
|
3784
|
-
<member name="M:IronPdf.HeaderFooterHelper.AutosizeHeaderFooterMarginsIfNeeded(IronPdf.Engines.Chrome.IChromeClient,System.Uri,System.String,IronPdf.ChromePdfRenderOptions@)">
|
|
3785
|
-
<summary>
|
|
3786
|
-
Modify top and bottom margins in render options to fit HTML header or footer if <see cref="T:IronPdf.HtmlHeaderFooter"/> fragment is defined, but height of fragment is not defined.
|
|
3787
|
-
</summary>
|
|
3788
|
-
<param name="chromeClient">An instance conforming to <see cref="T:IronPdf.Engines.Chrome.IChromeClient" />.</param>
|
|
3789
|
-
<param name="baseUrl">Optional: a base URL.</param>
|
|
3790
|
-
<param name="proxy">Optional: a proxy.</param>
|
|
3791
|
-
<param name="renderOptions">A reference to a <see cref="T:IronPdf.ChromePdfRenderOptions"/> instance.</param>
|
|
3792
|
-
</member>
|
|
3793
|
-
<member name="M:IronPdf.HeaderFooterHelper.ShouldAutosizeMargin(IronPdf.HtmlHeaderFooter)">
|
|
3794
|
-
<summary>
|
|
3795
|
-
Check if we should perform auto-sizing for a given HTML fragment.
|
|
3796
|
-
</summary>
|
|
3797
|
-
<param name="fragment">The fragment to check.</param>
|
|
3798
|
-
<returns>A boolean value indicating whether auto-sizing should be done.</returns>
|
|
3799
|
-
</member>
|
|
3800
|
-
<member name="M:IronPdf.HeaderFooterHelper.CalculateFragmentHeightMm(IronPdf.Engines.Chrome.IChromeClient,System.Uri,System.String,System.String,System.Double,System.Double)">
|
|
3801
|
-
<summary>
|
|
3802
|
-
Calculate the height of a HTML fragment taking into account the minimum margin height.
|
|
3803
|
-
If the height of a fragment is less then the minimum height, the minimum height will be returned.
|
|
3804
|
-
</summary>
|
|
3805
|
-
<param name="chromeClient"></param>
|
|
3806
|
-
<param name="baseUrl"></param>
|
|
3807
|
-
<param name="proxy"></param>
|
|
3808
|
-
<param name="fragment">An HTML fragment to measure.</param>
|
|
3809
|
-
<param name="pageWidthMm">The page width in millimeters.</param>
|
|
3810
|
-
<param name="minimumMarginHeightMm">The minimum margin height, which will be returned if fragment height is less than minimum margin height.</param>
|
|
3811
|
-
<returns></returns>
|
|
3812
|
-
</member>
|
|
3813
|
-
<member name="T:IronPdf.HtmlHeaderFooter">
|
|
3814
|
-
<summary>
|
|
3815
|
-
A HTML Header or Footer which will be printed onto every page of the PDF. This can be used to override
|
|
3816
|
-
<para>When using HtmlHeaderFooter it is important to set <see cref="P:IronPdf.HtmlHeaderFooter.HtmlFragment"/> </para>
|
|
3817
|
-
<para>Merge meta-data into your HTML using any of these placeholder strings: {page} {total-pages} {url} {date} {time} {html-title} {pdf-title}</para>
|
|
3818
|
-
</summary>
|
|
3819
|
-
</member>
|
|
3820
|
-
<member name="F:IronPdf.HtmlHeaderFooter.FragmentHeight">
|
|
3821
|
-
<summary>
|
|
3822
|
-
When <see cref="P:IronPdf.HtmlHeaderFooter.MaxHeight"/> is set to this values, the renderer will make sure that the margins of the page are adjusted to fit the HTML fragment.
|
|
3823
|
-
</summary>
|
|
3824
|
-
</member>
|
|
3825
|
-
<member name="P:IronPdf.HtmlHeaderFooter.BaseUrl">
|
|
3826
|
-
<summary>
|
|
3827
|
-
The Base URL all URLS in the <see cref="P:IronPdf.HtmlHeaderFooter.HtmlFragment">HtmlFragment</see> will be relative to. This includes
|
|
3828
|
-
'src' attributes on images, scripts, style-sheets and also hrefs on hyper-links. <para>Note: A base URL that
|
|
3829
|
-
points to a directory should end with a slash.</para> <para>Base URL accepts file paths as well as URLS. If
|
|
3830
|
-
no BaseUrl is given, the HtmlHeaderFooter BaseUrl will be inherited from the main HTML document where
|
|
3831
|
-
possible.</para>
|
|
3832
|
-
</summary>
|
|
3833
|
-
</member>
|
|
3834
|
-
<member name="P:IronPdf.HtmlHeaderFooter.MaxHeight">
|
|
3835
|
-
<summary>
|
|
3836
|
-
Maximum Height of the HTML Header / Footer in millimeters. This value must be set sufficiently high to display the
|
|
3837
|
-
full HTML header / footer content.
|
|
3838
|
-
</summary>
|
|
3839
|
-
</member>
|
|
3840
|
-
<member name="P:IronPdf.HtmlHeaderFooter.HtmlFragment">
|
|
3841
|
-
<summary>
|
|
3842
|
-
The HTML which will be used to render the Header or Footer should be an HTML snippet rather than a complete
|
|
3843
|
-
document. It may contain styles & images. <para>Merge meta-data into the HtmlFragment by putting any of
|
|
3844
|
-
these placeholder strings into the text: {page} {total-pages} {url} {date} {time} {html-title} {pdf-title}.
|
|
3845
|
-
An alternative mail-merge style using the pattern <span class='total-pages'></span> is also supported.</para>
|
|
3846
|
-
<para>HtmlFragment is a stand-alone HTML document which does not inherit styles or settings from your
|
|
3847
|
-
main HTML content unless <see cref="P:IronPdf.HtmlHeaderFooter.LoadStylesAndCSSFromMainHtmlDocument"/> is set <c>true</c></para>
|
|
3848
|
-
</summary>
|
|
3849
|
-
</member>
|
|
3850
|
-
<member name="P:IronPdf.HtmlHeaderFooter.LoadStylesAndCSSFromMainHtmlDocument">
|
|
3851
|
-
<summary>
|
|
3852
|
-
Loads style code blocks and links to CSS style sheets from the main HTML document (which provides the PDF
|
|
3853
|
-
content) into the <see cref="T:IronPdf.HtmlHeaderFooter"/> . <para>By default, HTML Headers and Footers are stand-
|
|
3854
|
-
alone HTML documents with their own default styles. Setting <see
|
|
3855
|
-
cref="P:IronPdf.HtmlHeaderFooter.LoadStylesAndCSSFromMainHtmlDocument"/> to <c>true</c> will attempt to load all STYLE and LINK tags
|
|
3856
|
-
from the main HTML document (which renders teh PDF) into the <see cref="T:IronPdf.HtmlHeaderFooter"/>.</para> <para>If
|
|
3857
|
-
your main HTML document contains complex CSS frameworks, styles the HEAD or BODY element heavily or loads
|
|
3858
|
-
CSS from javascript then this method may not work as intended.</para> <para>This feature is not available
|
|
3859
|
-
for RenderUrlAsPdf methods. It works for RenderHtmlAsPdf, HTMLToPdf
|
|
3860
|
-
and HtmlFileToPdf conversions only.</para> <para>It is often preferable to load style sheets explicitly into
|
|
3861
|
-
your HTML Headers and Footers as STYLE and LINK tags within the <see cref="P:IronPdf.HtmlHeaderFooter.HtmlFragment"/> for granular
|
|
3862
|
-
control</para>
|
|
3863
|
-
Not supported in Docker mode.
|
|
3864
|
-
</summary>
|
|
3865
|
-
</member>
|
|
3866
|
-
<member name="M:IronPdf.HtmlHeaderFooter.Clone">
|
|
3867
|
-
<summary>
|
|
3868
|
-
Supports <see cref="T:System.ICloneable"/>. Creates a deep copy of this class instance.
|
|
3869
|
-
</summary>
|
|
3870
|
-
<returns>A deep clone of this instance. Use explicit casting to convert object back to the intended type. </returns>
|
|
3871
|
-
</member>
|
|
3872
|
-
<member name="P:IronPdf.HtmlHeaderFooter.Height">
|
|
3873
|
-
<exclude/>
|
|
3874
|
-
</member>
|
|
3875
|
-
<member name="P:IronPdf.HtmlHeaderFooter.CenterText">
|
|
3876
|
-
<exclude/>
|
|
3877
|
-
</member>
|
|
3878
|
-
<member name="P:IronPdf.HtmlHeaderFooter.FontFamily">
|
|
3879
|
-
<exclude/>
|
|
3880
|
-
</member>
|
|
3881
|
-
<member name="P:IronPdf.HtmlHeaderFooter.Font">
|
|
3882
|
-
<exclude/>
|
|
3883
|
-
</member>
|
|
3884
|
-
<member name="P:IronPdf.HtmlHeaderFooter.FontSize">
|
|
3885
|
-
<exclude/>
|
|
3886
|
-
</member>
|
|
3887
|
-
<member name="P:IronPdf.HtmlHeaderFooter.LeftText">
|
|
3888
|
-
<exclude/>
|
|
3889
|
-
</member>
|
|
3890
|
-
<member name="P:IronPdf.HtmlHeaderFooter.RightText">
|
|
3891
|
-
<exclude/>
|
|
3892
|
-
</member>
|
|
3893
|
-
<member name="P:IronPdf.HtmlHeaderFooter.Spacing">
|
|
3894
|
-
<exclude/>
|
|
3895
|
-
</member>
|
|
3896
2194
|
<member name="T:IronPdf.ImageToPdfConverter">
|
|
3897
2195
|
<summary>
|
|
3898
2196
|
The ImageToPdfConverter class can be used to create PDF documents from images. It accepts both image files and
|
|
@@ -3973,49 +2271,6 @@
|
|
|
3973
2271
|
</exception>
|
|
3974
2272
|
<exception cref="T:System.IO.FileNotFoundException"/>
|
|
3975
2273
|
</member>
|
|
3976
|
-
<member name="T:IronPdf.Imaging.ImageBehavior">
|
|
3977
|
-
E
|
|
3978
|
-
</member>
|
|
3979
|
-
<member name="F:IronPdf.Imaging.ImageBehavior.CenteredOnPage">
|
|
3980
|
-
<summary>
|
|
3981
|
-
Image should be placed on center of the page
|
|
3982
|
-
</summary>
|
|
3983
|
-
</member>
|
|
3984
|
-
<member name="F:IronPdf.Imaging.ImageBehavior.FitToPage">
|
|
3985
|
-
<summary>
|
|
3986
|
-
Image should fit to the page
|
|
3987
|
-
</summary>
|
|
3988
|
-
</member>
|
|
3989
|
-
<member name="F:IronPdf.Imaging.ImageBehavior.FitToPageAndMaintainAspectRatio">
|
|
3990
|
-
<summary>
|
|
3991
|
-
Image should fit to the page and keep aspect ratio
|
|
3992
|
-
</summary>
|
|
3993
|
-
</member>
|
|
3994
|
-
<member name="F:IronPdf.Imaging.ImageBehavior.CropPage">
|
|
3995
|
-
<summary>
|
|
3996
|
-
Page should fit to the image
|
|
3997
|
-
</summary>
|
|
3998
|
-
</member>
|
|
3999
|
-
<member name="F:IronPdf.Imaging.ImageBehavior.TopLeftCornerOfPage">
|
|
4000
|
-
<summary>
|
|
4001
|
-
Image should be placed to the left top corner of the page
|
|
4002
|
-
</summary>
|
|
4003
|
-
</member>
|
|
4004
|
-
<member name="F:IronPdf.Imaging.ImageBehavior.BottomLeftCornerOfPage">
|
|
4005
|
-
<summary>
|
|
4006
|
-
Image should be placed to the left bottom corner of the page
|
|
4007
|
-
</summary>
|
|
4008
|
-
</member>
|
|
4009
|
-
<member name="F:IronPdf.Imaging.ImageBehavior.TopRightCornerOfPage">
|
|
4010
|
-
<summary>
|
|
4011
|
-
Image should be placed to the right top corner of the page
|
|
4012
|
-
</summary>
|
|
4013
|
-
</member>
|
|
4014
|
-
<member name="F:IronPdf.Imaging.ImageBehavior.BottomRightCornerOfPage">
|
|
4015
|
-
<summary>
|
|
4016
|
-
Image should be placed to the right bottom corner of the page
|
|
4017
|
-
</summary>
|
|
4018
|
-
</member>
|
|
4019
2274
|
<member name="T:IronPdf.Imaging.ImageType">
|
|
4020
2275
|
<summary>
|
|
4021
2276
|
An Image File Type Enumeration used to select image file formats when converting PDF documents to images. Also
|
|
@@ -4134,6 +2389,12 @@
|
|
|
4134
2389
|
Chrome renderer GPU compatibility mode. In special environment like Docker or Cloud Service please use ChromeGpuModes.Disabled
|
|
4135
2390
|
</summary>
|
|
4136
2391
|
</member>
|
|
2392
|
+
<member name="P:IronPdf.Installation.DebugJobQueue">
|
|
2393
|
+
<summary>
|
|
2394
|
+
Enable or disable the logging of the job queue.
|
|
2395
|
+
Can use <see cref="M:IronSoftware.JobQueue.JobQueueLogger.ExportToCsv(System.String)"/> to export the job queue log to a CSV file.
|
|
2396
|
+
</summary>
|
|
2397
|
+
</member>
|
|
4137
2398
|
<member name="P:IronPdf.Installation.LinuxAndDockerDependenciesAutoConfig">
|
|
4138
2399
|
<summary>
|
|
4139
2400
|
If <c>true</c> The necessary package dependencies for IronPDF rendering will we automatically installed to
|
|
@@ -4195,29 +2456,6 @@
|
|
|
4195
2456
|
Custom paper width, in mm
|
|
4196
2457
|
</summary>
|
|
4197
2458
|
</member>
|
|
4198
|
-
<member name="T:IronPdf.Javascript.IJavascriptExtension">
|
|
4199
|
-
<summary>
|
|
4200
|
-
Javascript extension interface
|
|
4201
|
-
</summary>
|
|
4202
|
-
</member>
|
|
4203
|
-
<member name="P:IronPdf.Javascript.IJavascriptExtension.Javascript">
|
|
4204
|
-
<summary>
|
|
4205
|
-
Javascript to-be-injected
|
|
4206
|
-
</summary>
|
|
4207
|
-
</member>
|
|
4208
|
-
<member name="T:IronPdf.Javascript.JavascriptExtensionFactory">
|
|
4209
|
-
<summary>
|
|
4210
|
-
Helper class for generating javascript from a list of extensions
|
|
4211
|
-
</summary>
|
|
4212
|
-
</member>
|
|
4213
|
-
<member name="M:IronPdf.Javascript.JavascriptExtensionFactory.GenerateJavascript(System.Collections.Generic.IEnumerable{IronPdf.Javascript.IJavascriptExtension},System.String)">
|
|
4214
|
-
<summary>
|
|
4215
|
-
Generate a singular javascript string for a list of extensions
|
|
4216
|
-
</summary>
|
|
4217
|
-
<param name="extensions">Javascript extensions</param>
|
|
4218
|
-
<param name="userJavaScript">User-specified javascript</param>
|
|
4219
|
-
<returns>Javascript string</returns>
|
|
4220
|
-
</member>
|
|
4221
2459
|
<member name="T:IronPdf.ImageType">
|
|
4222
2460
|
<exclude/>
|
|
4223
2461
|
</member>
|
|
@@ -5332,6 +3570,13 @@
|
|
|
5332
3570
|
<returns>PDF document</returns>
|
|
5333
3571
|
<remarks>Requires the IRON document schema</remarks>
|
|
5334
3572
|
</member>
|
|
3573
|
+
<member name="M:IronPdf.PdfDocument.#ctor(System.Collections.Generic.List{IronSoftware.IBoundedDocumentObject},System.Collections.Generic.List{System.Drawing.RectangleF})">
|
|
3574
|
+
<summary>
|
|
3575
|
+
Create a new PDF document from the specified low-level document objects and page bounds
|
|
3576
|
+
</summary>
|
|
3577
|
+
<param name="objects">Document objects</param>
|
|
3578
|
+
<param name="bounds">Page bounds</param>
|
|
3579
|
+
</member>
|
|
5335
3580
|
<member name="M:IronPdf.PdfDocument.#ctor(System.Collections.Generic.IList{IronSoftware.Pdfium.Dom.IPdfPageObjectModel})">
|
|
5336
3581
|
<summary>
|
|
5337
3582
|
Create a new PDF document from existing page object models
|
|
@@ -5678,27 +3923,17 @@
|
|
|
5678
3923
|
<summary>
|
|
5679
3924
|
Convert the current document into the specified PDF/A standard format with selected icc file
|
|
5680
3925
|
</summary>
|
|
5681
|
-
<param name="PdfAVersion">(Optional) PDF/A
|
|
3926
|
+
<param name="PdfAVersion">(Optional) PDF/A compliant version, default is PDF/A-3B (ISO 19005-3)</param>
|
|
5682
3927
|
<param name="CustomICC">(Optional) Custom color profile file path</param>
|
|
5683
3928
|
<returns>A PDF/A compliant reference to this document</returns>
|
|
5684
3929
|
</member>
|
|
5685
|
-
|
|
5686
|
-
<summary>
|
|
5687
|
-
Convert the current document into the specified PDF/A standard format with embedded files and selected icc file using the default <see cref="T:IronPdf.EmbedFileConfiguration"/>
|
|
5688
|
-
</summary>
|
|
5689
|
-
<param name="EmbedFilePaths">Collection of string path to embedding file to the PDF/A document</param>
|
|
5690
|
-
<param name="PdfAVersion">(Optional) PDF/A standard format</param>
|
|
5691
|
-
<param name="CustomICC">(Optional) Custom color profile file path</param>
|
|
5692
|
-
<returns>A PDF/A compliant reference to this document with embedded files</returns>
|
|
5693
|
-
<remarks>To use custom <see cref="T:IronPdf.EmbedFileConfiguration"/>, using a collection of <see cref="T:IronPdf.EmbedFilePath"/>, <see cref="T:IronPdf.EmbedFileByte"/>, or <see cref="T:IronPdf.EmbedFileStream"/>
|
|
5694
|
-
instead a collection of string path</remarks>
|
|
5695
|
-
</member>
|
|
3930
|
+
<!-- Badly formed XML comment ignored for member "M:IronPdf.PdfDocument.ConvertToPdfA(System.Collections.Generic.IEnumerable{System.String},IronPdf.PdfAVersions,System.String)" -->
|
|
5696
3931
|
<member name="M:IronPdf.PdfDocument.ConvertToPdfA(System.Collections.Generic.IEnumerable{IronPdf.EmbedFilePath},IronPdf.PdfAVersions,System.String)">
|
|
5697
3932
|
<summary>
|
|
5698
3933
|
Convert the current document into the specified PDF/A standard format with embedded files and selected icc file
|
|
5699
3934
|
</summary>
|
|
5700
3935
|
<param name="EmbedFilePaths">Collection of path to embedding file to the PDF/A document</param>
|
|
5701
|
-
<param name="PdfAVersion">(Optional) PDF/A
|
|
3936
|
+
<param name="PdfAVersion">(Optional) PDF/A compliant version, default is PDF/A-3B (ISO 19005-3)</param>
|
|
5702
3937
|
<param name="CustomICC">(Optional) Custom color profile file path</param>
|
|
5703
3938
|
<returns>A PDF/A compliant reference to this document with embedded files</returns>
|
|
5704
3939
|
</member>
|
|
@@ -5707,7 +3942,7 @@
|
|
|
5707
3942
|
Convert the current document into the specified PDF/A standard format with embedded files and selected icc file
|
|
5708
3943
|
</summary>
|
|
5709
3944
|
<param name="EmbedFileBytes">Collection of byte[] and their file type of embedding file with type of that file to the PDF/A document</param>
|
|
5710
|
-
<param name="PdfAVersion">(Optional) PDF/A
|
|
3945
|
+
<param name="PdfAVersion">(Optional) PDF/A compliant version, default is PDF/A-3B (ISO 19005-3)</param>
|
|
5711
3946
|
<param name="CustomICC">(Optional) Custom color profile file path</param>
|
|
5712
3947
|
<returns>A PDF/A compliant reference to this document with embedded files</returns>
|
|
5713
3948
|
</member>
|
|
@@ -5716,7 +3951,7 @@
|
|
|
5716
3951
|
Convert the current document into the specified PDF/A standard format with embedded files and selected icc file
|
|
5717
3952
|
</summary>
|
|
5718
3953
|
<param name="EmbedFileStreams">Collection of Stream and their file type of embedding file with type of that file to the PDF/A document</param>
|
|
5719
|
-
<param name="PdfAVersion">(Optional) PDF/A
|
|
3954
|
+
<param name="PdfAVersion">(Optional) PDF/A compliant version, default is PDF/A-3B (ISO 19005-3)</param>
|
|
5720
3955
|
<param name="CustomICC">(Optional) Custom color profile file path</param>
|
|
5721
3956
|
<returns>A PDF/A compliant reference to this document with embedded files</returns>
|
|
5722
3957
|
</member>
|
|
@@ -5727,7 +3962,7 @@
|
|
|
5727
3962
|
<para><i>Note: All of non-embedded fonts are embedded as <b>Helvetica</b> Font which is one of 14 standard fonts provided by Adobe.</i></para>
|
|
5728
3963
|
</summary>
|
|
5729
3964
|
<param name="FileName">Target file path</param>
|
|
5730
|
-
<param name="PdfAVersion">(Optional) PDF/A
|
|
3965
|
+
<param name="PdfAVersion">(Optional) PDF/A compliant version, default is PDF/A-3B (ISO 19005-3)</param>
|
|
5731
3966
|
<param name="CustomICC">(Optional) Custom color profile file path</param>
|
|
5732
3967
|
<returns></returns>
|
|
5733
3968
|
<remarks>currently only support embedding 3 types of file; .xml, .pdf, and .png</remarks>
|
|
@@ -5741,7 +3976,7 @@
|
|
|
5741
3976
|
</summary>
|
|
5742
3977
|
<param name="FileName">Target file path</param>
|
|
5743
3978
|
<param name="EmbedFilePaths">Collection of string path to embedding file to the PDF/A document</param>
|
|
5744
|
-
<param name="PdfAVersion">(Optional) PDF/A
|
|
3979
|
+
<param name="PdfAVersion">(Optional) PDF/A compliant version, default is PDF/A-3B (ISO 19005-3)</param>
|
|
5745
3980
|
<param name="CustomICC">(Optional) Custom color profile file path</param>
|
|
5746
3981
|
<returns></returns>
|
|
5747
3982
|
<remarks>currently only support embedding 3 types of file; .xml, .pdf, and .png
|
|
@@ -5757,7 +3992,7 @@
|
|
|
5757
3992
|
</summary>
|
|
5758
3993
|
<param name="FileName">Target file path</param>
|
|
5759
3994
|
<param name="EmbedFilePaths">Collection of path to embedding file to the PDF/A document</param>
|
|
5760
|
-
<param name="PdfAVersion">(Optional) PDF/A
|
|
3995
|
+
<param name="PdfAVersion">(Optional) PDF/A compliant version, default is PDF/A-3B (ISO 19005-3)</param>
|
|
5761
3996
|
<param name="CustomICC">(Optional) Custom color profile file path</param>
|
|
5762
3997
|
<returns></returns>
|
|
5763
3998
|
<remarks>currently only support embedding 3 types of file; .xml, .pdf, and .png</remarks>
|
|
@@ -5771,7 +4006,7 @@
|
|
|
5771
4006
|
</summary>
|
|
5772
4007
|
<param name="FileName">Target file path</param>
|
|
5773
4008
|
<param name="EmbedFileBytes">Collection of byte[] and their file type of embedding file with type of that file to the PDF/A document</param>
|
|
5774
|
-
<param name="PdfAVersion">(Optional) PDF/A
|
|
4009
|
+
<param name="PdfAVersion">(Optional) PDF/A compliant version, default is PDF/A-3B (ISO 19005-3)</param>
|
|
5775
4010
|
<param name="CustomICC">(Optional) Custom color profile file path</param>
|
|
5776
4011
|
<remarks>currently only support embedding 3 types of file; .xml, .pdf, and .png</remarks>
|
|
5777
4012
|
<returns></returns>
|
|
@@ -5784,7 +4019,7 @@
|
|
|
5784
4019
|
</summary>
|
|
5785
4020
|
<param name="FileName">Target file path</param>
|
|
5786
4021
|
<param name="EmbedFileStreams">Collection of Stream and their file type of embedding file with type of that file to the PDF/A document</param>
|
|
5787
|
-
<param name="PdfAVersion">(Optional) PDF/A
|
|
4022
|
+
<param name="PdfAVersion">(Optional) PDF/A compliant version, default is PDF/A-3B (ISO 19005-3)</param>
|
|
5788
4023
|
<param name="CustomICC">(Optional) Custom color profile file path</param>
|
|
5789
4024
|
<remarks>currently only support embedding 3 types of file; .xml, .pdf, and .png</remarks>
|
|
5790
4025
|
<returns></returns>
|
|
@@ -5828,7 +4063,7 @@
|
|
|
5828
4063
|
<summary>
|
|
5829
4064
|
Convert the current document into the specified PDF/UA standard format
|
|
5830
4065
|
</summary>
|
|
5831
|
-
<param name="PdfUAVersion">PDF
|
|
4066
|
+
<param name="PdfUAVersion">PDF/UA compliant version, default is PDF/UA-1 (ISO 14289-1)</param>
|
|
5832
4067
|
<param name="NaturalLanguage">Natural languages specification</param>
|
|
5833
4068
|
<returns>A PDF/A compliant reference to this document</returns>
|
|
5834
4069
|
</member>
|
|
@@ -5840,7 +4075,7 @@
|
|
|
5840
4075
|
<para><i>Note: All of non-embedded fonts are embedded as <b>Helvetica</b> Font which is one of 14 standard fonts provided by Adobe.</i></para>
|
|
5841
4076
|
</summary>
|
|
5842
4077
|
<param name="FileName">Target file path</param>
|
|
5843
|
-
<param name="PdfUAVersion">
|
|
4078
|
+
<param name="PdfUAVersion">PDF/UA compliant version, default is PDF/UA-1 (ISO 14289-1)</param>
|
|
5844
4079
|
<param name="NaturalLanguage">Natural Languages Specification</param>
|
|
5845
4080
|
<returns>A PDF/UA compliant reference to this document</returns>
|
|
5846
4081
|
</member>
|
|
@@ -5850,7 +4085,7 @@
|
|
|
5850
4085
|
</summary>
|
|
5851
4086
|
<param name="Html">Input html</param>
|
|
5852
4087
|
<param name="NaturalLanguages">Natural Language Specification</param>
|
|
5853
|
-
<param name="PdfUAVersion">
|
|
4088
|
+
<param name="PdfUAVersion">PDF/UA compliant version, default is PDF/UA-1 (ISO 14289-1)</param>
|
|
5854
4089
|
<returns>A PDF/A compliant reference of the <see cref="T:IronPdf.PdfDocument"/></returns>
|
|
5855
4090
|
</member>
|
|
5856
4091
|
<member name="M:IronPdf.PdfDocument.GetPrintDocument(System.Drawing.Printing.PrinterSettings,System.Drawing.Printing.PrintController,System.Boolean)">
|
|
@@ -6907,6 +5142,11 @@
|
|
|
6907
5142
|
<member name="M:IronPdf.TempFolder.CleanupTempImages(System.Nullable{System.TimeSpan})">
|
|
6908
5143
|
<exclude/>
|
|
6909
5144
|
</member>
|
|
5145
|
+
<member name="T:IronPdf.Licensing.LicenseUtil">
|
|
5146
|
+
<summary>
|
|
5147
|
+
Useful methods for working with HTML and PDF files.
|
|
5148
|
+
</summary>
|
|
5149
|
+
</member>
|
|
6910
5150
|
<member name="T:IronPdf.License">
|
|
6911
5151
|
<summary>
|
|
6912
5152
|
Allows IronPdf license keys to be applied globally across an application.
|
|
@@ -8852,101 +7092,39 @@
|
|
|
8852
7092
|
</summary>
|
|
8853
7093
|
<param name="attachment">Attachment to remove</param>
|
|
8854
7094
|
</member>
|
|
8855
|
-
<member name="T:IronPdf.HtmlFormatOptions">
|
|
8856
|
-
<summary>
|
|
8857
|
-
This class contains properties that define the formatting options for converting PDF to HTML.
|
|
8858
|
-
</summary>
|
|
8859
|
-
</member>
|
|
8860
|
-
<member name="P:IronPdf.HtmlFormatOptions.BackgroundColor">
|
|
8861
|
-
<summary>
|
|
8862
|
-
The background color of the HTML body. Default is white.
|
|
8863
|
-
</summary>
|
|
8864
|
-
</member>
|
|
8865
|
-
<member name="P:IronPdf.HtmlFormatOptions.PdfPageMargin">
|
|
8866
|
-
<summary>
|
|
8867
|
-
The margin around each PDF page in the HTML document, specified in pixels. Default is 10.
|
|
8868
|
-
</summary>
|
|
8869
|
-
</member>
|
|
8870
|
-
<member name="P:IronPdf.HtmlFormatOptions.H1Color">
|
|
8871
|
-
<summary>
|
|
8872
|
-
The color of the title (h1) in the HTML document. Default is black.
|
|
8873
|
-
</summary>
|
|
8874
|
-
</member>
|
|
8875
|
-
<member name="P:IronPdf.HtmlFormatOptions.H1FontSize">
|
|
8876
|
-
<summary>
|
|
8877
|
-
The font size of the title (h1) in the HTML document, specified in pixels. Default is 20.
|
|
8878
|
-
</summary>
|
|
8879
|
-
</member>
|
|
8880
|
-
<member name="P:IronPdf.HtmlFormatOptions.H1TextAlignment">
|
|
8881
|
-
<summary>
|
|
8882
|
-
The text alignment of the title (h1) in the HTML document. Default is TextAlignment.Center.
|
|
8883
|
-
</summary>
|
|
8884
|
-
</member>
|
|
8885
|
-
<member name="T:IronPdf.TextAlignment">
|
|
8886
|
-
<summary>
|
|
8887
|
-
Represents the text alignment options for the title (h1) in the HTML document.
|
|
8888
|
-
</summary>
|
|
8889
|
-
</member>
|
|
8890
|
-
<member name="F:IronPdf.TextAlignment.Left">
|
|
8891
|
-
<summary>
|
|
8892
|
-
Aligns the text to the left.
|
|
8893
|
-
</summary>
|
|
8894
|
-
</member>
|
|
8895
|
-
<member name="F:IronPdf.TextAlignment.Center">
|
|
8896
|
-
<summary>
|
|
8897
|
-
Centers the text.
|
|
8898
|
-
</summary>
|
|
8899
|
-
</member>
|
|
8900
|
-
<member name="F:IronPdf.TextAlignment.Right">
|
|
8901
|
-
<summary>
|
|
8902
|
-
Aligns the text to the right.
|
|
8903
|
-
</summary>
|
|
8904
|
-
</member>
|
|
8905
|
-
<member name="T:IronPdf.TextAlignmentExtensions">
|
|
8906
|
-
<summary>
|
|
8907
|
-
Provides extension methods for the <see cref="T:IronPdf.TextAlignment"/> enum.
|
|
8908
|
-
</summary>
|
|
8909
|
-
</member>
|
|
8910
|
-
<member name="M:IronPdf.TextAlignmentExtensions.ToCSSPropertyValue(IronPdf.TextAlignment)">
|
|
8911
|
-
<summary>
|
|
8912
|
-
Converts the specified <see cref="T:IronPdf.TextAlignment"/> enum value to its corresponding CSS property value.
|
|
8913
|
-
</summary>
|
|
8914
|
-
<param name="me">The <see cref="T:IronPdf.TextAlignment"/> enum value to convert.</param>
|
|
8915
|
-
<returns>The CSS property value corresponding to the enum value.</returns>
|
|
8916
|
-
</member>
|
|
8917
7095
|
<member name="T:IronPdf.PdfAVersions">
|
|
8918
7096
|
<summary>
|
|
8919
|
-
|
|
7097
|
+
Versions of PDF/A compliant
|
|
8920
7098
|
</summary>
|
|
8921
7099
|
</member>
|
|
8922
7100
|
<member name="F:IronPdf.PdfAVersions.PdfA1b">
|
|
8923
7101
|
<summary>
|
|
8924
|
-
PDF/A-1B
|
|
7102
|
+
A PDF compliant with the ISO 19005-1 (PDF/A-1B)
|
|
8925
7103
|
</summary>
|
|
8926
7104
|
</member>
|
|
8927
7105
|
<member name="F:IronPdf.PdfAVersions.PdfA2b">
|
|
8928
7106
|
<summary>
|
|
8929
|
-
PDF/A-2B
|
|
7107
|
+
A PDF compliant with the ISO 19005-2 (PDF/A-2B)
|
|
8930
7108
|
</summary>
|
|
8931
7109
|
</member>
|
|
8932
7110
|
<member name="F:IronPdf.PdfAVersions.PdfA3b">
|
|
8933
7111
|
<summary>
|
|
8934
|
-
PDF/A-3B
|
|
7112
|
+
A PDF compliant with the ISO 19005-3 (PDF/A-3B)
|
|
8935
7113
|
</summary>
|
|
8936
7114
|
</member>
|
|
8937
7115
|
<member name="F:IronPdf.PdfAVersions.PdfA1a">
|
|
8938
7116
|
<summary>
|
|
8939
|
-
PDF/A-1A
|
|
7117
|
+
A PDF compliant with the ISO 19005-1 (PDF/A-1A)
|
|
8940
7118
|
</summary>
|
|
8941
7119
|
</member>
|
|
8942
7120
|
<member name="F:IronPdf.PdfAVersions.PdfA2a">
|
|
8943
7121
|
<summary>
|
|
8944
|
-
PDF/A-
|
|
7122
|
+
A PDF compliant with the ISO 19005-2 (PDF/A-2A)
|
|
8945
7123
|
</summary>
|
|
8946
7124
|
</member>
|
|
8947
7125
|
<member name="F:IronPdf.PdfAVersions.PdfA3a">
|
|
8948
7126
|
<summary>
|
|
8949
|
-
PDF/A-3A
|
|
7127
|
+
A PDF compliant with the ISO 19005-3 (PDF/A-3A)
|
|
8950
7128
|
</summary>
|
|
8951
7129
|
</member>
|
|
8952
7130
|
<member name="T:IronPdf.EmbedFilePath">
|
|
@@ -9017,12 +7195,12 @@
|
|
|
9017
7195
|
</member>
|
|
9018
7196
|
<member name="T:IronPdf.PdfUAVersions">
|
|
9019
7197
|
<summary>
|
|
9020
|
-
|
|
7198
|
+
Versions of PDF/UA compliant
|
|
9021
7199
|
</summary>
|
|
9022
7200
|
</member>
|
|
9023
7201
|
<member name="F:IronPdf.PdfUAVersions.PdfUA1">
|
|
9024
7202
|
<summary>
|
|
9025
|
-
PDF/UA-1
|
|
7203
|
+
A PDF compliant with the ISO 14289-1 (PDF/UA-1)
|
|
9026
7204
|
</summary>
|
|
9027
7205
|
</member>
|
|
9028
7206
|
<member name="T:IronPdf.TextExtractionOrder">
|
|
@@ -9057,6 +7235,17 @@
|
|
|
9057
7235
|
<returns>Full PdfDocument</returns>
|
|
9058
7236
|
<exception cref="T:System.InvalidCastException">Failed to convert</exception>
|
|
9059
7237
|
</member>
|
|
7238
|
+
<member name="T:IronPdf.Rendering.PdfRenderingEngine">
|
|
7239
|
+
<summary>
|
|
7240
|
+
Specifies which "HTML to PDF" rendering engine to use.
|
|
7241
|
+
</summary>
|
|
7242
|
+
</member>
|
|
7243
|
+
<member name="F:IronPdf.Rendering.PdfRenderingEngine.Default">
|
|
7244
|
+
<summary>Chooses the first renderer in this list which is currently available at runtime.</summary>
|
|
7245
|
+
</member>
|
|
7246
|
+
<member name="F:IronPdf.Rendering.PdfRenderingEngine.Chrome">
|
|
7247
|
+
<summary>Recommended as our most capable, multithreaded and standards compliant rendering engine. Chooses the IronPDf embedded Chrome browser rendering engine.</summary>
|
|
7248
|
+
</member>
|
|
9060
7249
|
<member name="T:IronPdf.PrintDoc.PdfPrintDocument">
|
|
9061
7250
|
<summary>
|
|
9062
7251
|
PDF Class enabling developers granular control over sending printable documents to a physical printer.
|
|
@@ -9242,11 +7431,16 @@
|
|
|
9242
7431
|
all document security options.
|
|
9243
7432
|
</param>
|
|
9244
7433
|
</member>
|
|
9245
|
-
<member name="M:IronPdf.Security.PdfSecuritySettings.RemovePasswordsAndEncryption">
|
|
7434
|
+
<member name="M:IronPdf.Security.PdfSecuritySettings.RemovePasswordsAndEncryption(System.Boolean)">
|
|
9246
7435
|
<summary>
|
|
9247
7436
|
Removes all user and owner password security for a PDF document. Also disables content encryption.
|
|
9248
|
-
<para>
|
|
9249
|
-
|
|
7437
|
+
<para>
|
|
7438
|
+
Content is encrypted at 128 bit. Copy and paste of content is disallowed. Annotations and form
|
|
7439
|
+
editing are disabled.
|
|
7440
|
+
</para>
|
|
7441
|
+
<param name="RemoveSignatures">
|
|
7442
|
+
Remove all digital signatures from the PDF document. (Recommended, since they will become invalidated anyway.)
|
|
7443
|
+
</param>
|
|
9250
7444
|
</summary>
|
|
9251
7445
|
</member>
|
|
9252
7446
|
<member name="P:IronPdf.Security.PdfSecuritySettings.AllowUserAnnotations">
|
|
@@ -9343,122 +7537,5 @@
|
|
|
9343
7537
|
<c>true</c> if successful.
|
|
9344
7538
|
</returns>
|
|
9345
7539
|
</member>
|
|
9346
|
-
<member name="M:IronPdf.TableOfContents.TableOfContentsCssMerger.MergeCss(System.String,System.String)">
|
|
9347
|
-
<summary>
|
|
9348
|
-
Merge a source CSS file into a target CSS file.
|
|
9349
|
-
</summary>
|
|
9350
|
-
<param name="tableOfContentsCss">The source CSS file.</param>
|
|
9351
|
-
<param name="customCss">The target CSS file which will be updated with values from source CSS file.</param>
|
|
9352
|
-
<returns>A CSS string in which the tableOfContentsCss is merged with the customCss.</returns>
|
|
9353
|
-
</member>
|
|
9354
|
-
<member name="M:IronPdf.TableOfContents.TableOfContentsHelper.ParseHeaderPageNumbers(IronPdf.PdfDocument,System.String)">
|
|
9355
|
-
<summary>
|
|
9356
|
-
Find all headers in an HTML document and parse the related page numbers.
|
|
9357
|
-
</summary>
|
|
9358
|
-
<param name="document">A PDF document</param>
|
|
9359
|
-
<param name="html">The HTML used to generate the PDF document.</param>
|
|
9360
|
-
<returns>A collection of page numbers.</returns>
|
|
9361
|
-
</member>
|
|
9362
|
-
<member name="M:IronPdf.TableOfContents.TableOfContentsHelper.FindPageNumbers(IronPdf.PdfDocument,System.Collections.Generic.Queue{System.String})">
|
|
9363
|
-
<summary>
|
|
9364
|
-
Look inside a PDF document to find page numbers for each header inside the headerQueue.
|
|
9365
|
-
</summary>
|
|
9366
|
-
<param name="document">A PDF document in which to search for headers.</param>
|
|
9367
|
-
<param name="headerQueue">A queue of headers.</param>
|
|
9368
|
-
<returns>An enumeration of page numbers.</returns>
|
|
9369
|
-
</member>
|
|
9370
|
-
<member name="M:IronPdf.TableOfContents.TableOfContentsHelper.GetTableOnContentsPageIndices(IronPdf.PdfDocument)">
|
|
9371
|
-
<summary>
|
|
9372
|
-
Find the page indices on which Table of Contents is shown by looking for link annotations.
|
|
9373
|
-
</summary>
|
|
9374
|
-
<param name="document">The PDF document to search.</param>
|
|
9375
|
-
<returns>A list if page indices for pages that display the Table of Contents.</returns>
|
|
9376
|
-
</member>
|
|
9377
|
-
<member name="M:IronPdf.TableOfContents.TableOfContentsHelper.ParseHeaders(System.String)">
|
|
9378
|
-
<summary>
|
|
9379
|
-
Parse all headers from an HTML string.
|
|
9380
|
-
<para>Headers should use the appropriate header tags, so from <h1> up to </h6>.</para>
|
|
9381
|
-
</summary>
|
|
9382
|
-
<param name="html">The HTML to parse headers from.</param>
|
|
9383
|
-
<returns>A queue of header titles.</returns>
|
|
9384
|
-
</member>
|
|
9385
|
-
<member name="T:IronPdf.TableOfContentsTypes">
|
|
9386
|
-
<summary>
|
|
9387
|
-
Table of contents layout type
|
|
9388
|
-
</summary>
|
|
9389
|
-
</member>
|
|
9390
|
-
<member name="F:IronPdf.TableOfContentsTypes.None">
|
|
9391
|
-
<summary>
|
|
9392
|
-
Do not create a table of contents
|
|
9393
|
-
</summary>
|
|
9394
|
-
</member>
|
|
9395
|
-
<member name="F:IronPdf.TableOfContentsTypes.Basic">
|
|
9396
|
-
<summary>
|
|
9397
|
-
Create a table of contents without page numbers
|
|
9398
|
-
</summary>
|
|
9399
|
-
<remarks>More performant, but does not include page numbers</remarks>
|
|
9400
|
-
</member>
|
|
9401
|
-
<member name="F:IronPdf.TableOfContentsTypes.WithPageNumbers">
|
|
9402
|
-
<summary>
|
|
9403
|
-
Create a table of contents WITH page numbers
|
|
9404
|
-
</summary>
|
|
9405
|
-
</member>
|
|
9406
|
-
<member name="T:IronPdf.TextHeaderFooter">
|
|
9407
|
-
<summary>
|
|
9408
|
-
Defines PDF Header and Footer display options.
|
|
9409
|
-
<para><see cref="T:IronPdf.TextHeaderFooter"/> uses a logical approach to rendering Headers and Footers for the most common use cases.</para>
|
|
9410
|
-
</summary>
|
|
9411
|
-
<seealso cref="T:IronPdf.HtmlHeaderFooter"/>
|
|
9412
|
-
</member>
|
|
9413
|
-
<member name="P:IronPdf.TextHeaderFooter.CenterText">
|
|
9414
|
-
<summary>
|
|
9415
|
-
Sets the centered header text for the PDF document. <para>Merge meta-data into your header using any of
|
|
9416
|
-
these placeholder strings: {page} {total-pages} {url} {date} {time} {html-title} {pdf-title}</para>
|
|
9417
|
-
</summary>
|
|
9418
|
-
</member>
|
|
9419
|
-
<member name="P:IronPdf.TextHeaderFooter.DrawDividerLine">
|
|
9420
|
-
<summary>
|
|
9421
|
-
Adds a horizontal line divider between the header / footer and the page content on every page of the PDF
|
|
9422
|
-
document.
|
|
9423
|
-
</summary>
|
|
9424
|
-
</member>
|
|
9425
|
-
<member name="P:IronPdf.TextHeaderFooter.DrawDividerLineColor">
|
|
9426
|
-
<summary>
|
|
9427
|
-
A Color of divider line <see cref="P:IronPdf.TextHeaderFooter.DrawDividerLine"/>
|
|
9428
|
-
</summary>
|
|
9429
|
-
</member>
|
|
9430
|
-
<member name="P:IronPdf.TextHeaderFooter.Font">
|
|
9431
|
-
<summary>
|
|
9432
|
-
Font family <see cref="T:IronSoftware.Drawing.FontTypes"/>. Default is <see cref="P:IronSoftware.Drawing.FontTypes.Helvetica"/>
|
|
9433
|
-
</summary>
|
|
9434
|
-
</member>
|
|
9435
|
-
<member name="P:IronPdf.TextHeaderFooter.FontSize">
|
|
9436
|
-
<summary>
|
|
9437
|
-
Font size in px.
|
|
9438
|
-
</summary>
|
|
9439
|
-
</member>
|
|
9440
|
-
<member name="P:IronPdf.TextHeaderFooter.LeftText">
|
|
9441
|
-
<summary>
|
|
9442
|
-
Sets the left hand side header text for the PDF document. <para>Merge meta-data into your header using any
|
|
9443
|
-
of these placeholder strings: {page} {total-pages} {url} {date} {time} {html-title} {pdf-title}</para>
|
|
9444
|
-
</summary>
|
|
9445
|
-
</member>
|
|
9446
|
-
<member name="P:IronPdf.TextHeaderFooter.RightText">
|
|
9447
|
-
<summary>
|
|
9448
|
-
Sets the right hand side header text for the PDF document. <para>Merge meta-data into your header using any
|
|
9449
|
-
of these placeholder strings: {page} {total-pages} {url} {date} {time} {html-title} {pdf-title}</para>
|
|
9450
|
-
</summary>
|
|
9451
|
-
</member>
|
|
9452
|
-
<member name="M:IronPdf.TextHeaderFooter.Clone">
|
|
9453
|
-
<summary>
|
|
9454
|
-
Clones this instance.
|
|
9455
|
-
</summary>
|
|
9456
|
-
<returns>System.Object of type SimpleHeaderFooter</returns>
|
|
9457
|
-
</member>
|
|
9458
|
-
<member name="P:IronPdf.TextHeaderFooter.FontFamily">
|
|
9459
|
-
<summary>
|
|
9460
|
-
Font used to render the PDF header.
|
|
9461
|
-
</summary>
|
|
9462
|
-
</member>
|
|
9463
7540
|
</members>
|
|
9464
7541
|
</doc>
|