@ironsoftware/ironpdf-engine-macos-x64 2023.11.2 → 2024.2.1
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-2024.2.2/IronCefSubprocess +0 -0
- package/ironpdf-engine-bin-2024.2.2/IronInterop.dylib +0 -0
- package/ironpdf-engine-bin-2024.2.2/IronPdf.pdb +0 -0
- package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/IronPdf.xml +575 -195
- package/ironpdf-engine-bin-2024.2.2/IronPdfEngine.Proto.pdb +0 -0
- package/ironpdf-engine-bin-2024.2.2/IronPdfEngine.pdb +0 -0
- package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/IronPdfEngineConsole +0 -0
- package/ironpdf-engine-bin-2024.2.2/IronPdfEngineConsole.pdb +0 -0
- package/ironpdf-engine-bin-2024.2.2/IronPdfEngineConsole.signature +0 -0
- package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/IronPdfInterop.dylib +0 -0
- package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/OpenXmlPowerTools.pdb +0 -0
- package/ironpdf-engine-bin-2024.2.2/Pdfium.Native.deployment.json +14 -0
- package/package.json +2 -2
- package/ironpdf-engine-bin-2023.11.7/IronCefSubprocess +0 -0
- package/ironpdf-engine-bin-2023.11.7/IronInterop.dylib +0 -0
- package/ironpdf-engine-bin-2023.11.7/IronPdf.pdb +0 -0
- package/ironpdf-engine-bin-2023.11.7/IronPdfEngine.Proto.pdb +0 -0
- package/ironpdf-engine-bin-2023.11.7/IronPdfEngine.pdb +0 -0
- package/ironpdf-engine-bin-2023.11.7/IronPdfEngineConsole.pdb +0 -0
- package/ironpdf-engine-bin-2023.11.7/IronPdfEngineConsole.signature +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chrome.Native.deployment.json +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Chromium Embedded Framework +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Libraries/libEGL.dylib +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Libraries/libGLESv2.dylib +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Libraries/libvk_swiftshader.dylib +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Libraries/vk_swiftshader_icd.json +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/Info.plist +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/af.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/am.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/ar.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/bg.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/bn.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/ca.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/chrome_100_percent.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/chrome_200_percent.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/cs.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/da.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/de.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/el.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/en.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/en_GB.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/es.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/es_419.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/et.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/fa.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/fi.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/fil.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/fr.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/gu.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/he.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/hi.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/hr.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/hu.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/icudtl.dat +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/id.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/it.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/ja.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/kn.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/ko.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/lt.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/lv.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/ml.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/mr.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/ms.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/nb.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/nl.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/pl.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/pt_BR.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/pt_PT.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/resources.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/ro.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/ru.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/sk.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/sl.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/snapshot_blob.bin +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/sr.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/sv.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/sw.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/ta.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/te.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/th.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/tr.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/uk.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/ur.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/v8_context_snapshot.x86_64.bin +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/vi.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/zh_CN.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/Chromium Embedded Framework.framework/Resources/zh_TW.lproj/locale.pak +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/libEGL.dylib +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/libGLESv2.dylib +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/libgrpc_csharp_ext.x64.dylib +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/libvk_swiftshader.dylib +0 -0
- /package/{ironpdf-engine-bin-2023.11.7 → ironpdf-engine-bin-2024.2.2}/vk_swiftshader_icd.json +0 -0
|
@@ -243,12 +243,15 @@
|
|
|
243
243
|
<summary>
|
|
244
244
|
Automatically renders this ASPX page into PDF and returns that PDF document in an callback. Use it in the Page_Load Event.
|
|
245
245
|
</summary>
|
|
246
|
-
<param name="
|
|
247
|
-
An
|
|
246
|
+
<param name="Callback">
|
|
247
|
+
An callback method that handles the rendered <see cref="T:IronPdf.PdfDocument"/> object.
|
|
248
248
|
</param>
|
|
249
|
-
<param name="
|
|
249
|
+
<param name="PrintOptions">
|
|
250
250
|
Sets PDF output options such as PDF Title, paper-size, DPI, headers and footers.
|
|
251
251
|
</param>
|
|
252
|
+
<param name="PdfFileName">
|
|
253
|
+
Output file name
|
|
254
|
+
</param>
|
|
252
255
|
</member>
|
|
253
256
|
<member name="T:IronPdf.AspxToPdf.FileBehavior">
|
|
254
257
|
<summary>
|
|
@@ -465,7 +468,7 @@
|
|
|
465
468
|
<member name="T:IronPdf.ChromeHttpLoginCredentials">
|
|
466
469
|
<summary>
|
|
467
470
|
Provides credentials for IronPdf's embedded Chrome browser to log-in to an intranet, extranet or website, impersonating a user. This
|
|
468
|
-
allows a unique ability to render web-pages as PDFs even on secure intranets, extranets and websites.
|
|
471
|
+
allows a unique ability to render web-pages as PDFs even on secure intranets, extranets and websites.
|
|
469
472
|
</summary>
|
|
470
473
|
</member>
|
|
471
474
|
<member name="M:IronPdf.ChromeHttpLoginCredentials.Finalize">
|
|
@@ -473,7 +476,12 @@
|
|
|
473
476
|
Destructor cleans up all temporary cookies files for the HttpLoginCredentials instance.
|
|
474
477
|
</summary>
|
|
475
478
|
</member>
|
|
476
|
-
|
|
479
|
+
<member name="F:IronPdf.ChromeHttpLoginCredentials.CustomCookies">
|
|
480
|
+
<summary>
|
|
481
|
+
OBSOLETE! Use <see cref="F:IronPdf.ChromePdfRenderOptions.CustomCookies"/> instead"
|
|
482
|
+
RenderUriToHml methods.
|
|
483
|
+
</summary>
|
|
484
|
+
</member>
|
|
477
485
|
<member name="P:IronPdf.ChromeHttpLoginCredentials.NetworkPassword">
|
|
478
486
|
<summary>
|
|
479
487
|
Optional: Password credential for Windows / Linux network security authentication.
|
|
@@ -565,8 +573,8 @@
|
|
|
565
573
|
See <see cref="P:IronPdf.ChromePdfRenderer.RenderingOptions"/> for more information
|
|
566
574
|
</para>
|
|
567
575
|
</summary>
|
|
568
|
-
<param name="
|
|
569
|
-
<param name="
|
|
576
|
+
<param name="Url">Url to apply cookies to</param>
|
|
577
|
+
<param name="Login">Cookies to apply</param>
|
|
570
578
|
</member>
|
|
571
579
|
<member name="M:IronPdf.ChromePdfRenderer.ApplyCookies(System.String,System.Collections.Generic.Dictionary{System.String,System.String})">
|
|
572
580
|
<summary>
|
|
@@ -577,6 +585,11 @@
|
|
|
577
585
|
</summary>
|
|
578
586
|
<param name="url">Url to apply cookies to</param>
|
|
579
587
|
<param name="cookies">Cookies to apply</param>
|
|
588
|
+
<remarks>Automatically sets default <see cref="P:IronPdf.ChromePdfRenderOptions.RequestContext"/> of future renders to <seealso cref="F:IronPdf.Rendering.RequestContexts.Global"/>
|
|
589
|
+
<para>
|
|
590
|
+
Very sensitive to the correct base URL, often times setting <seealso cref="F:IronPdf.ChromePdfRenderOptions.CustomCookies"/> will yield better results
|
|
591
|
+
</para>
|
|
592
|
+
</remarks>
|
|
580
593
|
</member>
|
|
581
594
|
<member name="M:IronPdf.ChromePdfRenderer.RenderPdfDocumentFromFile(IronPdf.ChromePdfRenderOptions,IronPdf.ChromeHttpLoginCredentials,System.String)">
|
|
582
595
|
<summary>
|
|
@@ -1369,11 +1382,6 @@
|
|
|
1369
1382
|
</para>
|
|
1370
1383
|
</summary>
|
|
1371
1384
|
</member>
|
|
1372
|
-
<member name="P:IronPdf.ChromePdfRenderOptions.HtmlFragment">
|
|
1373
|
-
<summary>
|
|
1374
|
-
These options are used to calculate the size of an HTML fragment.
|
|
1375
|
-
</summary>
|
|
1376
|
-
</member>
|
|
1377
1385
|
<member name="P:IronPdf.ChromePdfRenderOptions.UseMarginsOnHeaderAndFooter">
|
|
1378
1386
|
<summary>
|
|
1379
1387
|
Use margin values from the main document when rendering headers and footers
|
|
@@ -1648,11 +1656,22 @@
|
|
|
1648
1656
|
IronPdf.DocxToPdfRenderer allows any Docx to be turned into a PDF document using an up-to-date embedded Chrome browser.
|
|
1649
1657
|
</summary>
|
|
1650
1658
|
</member>
|
|
1659
|
+
<member name="P:IronPdf.DocxToPdfRenderer.RenderingOptions">
|
|
1660
|
+
<summary>
|
|
1661
|
+
Rendering options
|
|
1662
|
+
</summary>
|
|
1663
|
+
</member>
|
|
1651
1664
|
<member name="M:IronPdf.DocxToPdfRenderer.#ctor">
|
|
1652
1665
|
<summary>
|
|
1653
1666
|
Create a new Docx To PDF renderer.
|
|
1654
1667
|
</summary>
|
|
1655
1668
|
</member>
|
|
1669
|
+
<member name="M:IronPdf.DocxToPdfRenderer.#ctor(IronPdf.DocxPdfRenderOptions)">
|
|
1670
|
+
<summary>
|
|
1671
|
+
Create a new Docx to PDF renderer using the specified options
|
|
1672
|
+
</summary>
|
|
1673
|
+
<param name="Options">Rendering options</param>
|
|
1674
|
+
</member>
|
|
1656
1675
|
<member name="M:IronPdf.DocxToPdfRenderer.RenderDocxAsPdf(System.String,IronPdf.DocxPdfRenderOptions)">
|
|
1657
1676
|
<summary>
|
|
1658
1677
|
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.
|
|
@@ -1663,6 +1682,26 @@
|
|
|
1663
1682
|
A <see cref="T:IronPdf.PdfDocument"/> with the Docx rendered as its contents.
|
|
1664
1683
|
</returns>
|
|
1665
1684
|
</member>
|
|
1685
|
+
<member name="M:IronPdf.DocxToPdfRenderer.RenderDocxAsPdf(System.Byte[],IronPdf.DocxPdfRenderOptions)">
|
|
1686
|
+
<summary>
|
|
1687
|
+
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.
|
|
1688
|
+
</summary>
|
|
1689
|
+
<param name="WordDocumentBytes">The word document byte array to be rendered as a PDF.</param>
|
|
1690
|
+
<param name="Options">An instance of <see cref="T:IronPdf.DocxPdfRenderOptions"/> that allows configuration of DocxRenderer "Docx to PDF" rendering parameters. </param>
|
|
1691
|
+
<returns>
|
|
1692
|
+
A <see cref="T:IronPdf.PdfDocument"/> with the Docx rendered as its contents.
|
|
1693
|
+
</returns>
|
|
1694
|
+
</member>
|
|
1695
|
+
<member name="M:IronPdf.DocxToPdfRenderer.RenderDocxAsPdf(System.IO.Stream,IronPdf.DocxPdfRenderOptions)">
|
|
1696
|
+
<summary>
|
|
1697
|
+
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.
|
|
1698
|
+
</summary>
|
|
1699
|
+
<param name="WordDocumentStream">The word document stream to be rendered as a PDF.</param>
|
|
1700
|
+
<param name="Options">An instance of <see cref="T:IronPdf.DocxPdfRenderOptions"/> that allows configuration of DocxRenderer "Docx to PDF" rendering parameters. </param>
|
|
1701
|
+
<returns>
|
|
1702
|
+
A <see cref="T:IronPdf.PdfDocument"/> with the Docx rendered as its contents.
|
|
1703
|
+
</returns>
|
|
1704
|
+
</member>
|
|
1666
1705
|
<member name="M:IronPdf.DocxToPdfRenderer.RenderDocxAsPdfAsync(System.String,IronPdf.DocxPdfRenderOptions)">
|
|
1667
1706
|
<summary>,
|
|
1668
1707
|
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.
|
|
@@ -1679,6 +1718,7 @@
|
|
|
1679
1718
|
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.
|
|
1680
1719
|
<para> Async version of the RenderDocxAsPdf method.</para>
|
|
1681
1720
|
</summary>
|
|
1721
|
+
<param name="RecipientsDataList">List of recepient data</param>
|
|
1682
1722
|
<param name="WordDocumentPath">The word document full path to be rendered as a PDF.</param>
|
|
1683
1723
|
<param name="Options">An instance of <see cref="T:IronPdf.DocxPdfRenderOptions"/> that allows configuration of DocxRenderer "Docx to PDF" rendering parameters. </param>
|
|
1684
1724
|
<returns>
|
|
@@ -1821,6 +1861,11 @@
|
|
|
1821
1861
|
<param name="height">>Custom paper height in pixels/points.</param>
|
|
1822
1862
|
<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>
|
|
1823
1863
|
</member>
|
|
1864
|
+
<member name="T:IronPdf.DocX.MailMergeTemplate">
|
|
1865
|
+
<summary>
|
|
1866
|
+
Template for mail merge operations and variable insertion
|
|
1867
|
+
</summary>
|
|
1868
|
+
</member>
|
|
1824
1869
|
<member name="T:IronPdf.DOM.Encoding.EncodingsRegistry">
|
|
1825
1870
|
<summary>
|
|
1826
1871
|
|
|
@@ -3055,7 +3100,7 @@
|
|
|
3055
3100
|
Create a new local chrome client
|
|
3056
3101
|
</summary>
|
|
3057
3102
|
</member>
|
|
3058
|
-
<member name="M:IronPdf.Engines.Chrome.LocalChromeClient.MeasureHTML(System.String,System.Uri,System.String,IronPdf.ChromePdfRenderOptions
|
|
3103
|
+
<member name="M:IronPdf.Engines.Chrome.LocalChromeClient.MeasureHTML(System.String,System.Uri,System.String,IronPdf.ChromePdfRenderOptions)">
|
|
3059
3104
|
<summary>
|
|
3060
3105
|
Measure the size of an HTML fragment.
|
|
3061
3106
|
</summary>
|
|
@@ -3063,7 +3108,6 @@
|
|
|
3063
3108
|
<param name="baseUrl">Optional: a base URL.</param>
|
|
3064
3109
|
<param name="proxy">Optional: a proxy.</param>
|
|
3065
3110
|
<param name="renderOptions">Render options to use when rendering the HTML fragment.</param>
|
|
3066
|
-
<param name="loginCredentials">Login credentials.</param>
|
|
3067
3111
|
<returns>The size of the HTML fragment.</returns>
|
|
3068
3112
|
</member>
|
|
3069
3113
|
<member name="M:IronPdf.Engines.Chrome.LocalChromeClient.TrySubprocess(System.String)">
|
|
@@ -3073,6 +3117,23 @@
|
|
|
3073
3117
|
<param name="path">Subprocess executable path</param>
|
|
3074
3118
|
<returns>True if the subprocess can be successfully executed, false otherwise</returns>
|
|
3075
3119
|
</member>
|
|
3120
|
+
<member name="M:IronPdf.Engines.Chrome.LocalChromeClient.RenderStaticHtmlHeadersAndFooters(IronSoftware.IPdfDocumentId,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)">
|
|
3121
|
+
<summary>
|
|
3122
|
+
Renders HTML Headers and Footers that do not change. The function renders the header/footer based on page size, caches it, merges all the renders to their respective pages, then
|
|
3123
|
+
destroys the renders.
|
|
3124
|
+
</summary>
|
|
3125
|
+
</member>
|
|
3126
|
+
<member name="M:IronPdf.Engines.Chrome.LocalChromeClient.RenderDynamicHtmlHeadersAndFooters(IronSoftware.IPdfDocumentId,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)">
|
|
3127
|
+
<summary>
|
|
3128
|
+
Renders HTML Headers and Footers that differ from page to page (e.g. headers/footers with page numbers). This function renders each header/footer, merges them with their respective page,
|
|
3129
|
+
then destroys the render.
|
|
3130
|
+
</summary>
|
|
3131
|
+
</member>
|
|
3132
|
+
<member name="M:IronPdf.Engines.Chrome.LocalChromeClient.FormatAndRenderHtmlHeaderFooter(IronSoftware.IPdfDocumentId,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.Int32)">
|
|
3133
|
+
<summary>
|
|
3134
|
+
Performs the actual formatting and rendering of an HTML Header/Footer. Involves setting the correct dimensions on the page, replacing text, and performing the actual rendering.
|
|
3135
|
+
</summary>
|
|
3136
|
+
</member>
|
|
3076
3137
|
<member name="T:IronPdf.Engines.Chrome.PersistentThreadLocalChromeClient">
|
|
3077
3138
|
<summary>
|
|
3078
3139
|
This is A wrapper of LocalChromeClient That force to invoke any chrome interop as a single persistent thread
|
|
@@ -3142,7 +3203,7 @@
|
|
|
3142
3203
|
Scales content to fit the specified <see cref="P:IronPdf.ChromePdfRenderOptions.PaperSize"></see>. This mode measures minimum HTML content width after it is rendered by the browser, and then scales that content to fit to 1 sheet of paper wide where possible.
|
|
3143
3204
|
<para>A minimum width can be set to control scaling and also to ensure that responsive CSS rules are correctly applied.</para>
|
|
3144
3205
|
</summary>
|
|
3145
|
-
<param name="MinimumPixelWidth">A pixel based minimum
|
|
3206
|
+
<param name="MinimumPixelWidth">A pixel based minimum width for the document. Can help HTML elements to display correctly and respond appropriately to CSS3 responsive layout rules.</param>
|
|
3146
3207
|
</member>
|
|
3147
3208
|
<member name="M:IronPdf.Engines.Chrome.VirtualPaperLayoutManager.UseContinuousFeedRendering(System.Double,System.Int32)">
|
|
3148
3209
|
<summary>
|
|
@@ -3222,11 +3283,24 @@
|
|
|
3222
3283
|
Pdf client implementation which facilitates requests with a remote server via gRPC
|
|
3223
3284
|
</summary>
|
|
3224
3285
|
</member>
|
|
3225
|
-
<member name="
|
|
3286
|
+
<member name="T:IronPdf.Engines.Pdfium.PdfiumDeployment">
|
|
3226
3287
|
<summary>
|
|
3227
|
-
|
|
3288
|
+
Deployment class for native Pdfium binaries in IronPdf
|
|
3228
3289
|
</summary>
|
|
3229
3290
|
</member>
|
|
3291
|
+
<member name="P:IronPdf.Engines.Pdfium.PdfiumDeployment.VersionFactory">
|
|
3292
|
+
<inheritdoc/>
|
|
3293
|
+
</member>
|
|
3294
|
+
<member name="M:IronPdf.Engines.Pdfium.PdfiumDeployment.#ctor(System.String)">
|
|
3295
|
+
<summary>
|
|
3296
|
+
Create a new Pdfium deployment for IronPdf, optionally using the specified custom directory
|
|
3297
|
+
</summary>
|
|
3298
|
+
<param name="directory">Optional custom directory</param>
|
|
3299
|
+
<remarks>Should be instantiated using <seealso cref="T:IronSoftware.Deployment.DeploymentEngine"/></remarks>
|
|
3300
|
+
</member>
|
|
3301
|
+
<member name="M:IronPdf.Engines.Pdfium.PdfiumDeployment.GetPlatformSpecificErrorMessage(System.Exception)">
|
|
3302
|
+
<inheritdoc/>
|
|
3303
|
+
</member>
|
|
3230
3304
|
<member name="T:IronPdf.Engines.Pdfium.PdfiumInjectionModule">
|
|
3231
3305
|
<summary>
|
|
3232
3306
|
Ninject module for determining which Pdfium client to use
|
|
@@ -3412,6 +3486,216 @@
|
|
|
3412
3486
|
</param>
|
|
3413
3487
|
<returns>A data URL which can be used as the src attribute of an HTML <img tag</returns>
|
|
3414
3488
|
</member>
|
|
3489
|
+
<!-- Badly formed XML comment ignored for member "T:IronPdf.Fonts.PdfFontCollection" -->
|
|
3490
|
+
<member name="P:IronPdf.Fonts.PdfFontCollection.Count">
|
|
3491
|
+
<summary>
|
|
3492
|
+
Gets the total number of fonts referenced inside the PDF document.
|
|
3493
|
+
</summary>
|
|
3494
|
+
<returns>Number of fonts referenced inside the PDF document</returns>
|
|
3495
|
+
</member>
|
|
3496
|
+
<member name="M:IronPdf.Fonts.PdfFontCollection.GetEnumerator">
|
|
3497
|
+
<summary>
|
|
3498
|
+
Gets <see cref="T:System.Collections.Generic.IEnumerator`1"/> <see cref="T:System.Collections.Generic.List`1"/>.
|
|
3499
|
+
</summary>
|
|
3500
|
+
|
|
3501
|
+
</member>
|
|
3502
|
+
<member name="P:IronPdf.Fonts.PdfFontCollection.Items">
|
|
3503
|
+
<summary>
|
|
3504
|
+
Gets a copy of <see cref="T:System.Collections.Generic.List`1"/> of <see cref="T:IronPdf.Fonts.FontInfo"/> from the underlying PDF document.
|
|
3505
|
+
</summary>
|
|
3506
|
+
<returns><see cref="T:System.Collections.Generic.List`1"/> of <see cref="T:IronPdf.Fonts.FontInfo"/> as a copy from the backing collection.</returns>
|
|
3507
|
+
</member>
|
|
3508
|
+
<member name="P:IronPdf.Fonts.PdfFontCollection.ItemsReadOnly">
|
|
3509
|
+
<summary>
|
|
3510
|
+
Gets <see cref="T:System.Collections.ObjectModel.ReadOnlyCollection`1"/> whose elements are as of <see cref="T:IronPdf.Fonts.FontInfo"/> from a backing collection.
|
|
3511
|
+
</summary>
|
|
3512
|
+
<returns><see cref="T:System.Collections.ObjectModel.ReadOnlyCollection`1"/> whose elements are as of <see cref="T:IronPdf.Fonts.FontInfo"/> directly referenced from the backing collection. Thus returned collection reflects changes if the backing collection changed</returns>.
|
|
3513
|
+
</member>
|
|
3514
|
+
<member name="P:IronPdf.Fonts.PdfFontCollection.Item(System.UInt32)">
|
|
3515
|
+
<summary>
|
|
3516
|
+
Gets a copy of <see cref="T:IronPdf.Fonts.FontInfo"/> whose <see cref="P:IronPdf.Fonts.FontInfo.ObjNum"/> equal to the specified object number.
|
|
3517
|
+
to the specified value.
|
|
3518
|
+
</summary>
|
|
3519
|
+
<returns><see cref="T:IronPdf.Fonts.FontInfo"/> whose <see cref="P:IronPdf.Fonts.FontInfo.ObjNum"/> equal to the specified object number.</returns>
|
|
3520
|
+
</member>
|
|
3521
|
+
<!-- Badly formed XML comment ignored for member "P:IronPdf.Fonts.PdfFontCollection.Item(System.String)" -->
|
|
3522
|
+
<member name="M:IronPdf.Fonts.PdfFontCollection.ResolveStandardFontName(System.String)">
|
|
3523
|
+
<summary>
|
|
3524
|
+
Resolves a standard font name from the arbitrary standard font name that user expects to use.
|
|
3525
|
+
</summary>
|
|
3526
|
+
<remarks>
|
|
3527
|
+
There are 14 Standard fonts that are guaranteed to be available when working with any PDF document via any PDF document reader tools.
|
|
3528
|
+
</remarks>
|
|
3529
|
+
<param name="arbitraryStandardFontName">Expected to use standard font name string</param>
|
|
3530
|
+
<returns>Resolved standard font name, or null if it cannot resolve to the correct one.</returns>
|
|
3531
|
+
</member>
|
|
3532
|
+
<member name="M:IronPdf.Fonts.PdfFontCollection.GetStandardFontName(IronPdf.Fonts.StandardFont)">
|
|
3533
|
+
<summary>
|
|
3534
|
+
Gets a direct mapping of standard font name from the specified <see cref="T:IronPdf.Fonts.StandardFont"/>.
|
|
3535
|
+
</summary>
|
|
3536
|
+
<param name="font">Font enumeration as of type <see cref="T:IronPdf.Fonts.StandardFont"/>.</param>
|
|
3537
|
+
<returns>Always correct standard font name. Returned value won't never be null.</returns>
|
|
3538
|
+
</member>
|
|
3539
|
+
<member name="M:IronPdf.Fonts.PdfFontCollection.Add(System.String)">
|
|
3540
|
+
<summary>
|
|
3541
|
+
Adds a font into a PDF document from the specified standard font name.
|
|
3542
|
+
</summary>
|
|
3543
|
+
<param name="standardFontName">Standard font name</param>
|
|
3544
|
+
<returns><see cref="T:IronPdf.Fonts.FontInfo"/> if succeed, otherwise an exception thrown.</returns>
|
|
3545
|
+
</member>
|
|
3546
|
+
<member name="M:IronPdf.Fonts.PdfFontCollection.Add(IronPdf.Fonts.StandardFont)">
|
|
3547
|
+
<summary>
|
|
3548
|
+
Adds a font into a PDF document from the specified standard font enumeration <see cref="!:StandadFont"/>.
|
|
3549
|
+
</summary>
|
|
3550
|
+
<param name="font">Standard font enuemration <see cref="T:IronPdf.Fonts.StandardFont"/></param>
|
|
3551
|
+
<returns><see cref="T:IronPdf.Fonts.FontInfo"/> if succeed, otherwise exception thrown.</returns>
|
|
3552
|
+
</member>
|
|
3553
|
+
<member name="M:IronPdf.Fonts.PdfFontCollection.AddFromFilePath(System.String)">
|
|
3554
|
+
<summary>
|
|
3555
|
+
Adds, and embeds a font into a PDF document from the specified font's filepath.
|
|
3556
|
+
</summary>
|
|
3557
|
+
<param name="fontFilePath">Font filepath</param>
|
|
3558
|
+
<returns><see cref="T:IronPdf.Fonts.FontInfo"/> if succeed, otherwise exception thrown.</returns>
|
|
3559
|
+
</member>
|
|
3560
|
+
<member name="M:IronPdf.Fonts.PdfFontCollection.Add(System.Byte[],System.UInt32)">
|
|
3561
|
+
<summary>
|
|
3562
|
+
Adds, and embeds a font into a PDF document from the specified font's byte array.
|
|
3563
|
+
</summary>
|
|
3564
|
+
<param name="fontData">Font data in byte array</param>
|
|
3565
|
+
<param name="size">Size in bytes of font's byte array data</param>
|
|
3566
|
+
<returns><see cref="T:IronPdf.Fonts.FontInfo"/> if succeed, otherwise exception thrown.</returns>
|
|
3567
|
+
</member>
|
|
3568
|
+
<member name="M:IronPdf.Fonts.PdfFontCollection.Add(System.IO.Stream)">
|
|
3569
|
+
<summary>
|
|
3570
|
+
Adds, and embeds a font into a PDF document from the specified font's <see cref="T:System.IO.Stream"/>.
|
|
3571
|
+
</summary>
|
|
3572
|
+
<param name="fontStream">Font stream</param>
|
|
3573
|
+
<returns><see cref="T:IronPdf.Fonts.FontInfo"/> if succeed, otherwise exception thrown.</returns>
|
|
3574
|
+
</member>
|
|
3575
|
+
<member name="M:IronPdf.Fonts.PdfFontCollection.Replace(IronPdf.Fonts.FontInfo,System.String)">
|
|
3576
|
+
<summary>
|
|
3577
|
+
Replaces a font referenced from a PDF document with the specified standard font name.
|
|
3578
|
+
Supports replacing a target font which is either a simple font, or a composite font.
|
|
3579
|
+
</summary>
|
|
3580
|
+
<param name="targetFont">Target <see cref="T:IronPdf.Fonts.FontInfo"/> to replace</param>
|
|
3581
|
+
<param name="newFontName">Standard font name which will be used to replace the target font</param>
|
|
3582
|
+
<remarks>
|
|
3583
|
+
This method won't embed the font.
|
|
3584
|
+
</remarks>
|
|
3585
|
+
<returns><see cref="T:IronPdf.Fonts.FontInfo"/> representing a replaced font if succeed, otherwise an exception thrown.</returns>
|
|
3586
|
+
</member>
|
|
3587
|
+
<member name="M:IronPdf.Fonts.PdfFontCollection.Replace(IronPdf.Fonts.FontInfo,IronPdf.Fonts.StandardFont)">
|
|
3588
|
+
<summary>
|
|
3589
|
+
Replaces a font referenced from a PDF document with the specified <see cref="T:IronPdf.Fonts.StandardFont"/>.
|
|
3590
|
+
Supports replacing a target font which is either a simple font, or a composite font.
|
|
3591
|
+
</summary>
|
|
3592
|
+
<param name="targetFont">Target <see cref="T:IronPdf.Fonts.FontInfo"/> to replace</param>
|
|
3593
|
+
<param name="newFont"><see cref="T:IronPdf.Fonts.StandardFont"/> representing a standard font used to replace the target font</param>
|
|
3594
|
+
<remarks>
|
|
3595
|
+
This method won't embed the font.
|
|
3596
|
+
</remarks>
|
|
3597
|
+
<returns><see cref="T:IronPdf.Fonts.FontInfo"/> representing a replaced font if succeed, otherwise an exception thrown.</returns>
|
|
3598
|
+
</member>
|
|
3599
|
+
<member name="M:IronPdf.Fonts.PdfFontCollection.ReplaceFromFilePath(IronPdf.Fonts.FontInfo,System.String)">
|
|
3600
|
+
<summary>
|
|
3601
|
+
Replaces a font referenced from a PDF document with the specified font's filepath.
|
|
3602
|
+
Supports replacing a target font which is either a simple font, or a composite font.
|
|
3603
|
+
</summary>
|
|
3604
|
+
<param name="targetFont">Target <see cref="T:IronPdf.Fonts.FontInfo"/> to replace</param>
|
|
3605
|
+
<param name="path">Font's filepath</param>
|
|
3606
|
+
<remarks>
|
|
3607
|
+
This method will also embed the font into a PDF document.
|
|
3608
|
+
</remarks>
|
|
3609
|
+
<returns><see cref="T:IronPdf.Fonts.FontInfo"/> representing a replaced font if succeed, otherwise an exception thrown.</returns>
|
|
3610
|
+
</member>
|
|
3611
|
+
<member name="M:IronPdf.Fonts.PdfFontCollection.Replace(IronPdf.Fonts.FontInfo,System.Byte[],System.UInt32)">
|
|
3612
|
+
<summary>
|
|
3613
|
+
Replaces a font referenced from a PDF document with the specified font's <see langword="byte[]"/>.
|
|
3614
|
+
Supports replacing a target font which is either a simple font, or a composite font.
|
|
3615
|
+
</summary>
|
|
3616
|
+
<param name="targetFont">Target <see cref="T:IronPdf.Fonts.FontInfo"/> to replace</param>
|
|
3617
|
+
<param name="newFontData">Font's filepath as <see langword="byte[]"/></param>
|
|
3618
|
+
<param name="size">Size in bytes for the font data</param>
|
|
3619
|
+
<remarks>
|
|
3620
|
+
This method will also embed the font into a PDF document.
|
|
3621
|
+
</remarks>
|
|
3622
|
+
<returns><see cref="T:IronPdf.Fonts.FontInfo"/> representing a replaced font if succeed, otherwise an exception thrown.</returns>
|
|
3623
|
+
</member>
|
|
3624
|
+
<member name="M:IronPdf.Fonts.PdfFontCollection.Replace(IronPdf.Fonts.FontInfo,System.IO.Stream)">
|
|
3625
|
+
<summary>
|
|
3626
|
+
Replaces a font referenced from a PDF document with the specified font's <see cref="T:System.IO.Stream"/>.
|
|
3627
|
+
Supports replacing a target font which is either a simple font, or a composite font.
|
|
3628
|
+
</summary>
|
|
3629
|
+
<param name="targetFont">Target <see cref="T:IronPdf.Fonts.FontInfo"/> to replace</param>
|
|
3630
|
+
<param name="newFontStream">Font's <see cref="T:System.IO.Stream"/></param>
|
|
3631
|
+
<remarks>
|
|
3632
|
+
This method will also embed the font into a PDF document.
|
|
3633
|
+
</remarks>
|
|
3634
|
+
<returns><see cref="T:IronPdf.Fonts.FontInfo"/> representing a replaced font if succeed, otherwise an exception thrown.</returns>
|
|
3635
|
+
</member>
|
|
3636
|
+
<member name="M:IronPdf.Fonts.PdfFontCollection.Embed(IronPdf.Fonts.FontInfo,System.String)">
|
|
3637
|
+
<summary>
|
|
3638
|
+
Embeds a font with the font's filepath.
|
|
3639
|
+
</summary>
|
|
3640
|
+
<remarks>
|
|
3641
|
+
This requires that there is an existing font referenced which used as a target in order to successfully embed a font.
|
|
3642
|
+
</remarks>
|
|
3643
|
+
<param name="font">Target <see cref="T:IronPdf.Fonts.FontInfo"/> to embed</param>
|
|
3644
|
+
<param name="path">Font's filepath for using as a font data to embed</param>
|
|
3645
|
+
<returns><see cref="T:IronPdf.Fonts.FontInfo"/> object just embedded if succeed, otherwise an exception thrown.</returns>
|
|
3646
|
+
</member>
|
|
3647
|
+
<member name="M:IronPdf.Fonts.PdfFontCollection.Embed(IronPdf.Fonts.FontInfo,System.Byte[],System.UInt32)">
|
|
3648
|
+
<summary>
|
|
3649
|
+
Embeds a font with the font's <see langword="byte[]"/>.
|
|
3650
|
+
</summary>
|
|
3651
|
+
<remarks>
|
|
3652
|
+
This requires that there is an existing font referenced which used as a target in order to successfully embed a font.
|
|
3653
|
+
</remarks>
|
|
3654
|
+
<param name="font">Target font to embed</param>
|
|
3655
|
+
<param name="fontData">Font's data as byte array</param>
|
|
3656
|
+
<param name="size">Size in byte of the byte array</param>
|
|
3657
|
+
<returns><see cref="T:IronPdf.Fonts.FontInfo"/> object just embedded if succeed, otherwise an exception thrown.</returns>
|
|
3658
|
+
</member>
|
|
3659
|
+
<member name="M:IronPdf.Fonts.PdfFontCollection.Embed(IronPdf.Fonts.FontInfo,System.IO.Stream)">
|
|
3660
|
+
<summary>
|
|
3661
|
+
Embeds a font with the font's <see cref="T:System.IO.Stream"/>.
|
|
3662
|
+
</summary>
|
|
3663
|
+
<remarks>
|
|
3664
|
+
This requires that there is an existing font referenced which used as a target in order to successfully embed a font.
|
|
3665
|
+
</remarks>
|
|
3666
|
+
<param name="font">Target font to embed</param>
|
|
3667
|
+
<param name="fontStream">Font stream</param>
|
|
3668
|
+
<returns><see cref="T:IronPdf.Fonts.FontInfo"/> object just embedded if succeed, otherwise an exception thrown.</returns>
|
|
3669
|
+
</member>
|
|
3670
|
+
<member name="M:IronPdf.Fonts.PdfFontCollection.UnEmbed(System.String)">
|
|
3671
|
+
<summary>
|
|
3672
|
+
UnEmbeds a font from the regular expression string matching a font name.
|
|
3673
|
+
It will <strong>only</strong> perform on the first match.
|
|
3674
|
+
</summary>
|
|
3675
|
+
<remarks>
|
|
3676
|
+
This method is mostly useful if font names are mostly unique within the PDF document.
|
|
3677
|
+
Alternatively use <see cref="M:IronPdf.Fonts.IPdfFontCollection.Find(System.String)"/>.
|
|
3678
|
+
|
|
3679
|
+
<para>
|
|
3680
|
+
UnEmbeds a font means that its font content would be deleted from the PDF document, but the other data structure
|
|
3681
|
+
or information of the font itself is still there. Uses this method to reduce file size of PDF document.
|
|
3682
|
+
</para>
|
|
3683
|
+
</remarks>
|
|
3684
|
+
<param name="regexFontName">Regular expression string matching a font name</param>
|
|
3685
|
+
<returns><see cref="T:IronPdf.Fonts.FontInfo"/> just un-embedded if succeed, otherwise an exception thrown.</returns>
|
|
3686
|
+
</member>
|
|
3687
|
+
<member name="M:IronPdf.Fonts.PdfFontCollection.UnEmbed(IronPdf.Fonts.FontInfo)">
|
|
3688
|
+
<summary>
|
|
3689
|
+
UnEmbeds a font from the font object.
|
|
3690
|
+
</summary>
|
|
3691
|
+
<remarks>
|
|
3692
|
+
UnEmbeds a font means that its font content would be deleted from the PDF document, but the other data structure
|
|
3693
|
+
or information of the font itself is still there. Uses this method to reduce file size of PDF document.
|
|
3694
|
+
</remarks>
|
|
3695
|
+
<param name="font">Font object to un-embed</param>
|
|
3696
|
+
<returns><see cref="T:IronPdf.Fonts.FontInfo"/> just un-embedded if succeed, otherwise an exception thrown.</returns>
|
|
3697
|
+
</member>
|
|
3698
|
+
<!-- Badly formed XML comment ignored for member "M:IronPdf.Fonts.PdfFontCollection.Find(System.String)" -->
|
|
3415
3699
|
<member name="T:IronPdf.GrpcLayer.Bookmark.GrpcBookmark">
|
|
3416
3700
|
<summary>
|
|
3417
3701
|
Represents a PDF bookmark as seen in the sidebar of PDF reader software to help user's navigate.
|
|
@@ -3468,20 +3752,77 @@
|
|
|
3468
3752
|
</summary>
|
|
3469
3753
|
<returns></returns>
|
|
3470
3754
|
</member>
|
|
3755
|
+
<member name="T:IronPdf.GrpcLayer.IronPdfConnectionType">
|
|
3756
|
+
<summary>
|
|
3757
|
+
Remote connection type, for connecting to IronPdfEngine via remote procedure call
|
|
3758
|
+
</summary>
|
|
3759
|
+
</member>
|
|
3760
|
+
<member name="F:IronPdf.GrpcLayer.IronPdfConnectionType.LocalExecutable">
|
|
3761
|
+
<summary>
|
|
3762
|
+
Connect to an IronPdfEngine "server" running in an executable on your local machine
|
|
3763
|
+
</summary>
|
|
3764
|
+
</member>
|
|
3765
|
+
<member name="F:IronPdf.GrpcLayer.IronPdfConnectionType.Docker">
|
|
3766
|
+
<summary>
|
|
3767
|
+
Connect to an IronPdfEngine "server" running in a Docker container directly accessible from your local machine
|
|
3768
|
+
</summary>
|
|
3769
|
+
</member>
|
|
3770
|
+
<member name="F:IronPdf.GrpcLayer.IronPdfConnectionType.RemoteServer">
|
|
3771
|
+
<summary>
|
|
3772
|
+
Connect to an IronPdfEngine "server" running remotely and/or on the cloud
|
|
3773
|
+
</summary>
|
|
3774
|
+
</member>
|
|
3775
|
+
<member name="F:IronPdf.GrpcLayer.IronPdfConnectionType.CustomChannel">
|
|
3776
|
+
<summary>
|
|
3777
|
+
Connect to an IronPdfEngine "server" using custom channel
|
|
3778
|
+
</summary>
|
|
3779
|
+
</member>
|
|
3780
|
+
<member name="T:IronPdf.GrpcLayer.IronPdfConnectionConfiguration">
|
|
3781
|
+
<summary>
|
|
3782
|
+
Custom remote connection configuration, for a client-server model
|
|
3783
|
+
</summary>
|
|
3784
|
+
</member>
|
|
3471
3785
|
<member name="P:IronPdf.GrpcLayer.IronPdfConnectionConfiguration.Cloud">
|
|
3472
3786
|
<summary>
|
|
3473
|
-
Default configuration for connecting to
|
|
3787
|
+
Default configuration for connecting to IronPdfEngine cloud service
|
|
3474
3788
|
</summary>
|
|
3475
3789
|
</member>
|
|
3476
3790
|
<member name="P:IronPdf.GrpcLayer.IronPdfConnectionConfiguration.Docker">
|
|
3477
3791
|
<summary>
|
|
3478
|
-
Default configuration for connecting to
|
|
3792
|
+
Default configuration for connecting to IronPdfEngine docker host service
|
|
3479
3793
|
</summary>
|
|
3480
3794
|
</member>
|
|
3481
3795
|
<member name="P:IronPdf.GrpcLayer.IronPdfConnectionConfiguration.Executable">
|
|
3482
3796
|
<summary>
|
|
3483
|
-
Default configuration for connecting to
|
|
3797
|
+
Default configuration for connecting to IronPdfEngine local service executable
|
|
3798
|
+
</summary>
|
|
3799
|
+
</member>
|
|
3800
|
+
<member name="M:IronPdf.GrpcLayer.IronPdfConnectionConfiguration.RemoteServer(System.String,Grpc.Core.Metadata)">
|
|
3801
|
+
<summary>
|
|
3802
|
+
Custom configuration for connecting to IronPdfEngine remote server
|
|
3803
|
+
</summary>
|
|
3804
|
+
</member>
|
|
3805
|
+
<member name="M:IronPdf.GrpcLayer.IronPdfConnectionConfiguration.WithCustomChannel(Grpc.Core.ChannelBase,Grpc.Core.Metadata)">
|
|
3806
|
+
<summary>
|
|
3807
|
+
Using your custom gRPC Channel <see cref="T:Grpc.Core.ChannelBase"/>
|
|
3808
|
+
<br/>
|
|
3809
|
+
You can create a channel by either create a new <see cref="T:Grpc.Core.Channel"/> object or using <see cref="M:Grpc.Net.Client.GrpcChannel.ForAddress(System.String)"/> or else to custom your own gRPC channel
|
|
3810
|
+
</summary>
|
|
3811
|
+
<param name="customChannel">Custom gRPC Channel <see cref="T:Grpc.Core.ChannelBase"/></param>
|
|
3812
|
+
</member>
|
|
3813
|
+
<member name="P:IronPdf.GrpcLayer.IronPdfConnectionConfiguration.Metadata">
|
|
3814
|
+
<summary>
|
|
3815
|
+
Custom <see cref="T:Grpc.Core.Metadata"/> that will be sent with each gRPC request.
|
|
3816
|
+
</summary>
|
|
3817
|
+
</member>
|
|
3818
|
+
<member name="P:IronPdf.GrpcLayer.IronPdfConnectionConfiguration.CustomChannel">
|
|
3819
|
+
<summary>
|
|
3820
|
+
Custom gRPC Channel <see cref="T:Grpc.Core.ChannelBase"/>
|
|
3821
|
+
You can create a channel by either create a new <see cref="T:Grpc.Core.Channel"/> object or using <see cref="M:Grpc.Net.Client.GrpcChannel.ForAddress(System.String)"/> or else to custom your own gRPC channel
|
|
3484
3822
|
</summary>
|
|
3823
|
+
<remarks>
|
|
3824
|
+
Setting CustomChannel will cause any configuration in this object (<see cref="T:IronPdf.GrpcLayer.IronPdfConnectionConfiguration"/>) to be ignored, except for Metadata
|
|
3825
|
+
</remarks>
|
|
3485
3826
|
</member>
|
|
3486
3827
|
<member name="P:IronPdf.GrpcLayer.IronPdfConnectionConfiguration.ConnectionType">
|
|
3487
3828
|
<summary>
|
|
@@ -3590,7 +3931,7 @@
|
|
|
3590
3931
|
<param name="fragment">The fragment to check.</param>
|
|
3591
3932
|
<returns>A boolean value indicating whether auto-sizing should be done.</returns>
|
|
3592
3933
|
</member>
|
|
3593
|
-
<member name="M:IronPdf.HeaderFooterHelper.CalculateFragmentHeightMm(IronPdf.Engines.Chrome.IChromeClient,System.Uri,System.String,System.String,System.Double)">
|
|
3934
|
+
<member name="M:IronPdf.HeaderFooterHelper.CalculateFragmentHeightMm(IronPdf.Engines.Chrome.IChromeClient,System.Uri,System.String,System.String,System.Double,System.Double)">
|
|
3594
3935
|
<summary>
|
|
3595
3936
|
Calculate the height of a HTML fragment taking into account the minimum margin height.
|
|
3596
3937
|
If the height of a fragment is less then the minimum height, the minimum height will be returned.
|
|
@@ -3598,8 +3939,9 @@
|
|
|
3598
3939
|
<param name="chromeClient"></param>
|
|
3599
3940
|
<param name="baseUrl"></param>
|
|
3600
3941
|
<param name="proxy"></param>
|
|
3601
|
-
<param name="fragment"
|
|
3602
|
-
<param name="
|
|
3942
|
+
<param name="fragment">An HTML fragment to measure.</param>
|
|
3943
|
+
<param name="pageWidthMm">The page width in millimeters.</param>
|
|
3944
|
+
<param name="minimumMarginHeightMm">The minimum margin height, which will be returned if fragment height is less than minimum margin height.</param>
|
|
3603
3945
|
<returns></returns>
|
|
3604
3946
|
</member>
|
|
3605
3947
|
<member name="T:IronPdf.HtmlHeaderFooter">
|
|
@@ -3878,6 +4220,11 @@
|
|
|
3878
4220
|
</summary>
|
|
3879
4221
|
<remarks>Useful for IronPdf.Slim</remarks>
|
|
3880
4222
|
</member>
|
|
4223
|
+
<member name="P:IronPdf.Installation.ConnectionType">
|
|
4224
|
+
<summary>
|
|
4225
|
+
Get the current connection type.
|
|
4226
|
+
</summary>
|
|
4227
|
+
</member>
|
|
3881
4228
|
<member name="P:IronPdf.Installation.LicenseKey">
|
|
3882
4229
|
<summary>
|
|
3883
4230
|
Synonym of IronPdf.License.LicenseKey
|
|
@@ -3894,6 +4241,17 @@
|
|
|
3894
4241
|
</summary>
|
|
3895
4242
|
<remarks>Warning! This feature is experimental and unstable. Useful for environments where execution permissions are not possible.</remarks>
|
|
3896
4243
|
</member>
|
|
4244
|
+
<member name="P:IronPdf.Installation.EnableWebSecurity">
|
|
4245
|
+
<summary>
|
|
4246
|
+
Enable web security for Chrome renderer. Disabled by default.
|
|
4247
|
+
<para>
|
|
4248
|
+
Enabling web security will disable operations which require local disk access or cross-origin requests.
|
|
4249
|
+
</para>
|
|
4250
|
+
<para>
|
|
4251
|
+
Useful when injecting untrusted HTML from users.
|
|
4252
|
+
</para>
|
|
4253
|
+
</summary>
|
|
4254
|
+
</member>
|
|
3897
4255
|
<member name="P:IronPdf.Installation.ChromeBrowserCachePath">
|
|
3898
4256
|
<summary>
|
|
3899
4257
|
Disk cache path for chrome browser instances
|
|
@@ -4032,138 +4390,6 @@
|
|
|
4032
4390
|
Every page of the PDF will be compiled into a single multi-page TIFF image file (aka. multi-frame TIFF).
|
|
4033
4391
|
</summary>
|
|
4034
4392
|
</member>
|
|
4035
|
-
<member name="T:IronPdf.Forms.CheckBoxField">
|
|
4036
|
-
<summary>
|
|
4037
|
-
Represents a check-box in a PDF form.
|
|
4038
|
-
</summary>
|
|
4039
|
-
<seealso cref="!:IronPdf.Forms.FormField"/>
|
|
4040
|
-
</member>
|
|
4041
|
-
<member name="P:IronPdf.Forms.CheckBoxField.BooleanValue">
|
|
4042
|
-
<summary>
|
|
4043
|
-
Gets or sets a value indicating whether the check-box is checked (ticked).
|
|
4044
|
-
</summary>
|
|
4045
|
-
<value>
|
|
4046
|
-
<c>true</c> if checked; otherwise, <c>false</c>.
|
|
4047
|
-
</value>
|
|
4048
|
-
</member>
|
|
4049
|
-
<member name="T:IronPdf.Forms.ComboBoxField">
|
|
4050
|
-
<summary>
|
|
4051
|
-
Represents a combo-box (drop down menu) in a PDF form.
|
|
4052
|
-
</summary>
|
|
4053
|
-
<seealso cref="!:IronPdf.Forms.FormField"/>
|
|
4054
|
-
</member>
|
|
4055
|
-
<member name="P:IronPdf.Forms.ComboBoxField.Options">
|
|
4056
|
-
<summary>
|
|
4057
|
-
Gets the available options for the combo-box in zero based index order.
|
|
4058
|
-
</summary>
|
|
4059
|
-
<value>
|
|
4060
|
-
The option names as strings.
|
|
4061
|
-
</value>
|
|
4062
|
-
</member>
|
|
4063
|
-
<member name="P:IronPdf.Forms.ComboBoxField.SelectedIndex">
|
|
4064
|
-
<summary>
|
|
4065
|
-
Gets the index of the selected option.
|
|
4066
|
-
</summary>
|
|
4067
|
-
<value>
|
|
4068
|
-
The index of the selected. 0 based.
|
|
4069
|
-
</value>
|
|
4070
|
-
</member>
|
|
4071
|
-
<member name="T:IronPdf.Forms.PdfForm">
|
|
4072
|
-
<summary>
|
|
4073
|
-
A collection of the user-editable form fields within a PDF document
|
|
4074
|
-
</summary>
|
|
4075
|
-
</member>
|
|
4076
|
-
<member name="T:IronPdf.Forms.TextField">
|
|
4077
|
-
<summary>
|
|
4078
|
-
Represents an editable text input field in a PDF document.
|
|
4079
|
-
</summary>
|
|
4080
|
-
<seealso cref="!:IronPdf.Forms.FormField"/>
|
|
4081
|
-
</member>
|
|
4082
|
-
<member name="T:IronPdf.Forms.FormFieldTypes">
|
|
4083
|
-
<summary>
|
|
4084
|
-
Form field types
|
|
4085
|
-
</summary>
|
|
4086
|
-
</member>
|
|
4087
|
-
<member name="T:IronPdf.Forms.IFormField">
|
|
4088
|
-
<summary>
|
|
4089
|
-
Generic base class from which all PDF Form fields are derived.
|
|
4090
|
-
</summary>
|
|
4091
|
-
</member>
|
|
4092
|
-
<member name="T:IronPdf.Forms.CommonFormField">
|
|
4093
|
-
<summary>
|
|
4094
|
-
Generic base class from which all PDF Form fields are derived.
|
|
4095
|
-
</summary>
|
|
4096
|
-
</member>
|
|
4097
|
-
<member name="M:IronPdf.Forms.CommonFormField.ToString">
|
|
4098
|
-
<summary>
|
|
4099
|
-
Returns the value of this field.
|
|
4100
|
-
</summary>
|
|
4101
|
-
<returns>
|
|
4102
|
-
The value of this field.
|
|
4103
|
-
</returns>
|
|
4104
|
-
</member>
|
|
4105
|
-
<member name="P:IronPdf.Forms.CommonFormField.AnnotationIndex">
|
|
4106
|
-
<summary>
|
|
4107
|
-
Index of annotation associated with this form field
|
|
4108
|
-
</summary>
|
|
4109
|
-
</member>
|
|
4110
|
-
<member name="P:IronPdf.Forms.CommonFormField.FullName">
|
|
4111
|
-
<summary>
|
|
4112
|
-
Gets the fully qualified name of this field. This is constructed from all partial field names of the field and all of its ancestors.
|
|
4113
|
-
<para>
|
|
4114
|
-
Example 1: <code>parent's_full_name.child's_partial_name</code>
|
|
4115
|
-
Example 2: <code>PersonalData.Address.ZipCode</code>
|
|
4116
|
-
</para>
|
|
4117
|
-
</summary>
|
|
4118
|
-
<value>
|
|
4119
|
-
The fully qualified name as a string.
|
|
4120
|
-
</value>
|
|
4121
|
-
</member>
|
|
4122
|
-
<member name="P:IronPdf.Forms.CommonFormField.Name">
|
|
4123
|
-
<summary>
|
|
4124
|
-
Gets the ID name of this field.
|
|
4125
|
-
</summary>
|
|
4126
|
-
<value>
|
|
4127
|
-
The name as a string.
|
|
4128
|
-
</value>
|
|
4129
|
-
</member>
|
|
4130
|
-
<member name="P:IronPdf.Forms.CommonFormField.PageIndex">
|
|
4131
|
-
<summary>
|
|
4132
|
-
Page index which contains this form field
|
|
4133
|
-
</summary>
|
|
4134
|
-
</member>
|
|
4135
|
-
<member name="P:IronPdf.Forms.CommonFormField.Type">
|
|
4136
|
-
<summary>
|
|
4137
|
-
Form field type
|
|
4138
|
-
</summary>
|
|
4139
|
-
</member>
|
|
4140
|
-
<member name="P:IronPdf.Forms.CommonFormField.Width">
|
|
4141
|
-
<summary>
|
|
4142
|
-
Form field width
|
|
4143
|
-
</summary>
|
|
4144
|
-
</member>
|
|
4145
|
-
<member name="P:IronPdf.Forms.CommonFormField.Height">
|
|
4146
|
-
<summary>
|
|
4147
|
-
Form field height
|
|
4148
|
-
</summary>
|
|
4149
|
-
</member>
|
|
4150
|
-
<member name="P:IronPdf.Forms.CommonFormField.X">
|
|
4151
|
-
<summary>
|
|
4152
|
-
Form field x position
|
|
4153
|
-
</summary>
|
|
4154
|
-
</member>
|
|
4155
|
-
<member name="P:IronPdf.Forms.CommonFormField.Y">
|
|
4156
|
-
<summary>
|
|
4157
|
-
Form field x position
|
|
4158
|
-
</summary>
|
|
4159
|
-
</member>
|
|
4160
|
-
<member name="M:IronPdf.Forms.CommonFormField.SetFont(IronSoftware.Drawing.FontTypes,System.Double)">
|
|
4161
|
-
<summary>
|
|
4162
|
-
Sets the font to the text field of pdf form.
|
|
4163
|
-
</summary>
|
|
4164
|
-
<param name="fontType">Type of the font.</param>
|
|
4165
|
-
<param name="fontSize">Size of the font.</param>
|
|
4166
|
-
</member>
|
|
4167
4393
|
<member name="T:IronPdf.Font.FontTypes">
|
|
4168
4394
|
<exclude/>
|
|
4169
4395
|
</member>
|
|
@@ -4644,6 +4870,13 @@
|
|
|
4644
4870
|
<param name="Width">The width of your annotation's icon and interactive area in pixels</param>
|
|
4645
4871
|
<param name="Height">The height of your annotation's icon and interactive area in pixels</param>
|
|
4646
4872
|
</member>
|
|
4873
|
+
<member name="M:IronPdf.PdfDocument.GetAnnotations(System.Int32)">
|
|
4874
|
+
<summary>
|
|
4875
|
+
Retrieve a list of annotations from a given page index.
|
|
4876
|
+
</summary>
|
|
4877
|
+
<param name="pageIndex">Index of the page for which to retrieve annotations. The index of the first page is 0.</param>
|
|
4878
|
+
<returns>A list of annotations.</returns>
|
|
4879
|
+
</member>
|
|
4647
4880
|
<member name="P:IronPdf.PdfDocument.Attachments">
|
|
4648
4881
|
<summary>
|
|
4649
4882
|
Collection of attachments contained within the pdf document
|
|
@@ -4865,6 +5098,11 @@
|
|
|
4865
5098
|
<param name="EndIndex">The index of the last PDF page to copy.></param>
|
|
4866
5099
|
<returns>A new <see cref="T:IronPdf.PdfDocument"/></returns>
|
|
4867
5100
|
</member>
|
|
5101
|
+
<member name="P:IronPdf.PdfDocument.Fonts">
|
|
5102
|
+
<summary>
|
|
5103
|
+
PDF Document's Font collection management.
|
|
5104
|
+
</summary>
|
|
5105
|
+
</member>
|
|
4868
5106
|
<member name="M:IronPdf.PdfDocument.AddTextFooters(IronPdf.TextHeaderFooter,System.Int32,System.Collections.Generic.IEnumerable{System.Int32})">
|
|
4869
5107
|
<summary>
|
|
4870
5108
|
Stamps page footers on top of an existing Pdf.
|
|
@@ -4999,6 +5237,26 @@
|
|
|
4999
5237
|
<param name="DesiredHeight">Desired Height</param>
|
|
5000
5238
|
<param name="PixelFormat">Pixel format</param>
|
|
5001
5239
|
</member>
|
|
5240
|
+
<member name="M:IronPdf.PdfDocument.DrawLine(System.Int32,IronSoftware.Drawing.PointF,IronSoftware.Drawing.PointF,System.Double,IronSoftware.Drawing.Color)">
|
|
5241
|
+
<summary>
|
|
5242
|
+
Draw a line using the specified parameters
|
|
5243
|
+
</summary>
|
|
5244
|
+
<param name="PageIndex">Page index</param>
|
|
5245
|
+
<param name="Start">Start coordinate</param>
|
|
5246
|
+
<param name="End">End coordinate</param>
|
|
5247
|
+
<param name="Width">Line width</param>
|
|
5248
|
+
<param name="Color">Line color</param>
|
|
5249
|
+
</member>
|
|
5250
|
+
<member name="M:IronPdf.PdfDocument.DrawRectangle(System.Int32,IronSoftware.Drawing.RectangleF,IronSoftware.Drawing.Color,IronSoftware.Drawing.Color,System.Double)">
|
|
5251
|
+
<summary>
|
|
5252
|
+
Draw a rectangle using the specified parameters
|
|
5253
|
+
</summary>
|
|
5254
|
+
<param name="PageIndex">Page index</param>
|
|
5255
|
+
<param name="Rect">Rectangle</param>
|
|
5256
|
+
<param name="LineColor">Line color</param>
|
|
5257
|
+
<param name="FillColor">Fill color</param>
|
|
5258
|
+
<param name="Width">Line width</param>
|
|
5259
|
+
</member>
|
|
5002
5260
|
<member name="M:IronPdf.PdfDocument.DrawBitmap(IronSoftware.Drawing.AnyBitmap,System.Collections.Generic.IEnumerable{System.Int32},System.Collections.Generic.IEnumerable{System.Double},System.Collections.Generic.IEnumerable{System.Double},System.Collections.Generic.IEnumerable{System.Double},System.Collections.Generic.IEnumerable{System.Double},IronPdf.PixelFormat)">
|
|
5003
5261
|
<summary>
|
|
5004
5262
|
Draw a bitmap multiple times according to the specified parameters; all occurrences of the bitmap will share a single data stream
|
|
@@ -5160,7 +5418,7 @@
|
|
|
5160
5418
|
<param name="Password">Document password</param>
|
|
5161
5419
|
<param name="OwnerPassword">Document owner password</param>
|
|
5162
5420
|
</member>
|
|
5163
|
-
<member name="M:IronPdf.PdfDocument.#ctor(System.String,System.String,System.String,
|
|
5421
|
+
<member name="M:IronPdf.PdfDocument.#ctor(System.String,System.String,System.String,IronPdf.Rendering.ChangeTrackingModes)">
|
|
5164
5422
|
<summary>
|
|
5165
5423
|
Opens an existing PDF document for editing.
|
|
5166
5424
|
<br/><para>Adding a using declaration is not required. But can be used if you want to explicitly dispose. See: https://ironpdf.com/troubleshooting/ironpdf-using/</para>
|
|
@@ -5172,7 +5430,7 @@
|
|
|
5172
5430
|
<exception cref="T:System.IO.IOException">Exception thrown if can not be opened.</exception>
|
|
5173
5431
|
<exception cref="T:System.ArgumentException"><paramref name="PdfFilePath"/> is null, empty, or consists only of white-space characters.</exception>
|
|
5174
5432
|
</member>
|
|
5175
|
-
<member name="M:IronPdf.PdfDocument.#ctor(System.Uri,System.String,System.String,
|
|
5433
|
+
<member name="M:IronPdf.PdfDocument.#ctor(System.Uri,System.String,System.String,IronPdf.Rendering.ChangeTrackingModes)">
|
|
5176
5434
|
<summary>
|
|
5177
5435
|
Opens an existing PDF document from the specified Uri for editing.
|
|
5178
5436
|
<br/><para>Adding a using declaration is not required. But can be used if you want to explicitly dispose. See: https://ironpdf.com/troubleshooting/ironpdf-using/</para>
|
|
@@ -5183,7 +5441,7 @@
|
|
|
5183
5441
|
<param name="TrackChanges">Optionally track changes to the document (for use with incremental saves)</param>
|
|
5184
5442
|
<exception cref="T:IronPdf.Exceptions.IronPdfProductException">Exception thrown if PDF cannot be found at URI or if password is incorrect.</exception>
|
|
5185
5443
|
</member>
|
|
5186
|
-
<member name="M:IronPdf.PdfDocument.#ctor(System.IO.Stream,System.String,System.String,
|
|
5444
|
+
<member name="M:IronPdf.PdfDocument.#ctor(System.IO.Stream,System.String,System.String,IronPdf.Rendering.ChangeTrackingModes)">
|
|
5187
5445
|
<summary>
|
|
5188
5446
|
Opens an existing PDF document for editing.
|
|
5189
5447
|
<br/><para>Adding a using declaration is not required. But can be used if you want to explicitly dispose. See: https://ironpdf.com/troubleshooting/ironpdf-using/</para>
|
|
@@ -5194,7 +5452,7 @@
|
|
|
5194
5452
|
<param name="TrackChanges">Optionally track changes to the document (for use with incremental saves)</param>
|
|
5195
5453
|
<exception cref="T:System.IO.IOException">Exception thrown if can not be opened.</exception>
|
|
5196
5454
|
</member>
|
|
5197
|
-
<member name="M:IronPdf.PdfDocument.#ctor(System.Byte[],System.String,System.String,
|
|
5455
|
+
<member name="M:IronPdf.PdfDocument.#ctor(System.Byte[],System.String,System.String,IronPdf.Rendering.ChangeTrackingModes)">
|
|
5198
5456
|
<summary>
|
|
5199
5457
|
Opens an existing PDF document for editing.
|
|
5200
5458
|
<br/><para>Adding a using declaration is not required. But can be used if you want to explicitly dispose. See: https://ironpdf.com/troubleshooting/ironpdf-using/</para>
|
|
@@ -5226,7 +5484,7 @@
|
|
|
5226
5484
|
<exception cref="T:IronPdf.Exceptions.IronPdfProductException">Exception thrown if cannot read the PDF due to incorrect uri or password.</exception>
|
|
5227
5485
|
<returns>An IronPdf.PdfDocument object as loaded from the file path.</returns>
|
|
5228
5486
|
</member>
|
|
5229
|
-
<member name="M:IronPdf.PdfDocument.FromFile(System.String,System.String,System.String,
|
|
5487
|
+
<member name="M:IronPdf.PdfDocument.FromFile(System.String,System.String,System.String,IronPdf.Rendering.ChangeTrackingModes)">
|
|
5230
5488
|
<summary>
|
|
5231
5489
|
Opens an existing PDF document for editing.
|
|
5232
5490
|
<br/><para>Adding a using declaration is not required. But can be used if you want to explicitly dispose. See: https://ironpdf.com/troubleshooting/ironpdf-using/</para>
|
|
@@ -5900,11 +6158,12 @@
|
|
|
5900
6158
|
<param name="rotation">Rotates the watermark clockwise from 0 to 360 degrees as specified.</param>
|
|
5901
6159
|
<returns>Returns this <see cref="T:IronPdf.PdfDocument"/>, allowing for a 'fluent' (LINQ like) chained in-line code style</returns>
|
|
5902
6160
|
</member>
|
|
5903
|
-
<member name="M:IronPdf.PdfDocument.ExtractAllText">
|
|
6161
|
+
<member name="M:IronPdf.PdfDocument.ExtractAllText(IronPdf.TextExtractionOrder)">
|
|
5904
6162
|
<summary>
|
|
5905
6163
|
Extracts the written text content from the PDF and returns it as a string. <para>Pages are be separated by 4
|
|
5906
6164
|
consecutive Environment.NewLines</para>
|
|
5907
6165
|
</summary>
|
|
6166
|
+
<param name="Order">Determines order of how text is extracted from each page (see <seealso cref="T:IronPdf.TextExtractionOrder"/></param>
|
|
5908
6167
|
<returns>
|
|
5909
6168
|
All text in the PDF as a string.
|
|
5910
6169
|
</returns>
|
|
@@ -5913,7 +6172,15 @@
|
|
|
5913
6172
|
<summary>
|
|
5914
6173
|
Extracts the text content from one page of the PDF and returns it as a string.
|
|
5915
6174
|
</summary>
|
|
5916
|
-
<param name="
|
|
6175
|
+
<param name="PageIndex">Index of the page. Note: Page 1 has index 0...</param>
|
|
6176
|
+
<returns>The text extracted from the PDF page as a string.</returns>
|
|
6177
|
+
</member>
|
|
6178
|
+
<member name="M:IronPdf.PdfDocument.ExtractTextFromPage(System.Int32,IronPdf.TextExtractionOrder)">
|
|
6179
|
+
<summary>
|
|
6180
|
+
Extracts the text content from one page of the PDF and returns it as a string.
|
|
6181
|
+
</summary>
|
|
6182
|
+
<param name="PageIndex">Index of the page. Note: Page 1 has index 0...</param>
|
|
6183
|
+
<param name="Order">Determines order of how text is extracted from each page (see <seealso cref="T:IronPdf.TextExtractionOrder"/></param>
|
|
5917
6184
|
<returns>The text extracted from the PDF page as a string.</returns>
|
|
5918
6185
|
</member>
|
|
5919
6186
|
<member name="M:IronPdf.PdfDocument.ExtractTextFromPages(System.Collections.Generic.IEnumerable{System.Int32})">
|
|
@@ -5921,16 +6188,26 @@
|
|
|
5921
6188
|
Extracts the written text content from specified pages in the PDF PDF and returns it as a string. Pages
|
|
5922
6189
|
will be separated by 4 consecutive Environment.NewLines
|
|
5923
6190
|
</summary>
|
|
5924
|
-
<param name="
|
|
6191
|
+
<param name="PageIndices">An IEnumerable list of page indexes.</param>
|
|
6192
|
+
<returns>The text extracted from the PDF pages as a string.</returns>
|
|
6193
|
+
</member>
|
|
6194
|
+
<member name="M:IronPdf.PdfDocument.ExtractTextFromPages(System.Collections.Generic.IEnumerable{System.Int32},IronPdf.TextExtractionOrder)">
|
|
6195
|
+
<summary>
|
|
6196
|
+
Extracts the written text content from specified pages in the PDF PDF and returns it as a string. Pages
|
|
6197
|
+
will be separated by 4 consecutive Environment.NewLines
|
|
6198
|
+
</summary>
|
|
6199
|
+
<param name="PageIndices">An IEnumerable list of page indexes.</param>
|
|
6200
|
+
<param name="Order">Determines order of how text is extracted from each page (see <seealso cref="T:IronPdf.TextExtractionOrder"/></param>
|
|
5925
6201
|
<returns>The text extracted from the PDF pages as a string.</returns>
|
|
5926
6202
|
</member>
|
|
5927
|
-
<member name="M:IronPdf.PdfDocument.ExtractTextFromPages(System.Int32,System.Int32)">
|
|
6203
|
+
<member name="M:IronPdf.PdfDocument.ExtractTextFromPages(System.Int32,System.Int32,IronPdf.TextExtractionOrder)">
|
|
5928
6204
|
<summary>
|
|
5929
6205
|
Extracts the written text content from a range of pages within the PDF and returns it as a string. Pages
|
|
5930
6206
|
will be separated by 4 consecutive Environment.NewLines
|
|
5931
6207
|
</summary>
|
|
5932
|
-
<param name="
|
|
5933
|
-
<param name="
|
|
6208
|
+
<param name="StartIndex">The start page index. Note: Page 1 has index 0</param>
|
|
6209
|
+
<param name="EndIndex">The end page index. Note: The last page has index <c>PageCount -1</c></param>
|
|
6210
|
+
<param name="Order">Determines order of how text is extracted from each page (see <seealso cref="T:IronPdf.TextExtractionOrder"/></param>
|
|
5934
6211
|
<returns>The text extracted from the PDF pages as a string.</returns>
|
|
5935
6212
|
</member>
|
|
5936
6213
|
<member name="M:IronPdf.PdfDocument.GetInstalledFonts">
|
|
@@ -5943,24 +6220,24 @@
|
|
|
5943
6220
|
<summary>
|
|
5944
6221
|
Replace the specified old text with new text on a given page
|
|
5945
6222
|
</summary>
|
|
5946
|
-
<param name="
|
|
5947
|
-
<param name="
|
|
5948
|
-
<param name="
|
|
6223
|
+
<param name="PageIndex">Page index to search for old text to replace</param>
|
|
6224
|
+
<param name="OldText">Old text to remove</param>
|
|
6225
|
+
<param name="NewText">New text to add</param>
|
|
5949
6226
|
</member>
|
|
5950
6227
|
<member name="M:IronPdf.PdfDocument.ReplaceTextOnPages(System.Int32[],System.String,System.String)">
|
|
5951
6228
|
<summary>
|
|
5952
6229
|
Replace the specified old text with new text on specified pages
|
|
5953
6230
|
</summary>
|
|
5954
|
-
<param name="
|
|
5955
|
-
<param name="
|
|
5956
|
-
<param name="
|
|
6231
|
+
<param name="PageIndices">Indexes if pages to search for old text to replace</param>
|
|
6232
|
+
<param name="OldText">Old text to remove</param>
|
|
6233
|
+
<param name="NewText">New text to add</param>
|
|
5957
6234
|
</member>
|
|
5958
6235
|
<member name="M:IronPdf.PdfDocument.ReplaceTextOnAllPages(System.String,System.String)">
|
|
5959
6236
|
<summary>
|
|
5960
6237
|
Replace the specified old text with new text on all pages
|
|
5961
6238
|
</summary>
|
|
5962
|
-
<param name="
|
|
5963
|
-
<param name="
|
|
6239
|
+
<param name="OldText">Old text to remove</param>
|
|
6240
|
+
<param name="NewText">New text to add</param>
|
|
5964
6241
|
</member>
|
|
5965
6242
|
<member name="M:IronPdf.PdfDocument.ToBitmap(System.Int32)">
|
|
5966
6243
|
<summary>
|
|
@@ -6371,6 +6648,53 @@
|
|
|
6371
6648
|
<param name="LicenseKey">IronPDF license key as a string</param>
|
|
6372
6649
|
<returns>True if the license key given is valid.</returns>
|
|
6373
6650
|
</member>
|
|
6651
|
+
<member name="T:IronPdf.Pages.LineTextObject">
|
|
6652
|
+
<summary>
|
|
6653
|
+
Represents a line of text within a document
|
|
6654
|
+
</summary>
|
|
6655
|
+
</member>
|
|
6656
|
+
<member name="P:IronPdf.Pages.LineTextObject.PdfDocumentId">
|
|
6657
|
+
<inheritdoc/>
|
|
6658
|
+
</member>
|
|
6659
|
+
<member name="P:IronPdf.Pages.LineTextObject.ObjNum">
|
|
6660
|
+
<inheritdoc/>
|
|
6661
|
+
</member>
|
|
6662
|
+
<member name="P:IronPdf.Pages.LineTextObject.Left">
|
|
6663
|
+
<inheritdoc/>
|
|
6664
|
+
</member>
|
|
6665
|
+
<member name="P:IronPdf.Pages.LineTextObject.Right">
|
|
6666
|
+
<inheritdoc/>
|
|
6667
|
+
</member>
|
|
6668
|
+
<member name="P:IronPdf.Pages.LineTextObject.Top">
|
|
6669
|
+
<inheritdoc/>
|
|
6670
|
+
</member>
|
|
6671
|
+
<member name="P:IronPdf.Pages.LineTextObject.Bottom">
|
|
6672
|
+
<inheritdoc/>
|
|
6673
|
+
</member>
|
|
6674
|
+
<member name="P:IronPdf.Pages.LineTextObject.Contents">
|
|
6675
|
+
<inheritdoc/>
|
|
6676
|
+
</member>
|
|
6677
|
+
<member name="P:IronPdf.Pages.LineTextObject.Color">
|
|
6678
|
+
<inheritdoc/>
|
|
6679
|
+
</member>
|
|
6680
|
+
<member name="M:IronPdf.Pages.LineTextObject.#ctor(IronSoftware.IPdfDocumentId,IronSoftware.IDocumentTextObject)">
|
|
6681
|
+
<summary>
|
|
6682
|
+
Create a new line text object and add the specified chunk
|
|
6683
|
+
</summary>
|
|
6684
|
+
<param name="id">Document identifier</param>
|
|
6685
|
+
<param name="chunk">Chunk to add</param>
|
|
6686
|
+
</member>
|
|
6687
|
+
<member name="M:IronPdf.Pages.LineTextObject.AddChunk(IronSoftware.IDocumentTextObject)">
|
|
6688
|
+
<summary>
|
|
6689
|
+
Add a text object to this line
|
|
6690
|
+
</summary>
|
|
6691
|
+
<param name="chunk">Text object to add</param>
|
|
6692
|
+
</member>
|
|
6693
|
+
<member name="M:IronPdf.Pages.LineTextObject.ParseChunks">
|
|
6694
|
+
<summary>
|
|
6695
|
+
Parse all chunks to generate aggregate properties of the line
|
|
6696
|
+
</summary>
|
|
6697
|
+
</member>
|
|
6374
6698
|
<member name="T:IronPdf.Pages.PdfPage">
|
|
6375
6699
|
<summary>
|
|
6376
6700
|
A class which represents one page of a PDF Document.
|
|
@@ -6406,6 +6730,37 @@
|
|
|
6406
6730
|
Gets the page index
|
|
6407
6731
|
</summary>
|
|
6408
6732
|
</member>
|
|
6733
|
+
<member name="P:IronPdf.Pages.PdfPage.Characters">
|
|
6734
|
+
<summary>
|
|
6735
|
+
A collection of all characters on this page and their position
|
|
6736
|
+
<para>
|
|
6737
|
+
Also see <seealso cref="P:IronPdf.Pages.PdfPage.TextChunks"/> and <seealso cref="P:IronPdf.Pages.PdfPage.Lines"/>
|
|
6738
|
+
</para>
|
|
6739
|
+
</summary>
|
|
6740
|
+
</member>
|
|
6741
|
+
<member name="P:IronPdf.Pages.PdfPage.TextChunks">
|
|
6742
|
+
<summary>
|
|
6743
|
+
A collection of all text objects on this page and their position
|
|
6744
|
+
<para>
|
|
6745
|
+
The contents of each text object is rendered as a single unit
|
|
6746
|
+
</para>
|
|
6747
|
+
<para>
|
|
6748
|
+
The contents of each text object share font, origin position, etc.
|
|
6749
|
+
</para>
|
|
6750
|
+
<para>
|
|
6751
|
+
Also see <seealso cref="P:IronPdf.Pages.PdfPage.Characters"/> and <seealso cref="P:IronPdf.Pages.PdfPage.Lines"/>
|
|
6752
|
+
</para>
|
|
6753
|
+
</summary>
|
|
6754
|
+
</member>
|
|
6755
|
+
<member name="P:IronPdf.Pages.PdfPage.Lines">
|
|
6756
|
+
<summary>
|
|
6757
|
+
A collection of all lines of text on this page and their position
|
|
6758
|
+
</summary>
|
|
6759
|
+
<para>
|
|
6760
|
+
Also see <seealso cref="P:IronPdf.Pages.PdfPage.TextChunks"/> and <seealso cref="P:IronPdf.Pages.PdfPage.Characters"/>
|
|
6761
|
+
</para>
|
|
6762
|
+
<remarks>Derived from <see cref="P:IronPdf.Pages.PdfPage.TextChunks"/> for your convenience</remarks>
|
|
6763
|
+
</member>
|
|
6409
6764
|
<member name="T:IronPdf.Pages.PdfPagesCollection">
|
|
6410
6765
|
<summary>
|
|
6411
6766
|
Class for managing the collection of <see cref="T:IronPdf.Pages.PdfPage"/> elements.
|
|
@@ -6517,7 +6872,7 @@
|
|
|
6517
6872
|
</member>
|
|
6518
6873
|
<member name="P:IronPdf.HtmlFormatOptions.BackgroundColor">
|
|
6519
6874
|
<summary>
|
|
6520
|
-
The background color of the HTML body. Default is
|
|
6875
|
+
The background color of the HTML body. Default is white.
|
|
6521
6876
|
</summary>
|
|
6522
6877
|
</member>
|
|
6523
6878
|
<member name="P:IronPdf.HtmlFormatOptions.PdfPageMargin">
|
|
@@ -6527,7 +6882,7 @@
|
|
|
6527
6882
|
</member>
|
|
6528
6883
|
<member name="P:IronPdf.HtmlFormatOptions.H1Color">
|
|
6529
6884
|
<summary>
|
|
6530
|
-
The color of the title (h1) in the HTML document. Default is
|
|
6885
|
+
The color of the title (h1) in the HTML document. Default is black.
|
|
6531
6886
|
</summary>
|
|
6532
6887
|
</member>
|
|
6533
6888
|
<member name="P:IronPdf.HtmlFormatOptions.H1FontSize">
|
|
@@ -6592,6 +6947,23 @@
|
|
|
6592
6947
|
PDF/UA-1 Version
|
|
6593
6948
|
</summary>
|
|
6594
6949
|
</member>
|
|
6950
|
+
<member name="T:IronPdf.TextExtractionOrder">
|
|
6951
|
+
<summary>
|
|
6952
|
+
Strategy for determining word order when extracting text
|
|
6953
|
+
</summary>
|
|
6954
|
+
</member>
|
|
6955
|
+
<member name="F:IronPdf.TextExtractionOrder.VisualOrder">
|
|
6956
|
+
<summary>
|
|
6957
|
+
Text is extracted in order of appearance on the document, from top left to bottom right
|
|
6958
|
+
</summary>
|
|
6959
|
+
<remarks>Useful for documents which have been heavily modified after original creation</remarks>
|
|
6960
|
+
</member>
|
|
6961
|
+
<member name="F:IronPdf.TextExtractionOrder.LogicalOrder">
|
|
6962
|
+
<summary>
|
|
6963
|
+
Text is extracted in the order it was originally drawn onto the document
|
|
6964
|
+
</summary>
|
|
6965
|
+
<remarks>Useful for documents which may have complicated layouts which should be retained (e.g. columns)</remarks>
|
|
6966
|
+
</member>
|
|
6595
6967
|
<member name="T:IronPdf.PdfDocumentExtensions">
|
|
6596
6968
|
<summary>
|
|
6597
6969
|
Extension methods for PdfDocument class
|
|
@@ -6888,26 +7260,13 @@
|
|
|
6888
7260
|
<c>true</c> if successful.
|
|
6889
7261
|
</returns>
|
|
6890
7262
|
</member>
|
|
6891
|
-
<member name="
|
|
6892
|
-
<summary>
|
|
6893
|
-
Table of contents layout type
|
|
6894
|
-
</summary>
|
|
6895
|
-
</member>
|
|
6896
|
-
<member name="F:IronPdf.TableOfContentsTypes.None">
|
|
6897
|
-
<summary>
|
|
6898
|
-
Do not create a table of contents
|
|
6899
|
-
</summary>
|
|
6900
|
-
</member>
|
|
6901
|
-
<member name="F:IronPdf.TableOfContentsTypes.Basic">
|
|
6902
|
-
<summary>
|
|
6903
|
-
Create a table of contents without page numbers
|
|
6904
|
-
</summary>
|
|
6905
|
-
<remarks>More performant, but does not include page numbers</remarks>
|
|
6906
|
-
</member>
|
|
6907
|
-
<member name="F:IronPdf.TableOfContentsTypes.WithPageNumbers">
|
|
7263
|
+
<member name="M:IronPdf.TableOfContents.TableOfContentsCssMerger.MergeCss(System.String,System.String)">
|
|
6908
7264
|
<summary>
|
|
6909
|
-
|
|
7265
|
+
Merge a source CSS file into a target CSS file.
|
|
6910
7266
|
</summary>
|
|
7267
|
+
<param name="tableOfContentsCss">The source CSS file.</param>
|
|
7268
|
+
<param name="customCss">The target CSS file which will be updated with values from source CSS file.</param>
|
|
7269
|
+
<returns>A CSS string in which the tableOfContentsCss is merged with the customCss.</returns>
|
|
6911
7270
|
</member>
|
|
6912
7271
|
<member name="M:IronPdf.TableOfContents.TableOfContentsHelper.ParseHeaderPageNumbers(IronPdf.PdfDocument,System.String)">
|
|
6913
7272
|
<summary>
|
|
@@ -6933,6 +7292,27 @@
|
|
|
6933
7292
|
<param name="html">The HTML to parse headers from.</param>
|
|
6934
7293
|
<returns>A queue of header titles.</returns>
|
|
6935
7294
|
</member>
|
|
7295
|
+
<member name="T:IronPdf.TableOfContentsTypes">
|
|
7296
|
+
<summary>
|
|
7297
|
+
Table of contents layout type
|
|
7298
|
+
</summary>
|
|
7299
|
+
</member>
|
|
7300
|
+
<member name="F:IronPdf.TableOfContentsTypes.None">
|
|
7301
|
+
<summary>
|
|
7302
|
+
Do not create a table of contents
|
|
7303
|
+
</summary>
|
|
7304
|
+
</member>
|
|
7305
|
+
<member name="F:IronPdf.TableOfContentsTypes.Basic">
|
|
7306
|
+
<summary>
|
|
7307
|
+
Create a table of contents without page numbers
|
|
7308
|
+
</summary>
|
|
7309
|
+
<remarks>More performant, but does not include page numbers</remarks>
|
|
7310
|
+
</member>
|
|
7311
|
+
<member name="F:IronPdf.TableOfContentsTypes.WithPageNumbers">
|
|
7312
|
+
<summary>
|
|
7313
|
+
Create a table of contents WITH page numbers
|
|
7314
|
+
</summary>
|
|
7315
|
+
</member>
|
|
6936
7316
|
<member name="T:IronPdf.TextHeaderFooter">
|
|
6937
7317
|
<summary>
|
|
6938
7318
|
Defines PDF Header and Footer display options.
|
|
@@ -6959,7 +7339,7 @@
|
|
|
6959
7339
|
</member>
|
|
6960
7340
|
<member name="P:IronPdf.TextHeaderFooter.Font">
|
|
6961
7341
|
<summary>
|
|
6962
|
-
Font family <see cref="T:IronSoftware.Drawing.FontTypes"/>. Default is <see cref="P:IronSoftware.Drawing.FontTypes.
|
|
7342
|
+
Font family <see cref="T:IronSoftware.Drawing.FontTypes"/>. Default is <see cref="P:IronSoftware.Drawing.FontTypes.Helvetica"/>
|
|
6963
7343
|
</summary>
|
|
6964
7344
|
</member>
|
|
6965
7345
|
<member name="P:IronPdf.TextHeaderFooter.FontSize">
|