@ironsoftware/ironpdf-engine-windows-x64 2023.10.1 → 2024.1.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.1.20/IronCefSubprocess.exe +0 -0
- package/ironpdf-engine-bin-2024.1.20/IronInterop.dll +0 -0
- package/ironpdf-engine-bin-2024.1.20/IronPdf.pdb +0 -0
- package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/IronPdf.xml +629 -171
- package/ironpdf-engine-bin-2024.1.20/IronPdfEngine.Proto.pdb +0 -0
- package/ironpdf-engine-bin-2024.1.20/IronPdfEngine.pdb +0 -0
- package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/IronPdfEngineConsole.exe +0 -0
- package/ironpdf-engine-bin-2024.1.20/IronPdfEngineConsole.pdb +0 -0
- package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/IronPdfInterop.dll +0 -0
- package/ironpdf-engine-bin-2024.1.20/OpenXmlPowerTools.pdb +0 -0
- package/package.json +2 -2
- package/ironpdf-engine-bin-2023.10.3/IronCefSubprocess.exe +0 -0
- package/ironpdf-engine-bin-2023.10.3/IronInterop.dll +0 -0
- package/ironpdf-engine-bin-2023.10.3/IronPdf.pdb +0 -0
- package/ironpdf-engine-bin-2023.10.3/IronPdfEngine.Proto.pdb +0 -0
- package/ironpdf-engine-bin-2023.10.3/IronPdfEngine.pdb +0 -0
- package/ironpdf-engine-bin-2023.10.3/IronPdfEngineConsole.pdb +0 -0
- package/ironpdf-engine-bin-2023.10.3/OpenXmlPowerTools.pdb +0 -0
- package/ironpdf-engine-bin-2023.10.3/Pdfium.Native.deployment.json +0 -14
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/Chrome.Native.deployment.json +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/api-ms-win-crt-convert-l1-1-0.dll +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/api-ms-win-crt-environment-l1-1-0.dll +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/api-ms-win-crt-filesystem-l1-1-0.dll +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/api-ms-win-crt-heap-l1-1-0.dll +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/api-ms-win-crt-locale-l1-1-0.dll +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/api-ms-win-crt-math-l1-1-0.dll +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/api-ms-win-crt-runtime-l1-1-0.dll +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/api-ms-win-crt-stdio-l1-1-0.dll +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/api-ms-win-crt-string-l1-1-0.dll +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/api-ms-win-crt-time-l1-1-0.dll +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/api-ms-win-crt-utility-l1-1-0.dll +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/chrome_100_percent.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/chrome_200_percent.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/chrome_elf.dll +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/concrt140.dll +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/d3dcompiler_47.dll +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/dxva2.dll +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/grpc_csharp_ext.x64.dll +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/icudtl.dat +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/libEGL.dll +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/libGLESv2.dll +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/libcef.dll +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/af.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/am.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/ar.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/bg.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/bn.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/ca.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/cs.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/da.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/de.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/el.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/en-GB.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/en-US.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/es-419.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/es.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/et.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/fa.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/fi.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/fil.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/fr.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/gu.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/he.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/hi.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/hr.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/hu.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/id.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/it.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/ja.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/kn.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/ko.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/lt.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/lv.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/ml.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/mr.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/ms.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/nb.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/nl.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/pl.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/pt-BR.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/pt-PT.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/ro.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/ru.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/sk.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/sl.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/sr.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/sv.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/sw.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/ta.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/te.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/th.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/tr.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/uk.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/ur.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/vi.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/zh-CN.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/locales/zh-TW.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/msvcp140.dll +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/msvcp140_1.dll +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/msvcp140_2.dll +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/msvcp140_atomic_wait.dll +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/msvcp140_codecvt_ids.dll +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/resources.pak +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/snapshot_blob.bin +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/ucrtbase.dll +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/v8_context_snapshot.bin +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/vcruntime140.dll +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/vcruntime140_1.dll +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/vk_swiftshader.dll +0 -0
- /package/{ironpdf-engine-bin-2023.10.3 → ironpdf-engine-bin-2024.1.20}/vulkan-1.dll +0 -0
|
@@ -577,6 +577,11 @@
|
|
|
577
577
|
</summary>
|
|
578
578
|
<param name="url">Url to apply cookies to</param>
|
|
579
579
|
<param name="cookies">Cookies to apply</param>
|
|
580
|
+
<remarks>Automatically sets default <see cref="P:IronPdf.ChromePdfRenderOptions.RequestContext"/> of future renders to <seealso cref="F:IronPdf.Rendering.RequestContexts.Global"/>
|
|
581
|
+
<para>
|
|
582
|
+
Very sensitive to the correct base URL, often times setting <seealso cref="F:IronPdf.ChromePdfRenderOptions.CustomCookies"/> will yield better results
|
|
583
|
+
</para>
|
|
584
|
+
</remarks>
|
|
580
585
|
</member>
|
|
581
586
|
<member name="M:IronPdf.ChromePdfRenderer.RenderPdfDocumentFromFile(IronPdf.ChromePdfRenderOptions,IronPdf.ChromeHttpLoginCredentials,System.String)">
|
|
582
587
|
<summary>
|
|
@@ -933,7 +938,7 @@
|
|
|
933
938
|
<summary>
|
|
934
939
|
Defaults to <see cref="F:IronPdf.Rendering.RequestContexts.Isolated"/>
|
|
935
940
|
<para>
|
|
936
|
-
Uses <see cref="F:IronPdf.Rendering.RequestContexts.Global"/> if the user has ever invoked <see cref="
|
|
941
|
+
Uses <see cref="F:IronPdf.Rendering.RequestContexts.Global"/> if the user has ever invoked <see cref="T:IronPdf.Engines.Chrome.ChromeInterop.UnmanagedDelegates.ApplyCookies"/>
|
|
937
942
|
</para>
|
|
938
943
|
</summary>
|
|
939
944
|
</member>
|
|
@@ -1372,6 +1377,7 @@
|
|
|
1372
1377
|
<member name="P:IronPdf.ChromePdfRenderOptions.UseMarginsOnHeaderAndFooter">
|
|
1373
1378
|
<summary>
|
|
1374
1379
|
Use margin values from the main document when rendering headers and footers
|
|
1380
|
+
<para>This value is ignored when header and footer heights are autosized. Autosizing happens when a header or footer <see cref="P:IronPdf.HtmlHeaderFooter.MaxHeight">MaxHeight</see> value is null.</para>
|
|
1375
1381
|
</summary>
|
|
1376
1382
|
</member>
|
|
1377
1383
|
<member name="P:IronPdf.ChromePdfRenderOptions.CreatePdfFormsFromHtml">
|
|
@@ -1440,6 +1446,11 @@
|
|
|
1440
1446
|
<para>Default value is 1.</para>
|
|
1441
1447
|
</summary>
|
|
1442
1448
|
</member>
|
|
1449
|
+
<member name="P:IronPdf.ChromePdfRenderOptions.TableOfContents">
|
|
1450
|
+
<summary>
|
|
1451
|
+
Generate a table of contents at the location in the HTML document where an element is found with id "ironpdf-toc".
|
|
1452
|
+
</summary>
|
|
1453
|
+
</member>
|
|
1443
1454
|
<member name="P:IronPdf.ChromePdfRenderOptions.GrayScale">
|
|
1444
1455
|
<summary>
|
|
1445
1456
|
Outputs a black-and-white PDF
|
|
@@ -1642,18 +1653,48 @@
|
|
|
1642
1653
|
Create a new Docx To PDF renderer.
|
|
1643
1654
|
</summary>
|
|
1644
1655
|
</member>
|
|
1645
|
-
<member name="M:IronPdf.DocxToPdfRenderer.RenderDocxAsPdf(System.String,IronPdf.DocxPdfRenderOptions
|
|
1656
|
+
<member name="M:IronPdf.DocxToPdfRenderer.RenderDocxAsPdf(System.String,IronPdf.DocxPdfRenderOptions)">
|
|
1646
1657
|
<summary>
|
|
1647
1658
|
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.
|
|
1648
1659
|
</summary>
|
|
1649
1660
|
<param name="WordDocumentPath">The word document full path to be rendered as a PDF.</param>
|
|
1650
1661
|
<param name="Options">An instance of <see cref="T:IronPdf.DocxPdfRenderOptions"/> that allows configuration of DocxRenderer "Docx to PDF" rendering parameters. </param>
|
|
1651
|
-
<
|
|
1662
|
+
<returns>
|
|
1663
|
+
A <see cref="T:IronPdf.PdfDocument"/> with the Docx rendered as its contents.
|
|
1664
|
+
</returns>
|
|
1665
|
+
</member>
|
|
1666
|
+
<member name="M:IronPdf.DocxToPdfRenderer.RenderDocxAsPdf(System.Byte[],IronPdf.DocxPdfRenderOptions)">
|
|
1667
|
+
<summary>
|
|
1668
|
+
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.
|
|
1669
|
+
</summary>
|
|
1670
|
+
<param name="WordDocumentBytes">The word document byte array to be rendered as a PDF.</param>
|
|
1671
|
+
<param name="Options">An instance of <see cref="T:IronPdf.DocxPdfRenderOptions"/> that allows configuration of DocxRenderer "Docx to PDF" rendering parameters. </param>
|
|
1672
|
+
<returns>
|
|
1673
|
+
A <see cref="T:IronPdf.PdfDocument"/> with the Docx rendered as its contents.
|
|
1674
|
+
</returns>
|
|
1675
|
+
</member>
|
|
1676
|
+
<member name="M:IronPdf.DocxToPdfRenderer.RenderDocxAsPdf(System.IO.Stream,IronPdf.DocxPdfRenderOptions)">
|
|
1677
|
+
<summary>
|
|
1678
|
+
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
|
+
</summary>
|
|
1680
|
+
<param name="WordDocumentStream">The word document stream to be rendered as a PDF.</param>
|
|
1681
|
+
<param name="Options">An instance of <see cref="T:IronPdf.DocxPdfRenderOptions"/> that allows configuration of DocxRenderer "Docx to PDF" rendering parameters. </param>
|
|
1652
1682
|
<returns>
|
|
1653
1683
|
A <see cref="T:IronPdf.PdfDocument"/> with the Docx rendered as its contents.
|
|
1654
1684
|
</returns>
|
|
1655
1685
|
</member>
|
|
1656
1686
|
<member name="M:IronPdf.DocxToPdfRenderer.RenderDocxAsPdfAsync(System.String,IronPdf.DocxPdfRenderOptions)">
|
|
1687
|
+
<summary>,
|
|
1688
|
+
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.
|
|
1689
|
+
<para> Async version of the RenderDocxAsPdf method.</para>
|
|
1690
|
+
</summary>
|
|
1691
|
+
<param name="WordDocumentPath">The word document full path to be rendered as a PDF.</param>
|
|
1692
|
+
<param name="Options">An instance of <see cref="T:IronPdf.DocxPdfRenderOptions"/> that allows configuration of DocxRenderer "Docx to PDF" rendering parameters. </param>
|
|
1693
|
+
<returns>
|
|
1694
|
+
A <see cref="T:IronPdf.PdfDocument"/> with the Docx rendered as its contents.
|
|
1695
|
+
</returns>
|
|
1696
|
+
</member>
|
|
1697
|
+
<member name="M:IronPdf.DocxToPdfRenderer.RenderDocxMailMergeAsPdfAsync``1(System.Collections.Generic.List{``0},System.String,IronPdf.DocxPdfRenderOptions)">
|
|
1657
1698
|
<summary>
|
|
1658
1699
|
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.
|
|
1659
1700
|
<para> Async version of the RenderDocxAsPdf method.</para>
|
|
@@ -1766,6 +1807,11 @@
|
|
|
1766
1807
|
</summary>
|
|
1767
1808
|
<remarks>By default, it will wait for nothing.</remarks>
|
|
1768
1809
|
</member>
|
|
1810
|
+
<member name="P:IronPdf.DocxPdfRenderOptions.MailMergePrintAllInOnePdfDocument">
|
|
1811
|
+
<summary>
|
|
1812
|
+
This option enables the renderer to append all merged documents into one PdfDocument. To print separate PdfDocuments corresponding to each contact, this option should be set to false.
|
|
1813
|
+
</summary>
|
|
1814
|
+
</member>
|
|
1769
1815
|
<member name="M:IronPdf.DocxPdfRenderOptions.SetCustomPaperSizeinCentimeters(System.Double,System.Double)">
|
|
1770
1816
|
<summary>
|
|
1771
1817
|
Set an output paper size for PDF pages. Dimensions are in Centimeters.
|
|
@@ -1795,15 +1841,6 @@
|
|
|
1795
1841
|
<param name="height">>Custom paper height in pixels/points.</param>
|
|
1796
1842
|
<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>
|
|
1797
1843
|
</member>
|
|
1798
|
-
<member name="P:IronPdf.DocxPdfRenderOptions.FitToPaperMode">
|
|
1799
|
-
<exclude/>
|
|
1800
|
-
</member>
|
|
1801
|
-
<member name="P:IronPdf.DocxPdfRenderOptions.DPI">
|
|
1802
|
-
<exclude/>
|
|
1803
|
-
</member>
|
|
1804
|
-
<member name="P:IronPdf.DocxPdfRenderOptions.JpegQuality">
|
|
1805
|
-
<exclude/>
|
|
1806
|
-
</member>
|
|
1807
1844
|
<member name="T:IronPdf.DOM.Encoding.EncodingsRegistry">
|
|
1808
1845
|
<summary>
|
|
1809
1846
|
|
|
@@ -3038,6 +3075,16 @@
|
|
|
3038
3075
|
Create a new local chrome client
|
|
3039
3076
|
</summary>
|
|
3040
3077
|
</member>
|
|
3078
|
+
<member name="M:IronPdf.Engines.Chrome.LocalChromeClient.MeasureHTML(System.String,System.Uri,System.String,IronPdf.ChromePdfRenderOptions)">
|
|
3079
|
+
<summary>
|
|
3080
|
+
Measure the size of an HTML fragment.
|
|
3081
|
+
</summary>
|
|
3082
|
+
<param name="html">The HTML fragment to measure.</param>
|
|
3083
|
+
<param name="baseUrl">Optional: a base URL.</param>
|
|
3084
|
+
<param name="proxy">Optional: a proxy.</param>
|
|
3085
|
+
<param name="renderOptions">Render options to use when rendering the HTML fragment.</param>
|
|
3086
|
+
<returns>The size of the HTML fragment.</returns>
|
|
3087
|
+
</member>
|
|
3041
3088
|
<member name="M:IronPdf.Engines.Chrome.LocalChromeClient.TrySubprocess(System.String)">
|
|
3042
3089
|
<summary>
|
|
3043
3090
|
Try to access CEF subprocess executable
|
|
@@ -3114,7 +3161,7 @@
|
|
|
3114
3161
|
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.
|
|
3115
3162
|
<para>A minimum width can be set to control scaling and also to ensure that responsive CSS rules are correctly applied.</para>
|
|
3116
3163
|
</summary>
|
|
3117
|
-
<param name="MinimumPixelWidth">A pixel based minimum
|
|
3164
|
+
<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>
|
|
3118
3165
|
</member>
|
|
3119
3166
|
<member name="M:IronPdf.Engines.Chrome.VirtualPaperLayoutManager.UseContinuousFeedRendering(System.Double,System.Int32)">
|
|
3120
3167
|
<summary>
|
|
@@ -3379,200 +3426,201 @@
|
|
|
3379
3426
|
</param>
|
|
3380
3427
|
<returns>A data URL which can be used as the src attribute of an HTML <img tag</returns>
|
|
3381
3428
|
</member>
|
|
3382
|
-
|
|
3429
|
+
<!-- Badly formed XML comment ignored for member "T:IronPdf.Fonts.PdfFontCollection" -->
|
|
3430
|
+
<member name="P:IronPdf.Fonts.PdfFontCollection.Count">
|
|
3383
3431
|
<summary>
|
|
3384
|
-
|
|
3432
|
+
Gets the total number of fonts referenced inside the PDF document.
|
|
3385
3433
|
</summary>
|
|
3386
|
-
<
|
|
3387
|
-
</member>
|
|
3388
|
-
<member name="M:IronPdf.Forms.CheckBoxField.#ctor(IronSoftware.IPdfDocumentId,System.Int32,System.String,System.String,System.Int32,IronPdf.Forms.FormFieldTypes,System.Double,System.Double,System.Double,System.Double)">
|
|
3389
|
-
excluded
|
|
3434
|
+
<returns>Number of fonts referenced inside the PDF document</returns>
|
|
3390
3435
|
</member>
|
|
3391
|
-
|
|
3436
|
+
<!-- Badly formed XML comment ignored for member "M:IronPdf.Fonts.PdfFontCollection.GetEnumerator" -->
|
|
3437
|
+
<!-- Badly formed XML comment ignored for member "P:IronPdf.Fonts.PdfFontCollection.Items" -->
|
|
3438
|
+
<!-- Badly formed XML comment ignored for member "P:IronPdf.Fonts.PdfFontCollection.ItemsReadOnly" -->
|
|
3439
|
+
<member name="P:IronPdf.Fonts.PdfFontCollection.Item(System.UInt32)">
|
|
3392
3440
|
<summary>
|
|
3393
|
-
Gets
|
|
3441
|
+
Gets a copy of <see cref="T:IronPdf.Fonts.FontInfo"/> whose <see cref="P:IronPdf.Fonts.FontInfo.ObjNum"/> equal to the specified object number.
|
|
3442
|
+
to the specified value.
|
|
3394
3443
|
</summary>
|
|
3395
|
-
<
|
|
3396
|
-
<c>true</c> if checked; otherwise, <c>false</c>.
|
|
3397
|
-
</value>
|
|
3398
|
-
</member>
|
|
3399
|
-
<member name="T:IronPdf.Forms.ComboBoxField">
|
|
3400
|
-
<summary>
|
|
3401
|
-
Represents a combo-box (drop down menu) in a PDF form.
|
|
3402
|
-
</summary>
|
|
3403
|
-
<seealso cref="T:IronPdf.Forms.FormField"/>
|
|
3404
|
-
</member>
|
|
3405
|
-
<member name="P:IronPdf.Forms.ComboBoxField.Options">
|
|
3406
|
-
<summary>
|
|
3407
|
-
Gets the available options for the combo-box in zero based index order.
|
|
3408
|
-
</summary>
|
|
3409
|
-
<value>
|
|
3410
|
-
The option names as strings.
|
|
3411
|
-
</value>
|
|
3412
|
-
</member>
|
|
3413
|
-
<member name="P:IronPdf.Forms.ComboBoxField.SelectedIndex">
|
|
3414
|
-
<summary>
|
|
3415
|
-
Gets the index of the selected option.
|
|
3416
|
-
</summary>
|
|
3417
|
-
<value>
|
|
3418
|
-
The index of the selected. 0 based.
|
|
3419
|
-
</value>
|
|
3420
|
-
</member>
|
|
3421
|
-
<member name="T:IronPdf.Forms.FormField">
|
|
3422
|
-
<summary>
|
|
3423
|
-
Generic base class from which all PDF Form fields are derived.
|
|
3424
|
-
</summary>
|
|
3425
|
-
</member>
|
|
3426
|
-
<member name="P:IronPdf.Forms.FormField.PdfDocumentId">
|
|
3427
|
-
This need to remove in IFormField first
|
|
3428
|
-
</member>
|
|
3429
|
-
<member name="M:IronPdf.Forms.FormField.ToString">
|
|
3430
|
-
<summary>
|
|
3431
|
-
Returns the value of this field.
|
|
3432
|
-
</summary>
|
|
3433
|
-
<returns>
|
|
3434
|
-
The value of this field.
|
|
3435
|
-
</returns>
|
|
3436
|
-
</member>
|
|
3437
|
-
<member name="P:IronPdf.Forms.FormField.AnnotationIndex">
|
|
3438
|
-
<summary>
|
|
3439
|
-
Index of annotation associated with this form field
|
|
3440
|
-
</summary>
|
|
3441
|
-
</member>
|
|
3442
|
-
<member name="P:IronPdf.Forms.FormField.FullName">
|
|
3443
|
-
<summary>
|
|
3444
|
-
Gets the fully qualified name of this field. This is constructed from all partial field names of the field and all of its ancestors.
|
|
3445
|
-
<para>
|
|
3446
|
-
Example 1: <code>parent's_full_name.child's_partial_name</code>
|
|
3447
|
-
Example 2: <code>PersonalData.Address.ZipCode</code>
|
|
3448
|
-
</para>
|
|
3449
|
-
</summary>
|
|
3450
|
-
<value>
|
|
3451
|
-
The fully qualified name as a string.
|
|
3452
|
-
</value>
|
|
3453
|
-
</member>
|
|
3454
|
-
<member name="P:IronPdf.Forms.FormField.Name">
|
|
3455
|
-
<summary>
|
|
3456
|
-
Gets the ID name of this field.
|
|
3457
|
-
</summary>
|
|
3458
|
-
<value>
|
|
3459
|
-
The name as a string.
|
|
3460
|
-
</value>
|
|
3444
|
+
<returns><see cref="T:IronPdf.Fonts.FontInfo"/> whose <see cref="P:IronPdf.Fonts.FontInfo.ObjNum"/> equal to the specified object number.</returns>
|
|
3461
3445
|
</member>
|
|
3462
|
-
|
|
3446
|
+
<!-- Badly formed XML comment ignored for member "P:IronPdf.Fonts.PdfFontCollection.Item(System.String)" -->
|
|
3447
|
+
<member name="M:IronPdf.Fonts.PdfFontCollection.ResolveStandardFontName(System.String)">
|
|
3463
3448
|
<summary>
|
|
3464
|
-
|
|
3449
|
+
Resolves a standard font name from the arbitrary standard font name that user expects to use.
|
|
3465
3450
|
</summary>
|
|
3451
|
+
<remarks>
|
|
3452
|
+
There are 14 Standard fonts that are guaranteed to be available when working with any PDF document via any PDF document reader tools.
|
|
3453
|
+
</remarks>
|
|
3454
|
+
<param name="arbitraryStandardFontName">Expected to use standard font name string</param>
|
|
3455
|
+
<returns>Resolved standard font name, or null if it cannot resolve to the correct one.</returns>
|
|
3466
3456
|
</member>
|
|
3467
|
-
<member name="
|
|
3457
|
+
<member name="M:IronPdf.Fonts.PdfFontCollection.GetStandardFontName(IronPdf.Fonts.StandardFont)">
|
|
3468
3458
|
<summary>
|
|
3469
|
-
Gets
|
|
3459
|
+
Gets a direct mapping of standard font name from the specified <see cref="T:IronPdf.Fonts.StandardFont"/>.
|
|
3470
3460
|
</summary>
|
|
3471
|
-
<
|
|
3472
|
-
<
|
|
3473
|
-
</value>
|
|
3461
|
+
<param name="font">Font enumeration as of type <see cref="T:IronPdf.Fonts.StandardFont"/>.</param>
|
|
3462
|
+
<returns>Always correct standard font name. Returned value won't never be null.</returns>
|
|
3474
3463
|
</member>
|
|
3475
|
-
<member name="
|
|
3464
|
+
<member name="M:IronPdf.Fonts.PdfFontCollection.Add(System.String)">
|
|
3476
3465
|
<summary>
|
|
3477
|
-
|
|
3466
|
+
Adds a font into a PDF document from the specified standard font name.
|
|
3478
3467
|
</summary>
|
|
3468
|
+
<param name="standardFontName">Standard font name</param>
|
|
3469
|
+
<returns><see cref="T:IronPdf.Fonts.FontInfo"/> if succeed, otherwise an exception thrown.</returns>
|
|
3479
3470
|
</member>
|
|
3480
|
-
<member name="
|
|
3471
|
+
<member name="M:IronPdf.Fonts.PdfFontCollection.Add(IronPdf.Fonts.StandardFont)">
|
|
3481
3472
|
<summary>
|
|
3482
|
-
|
|
3473
|
+
Adds a font into a PDF document from the specified standard font enumeration <see cref="!:StandadFont"/>.
|
|
3483
3474
|
</summary>
|
|
3484
|
-
<
|
|
3485
|
-
|
|
3486
|
-
</value>
|
|
3475
|
+
<param name="font">Standard font enuemration <see cref="T:IronPdf.Fonts.StandardFont"/></param>
|
|
3476
|
+
<returns><see cref="T:IronPdf.Fonts.FontInfo"/> if succeed, otherwise exception thrown.</returns>
|
|
3487
3477
|
</member>
|
|
3488
|
-
<member name="
|
|
3478
|
+
<member name="M:IronPdf.Fonts.PdfFontCollection.AddFromFilePath(System.String)">
|
|
3489
3479
|
<summary>
|
|
3490
|
-
|
|
3480
|
+
Adds, and embeds a font into a PDF document from the specified font's filepath.
|
|
3491
3481
|
</summary>
|
|
3482
|
+
<param name="fontFilePath">Font filepath</param>
|
|
3483
|
+
<returns><see cref="T:IronPdf.Fonts.FontInfo"/> if succeed, otherwise exception thrown.</returns>
|
|
3492
3484
|
</member>
|
|
3493
|
-
<member name="
|
|
3485
|
+
<member name="M:IronPdf.Fonts.PdfFontCollection.Add(System.Byte[],System.UInt32)">
|
|
3494
3486
|
<summary>
|
|
3495
|
-
|
|
3487
|
+
Adds, and embeds a font into a PDF document from the specified font's byte array.
|
|
3496
3488
|
</summary>
|
|
3489
|
+
<param name="fontData">Font data in byte array</param>
|
|
3490
|
+
<param name="size">Size in bytes of font's byte array data</param>
|
|
3491
|
+
<returns><see cref="T:IronPdf.Fonts.FontInfo"/> if succeed, otherwise exception thrown.</returns>
|
|
3497
3492
|
</member>
|
|
3498
|
-
<member name="
|
|
3493
|
+
<member name="M:IronPdf.Fonts.PdfFontCollection.Add(System.IO.Stream)">
|
|
3499
3494
|
<summary>
|
|
3500
|
-
|
|
3495
|
+
Adds, and embeds a font into a PDF document from the specified font's <see cref="T:System.IO.Stream"/>.
|
|
3501
3496
|
</summary>
|
|
3497
|
+
<param name="fontStream">Font stream</param>
|
|
3498
|
+
<returns><see cref="T:IronPdf.Fonts.FontInfo"/> if succeed, otherwise exception thrown.</returns>
|
|
3502
3499
|
</member>
|
|
3503
|
-
<member name="
|
|
3500
|
+
<member name="M:IronPdf.Fonts.PdfFontCollection.Replace(IronPdf.Fonts.FontInfo,System.String)">
|
|
3504
3501
|
<summary>
|
|
3505
|
-
|
|
3502
|
+
Replaces a font referenced from a PDF document with the specified standard font name.
|
|
3503
|
+
Supports replacing a target font which is either a simple font, or a composite font.
|
|
3506
3504
|
</summary>
|
|
3505
|
+
<param name="targetFont">Target <see cref="T:IronPdf.Fonts.FontInfo"/> to replace</param>
|
|
3506
|
+
<param name="newFontName">Standard font name which will be used to replace the target font</param>
|
|
3507
|
+
<remarks>
|
|
3508
|
+
This method won't embed the font.
|
|
3509
|
+
</remarks>
|
|
3510
|
+
<returns><see cref="T:IronPdf.Fonts.FontInfo"/> representing a replaced font if succeed, otherwise an exception thrown.</returns>
|
|
3507
3511
|
</member>
|
|
3508
|
-
<member name="M:IronPdf.
|
|
3512
|
+
<member name="M:IronPdf.Fonts.PdfFontCollection.Replace(IronPdf.Fonts.FontInfo,IronPdf.Fonts.StandardFont)">
|
|
3509
3513
|
<summary>
|
|
3510
|
-
|
|
3514
|
+
Replaces a font referenced from a PDF document with the specified <see cref="T:IronPdf.Fonts.StandardFont"/>.
|
|
3515
|
+
Supports replacing a target font which is either a simple font, or a composite font.
|
|
3511
3516
|
</summary>
|
|
3512
|
-
<param name="
|
|
3513
|
-
<param name="
|
|
3517
|
+
<param name="targetFont">Target <see cref="T:IronPdf.Fonts.FontInfo"/> to replace</param>
|
|
3518
|
+
<param name="newFont"><see cref="T:IronPdf.Fonts.StandardFont"/> representing a standard font used to replace the target font</param>
|
|
3519
|
+
<remarks>
|
|
3520
|
+
This method won't embed the font.
|
|
3521
|
+
</remarks>
|
|
3522
|
+
<returns><see cref="T:IronPdf.Fonts.FontInfo"/> representing a replaced font if succeed, otherwise an exception thrown.</returns>
|
|
3514
3523
|
</member>
|
|
3515
|
-
<member name="
|
|
3524
|
+
<member name="M:IronPdf.Fonts.PdfFontCollection.ReplaceFromFilePath(IronPdf.Fonts.FontInfo,System.String)">
|
|
3516
3525
|
<summary>
|
|
3517
|
-
|
|
3526
|
+
Replaces a font referenced from a PDF document with the specified font's filepath.
|
|
3527
|
+
Supports replacing a target font which is either a simple font, or a composite font.
|
|
3518
3528
|
</summary>
|
|
3529
|
+
<param name="targetFont">Target <see cref="T:IronPdf.Fonts.FontInfo"/> to replace</param>
|
|
3530
|
+
<param name="path">Font's filepath</param>
|
|
3531
|
+
<remarks>
|
|
3532
|
+
This method will also embed the font into a PDF document.
|
|
3533
|
+
</remarks>
|
|
3534
|
+
<returns><see cref="T:IronPdf.Fonts.FontInfo"/> representing a replaced font if succeed, otherwise an exception thrown.</returns>
|
|
3519
3535
|
</member>
|
|
3520
|
-
<member name="
|
|
3536
|
+
<member name="M:IronPdf.Fonts.PdfFontCollection.Replace(IronPdf.Fonts.FontInfo,System.Byte[],System.UInt32)">
|
|
3521
3537
|
<summary>
|
|
3522
|
-
|
|
3538
|
+
Replaces a font referenced from a PDF document with the specified font's <see langword="byte[]"/>.
|
|
3539
|
+
Supports replacing a target font which is either a simple font, or a composite font.
|
|
3523
3540
|
</summary>
|
|
3524
|
-
<
|
|
3541
|
+
<param name="targetFont">Target <see cref="T:IronPdf.Fonts.FontInfo"/> to replace</param>
|
|
3542
|
+
<param name="newFontData">Font's filepath as <see langword="byte[]"/></param>
|
|
3543
|
+
<param name="size">Size in bytes for the font data</param>
|
|
3544
|
+
<remarks>
|
|
3545
|
+
This method will also embed the font into a PDF document.
|
|
3546
|
+
</remarks>
|
|
3547
|
+
<returns><see cref="T:IronPdf.Fonts.FontInfo"/> representing a replaced font if succeed, otherwise an exception thrown.</returns>
|
|
3525
3548
|
</member>
|
|
3526
|
-
<member name="
|
|
3549
|
+
<member name="M:IronPdf.Fonts.PdfFontCollection.Replace(IronPdf.Fonts.FontInfo,System.IO.Stream)">
|
|
3527
3550
|
<summary>
|
|
3528
|
-
|
|
3551
|
+
Replaces a font referenced from a PDF document with the specified font's <see cref="T:System.IO.Stream"/>.
|
|
3552
|
+
Supports replacing a target font which is either a simple font, or a composite font.
|
|
3529
3553
|
</summary>
|
|
3530
|
-
<
|
|
3531
|
-
|
|
3532
|
-
|
|
3554
|
+
<param name="targetFont">Target <see cref="T:IronPdf.Fonts.FontInfo"/> to replace</param>
|
|
3555
|
+
<param name="newFontStream">Font's <see cref="T:System.IO.Stream"/></param>
|
|
3556
|
+
<remarks>
|
|
3557
|
+
This method will also embed the font into a PDF document.
|
|
3558
|
+
</remarks>
|
|
3559
|
+
<returns><see cref="T:IronPdf.Fonts.FontInfo"/> representing a replaced font if succeed, otherwise an exception thrown.</returns>
|
|
3533
3560
|
</member>
|
|
3534
|
-
<member name="M:IronPdf.
|
|
3561
|
+
<member name="M:IronPdf.Fonts.PdfFontCollection.Embed(IronPdf.Fonts.FontInfo,System.String)">
|
|
3535
3562
|
<summary>
|
|
3536
|
-
|
|
3563
|
+
Embeds a font with the font's filepath.
|
|
3537
3564
|
</summary>
|
|
3538
|
-
<
|
|
3539
|
-
|
|
3540
|
-
</
|
|
3541
|
-
<
|
|
3565
|
+
<remarks>
|
|
3566
|
+
This requires that there is an existing font referenced which used as a target in order to successfully embed a font.
|
|
3567
|
+
</remarks>
|
|
3568
|
+
<param name="font">Target <see cref="T:IronPdf.Fonts.FontInfo"/> to embed</param>
|
|
3569
|
+
<param name="path">Font's filepath for using as a font data to embed</param>
|
|
3570
|
+
<returns><see cref="T:IronPdf.Fonts.FontInfo"/> object just embedded if succeed, otherwise an exception thrown.</returns>
|
|
3542
3571
|
</member>
|
|
3543
|
-
<member name="M:IronPdf.
|
|
3572
|
+
<member name="M:IronPdf.Fonts.PdfFontCollection.Embed(IronPdf.Fonts.FontInfo,System.Byte[],System.UInt32)">
|
|
3544
3573
|
<summary>
|
|
3545
|
-
|
|
3546
|
-
mistakes and partial field names.
|
|
3574
|
+
Embeds a font with the font's <see langword="byte[]"/>.
|
|
3547
3575
|
</summary>
|
|
3548
|
-
<
|
|
3549
|
-
|
|
3550
|
-
|
|
3551
|
-
</param>
|
|
3552
|
-
<
|
|
3576
|
+
<remarks>
|
|
3577
|
+
This requires that there is an existing font referenced which used as a target in order to successfully embed a font.
|
|
3578
|
+
</remarks>
|
|
3579
|
+
<param name="font">Target font to embed</param>
|
|
3580
|
+
<param name="fontData">Font's data as byte array</param>
|
|
3581
|
+
<param name="size">Size in byte of the byte array</param>
|
|
3582
|
+
<returns><see cref="T:IronPdf.Fonts.FontInfo"/> object just embedded if succeed, otherwise an exception thrown.</returns>
|
|
3553
3583
|
</member>
|
|
3554
|
-
<member name="M:IronPdf.
|
|
3584
|
+
<member name="M:IronPdf.Fonts.PdfFontCollection.Embed(IronPdf.Fonts.FontInfo,System.IO.Stream)">
|
|
3555
3585
|
<summary>
|
|
3556
|
-
|
|
3586
|
+
Embeds a font with the font's <see cref="T:System.IO.Stream"/>.
|
|
3557
3587
|
</summary>
|
|
3558
|
-
<
|
|
3559
|
-
|
|
3560
|
-
|
|
3561
|
-
<
|
|
3588
|
+
<remarks>
|
|
3589
|
+
This requires that there is an existing font referenced which used as a target in order to successfully embed a font.
|
|
3590
|
+
</remarks>
|
|
3591
|
+
<param name="font">Target font to embed</param>
|
|
3592
|
+
<param name="fontStream">Font stream</param>
|
|
3593
|
+
<returns><see cref="T:IronPdf.Fonts.FontInfo"/> object just embedded if succeed, otherwise an exception thrown.</returns>
|
|
3562
3594
|
</member>
|
|
3563
|
-
<member name="
|
|
3564
|
-
|
|
3565
|
-
|
|
3566
|
-
|
|
3567
|
-
|
|
3595
|
+
<member name="M:IronPdf.Fonts.PdfFontCollection.UnEmbed(System.String)">
|
|
3596
|
+
<summary>
|
|
3597
|
+
UnEmbeds a font from the regular expression string matching a font name.
|
|
3598
|
+
It will <strong>only</strong> perform on the first match.
|
|
3599
|
+
</summary>
|
|
3600
|
+
<remarks>
|
|
3601
|
+
This method is mostly useful if font names are mostly unique within the PDF document.
|
|
3602
|
+
Alternatively use <see cref="M:IronPdf.Fonts.IPdfFontCollection.Find(System.String)"/>.
|
|
3603
|
+
|
|
3604
|
+
<para>
|
|
3605
|
+
UnEmbeds a font means that its font content would be deleted from the PDF document, but the other data structure
|
|
3606
|
+
or information of the font itself is still there. Uses this method to reduce file size of PDF document.
|
|
3607
|
+
</para>
|
|
3608
|
+
</remarks>
|
|
3609
|
+
<param name="regexFontName">Regular expression string matching a font name</param>
|
|
3610
|
+
<returns><see cref="T:IronPdf.Fonts.FontInfo"/> just un-embedded if succeed, otherwise an exception thrown.</returns>
|
|
3568
3611
|
</member>
|
|
3569
|
-
<member name="M:IronPdf.
|
|
3612
|
+
<member name="M:IronPdf.Fonts.PdfFontCollection.UnEmbed(IronPdf.Fonts.FontInfo)">
|
|
3570
3613
|
<summary>
|
|
3571
|
-
|
|
3614
|
+
UnEmbeds a font from the font object.
|
|
3572
3615
|
</summary>
|
|
3573
|
-
<
|
|
3574
|
-
|
|
3616
|
+
<remarks>
|
|
3617
|
+
UnEmbeds a font means that its font content would be deleted from the PDF document, but the other data structure
|
|
3618
|
+
or information of the font itself is still there. Uses this method to reduce file size of PDF document.
|
|
3619
|
+
</remarks>
|
|
3620
|
+
<param name="font">Font object to un-embed</param>
|
|
3621
|
+
<returns><see cref="T:IronPdf.Fonts.FontInfo"/> just un-embedded if succeed, otherwise an exception thrown.</returns>
|
|
3575
3622
|
</member>
|
|
3623
|
+
<!-- Badly formed XML comment ignored for member "M:IronPdf.Fonts.PdfFontCollection.Find(System.String)" -->
|
|
3576
3624
|
<member name="T:IronPdf.GrpcLayer.Bookmark.GrpcBookmark">
|
|
3577
3625
|
<summary>
|
|
3578
3626
|
Represents a PDF bookmark as seen in the sidebar of PDF reader software to help user's navigate.
|
|
@@ -3659,6 +3707,54 @@
|
|
|
3659
3707
|
Host port
|
|
3660
3708
|
</summary>
|
|
3661
3709
|
</member>
|
|
3710
|
+
<member name="P:IronPdf.GrpcLayer.Converters.TempFormFieldDescriptor.Annotations">
|
|
3711
|
+
<inheritdoc/>
|
|
3712
|
+
</member>
|
|
3713
|
+
<member name="P:IronPdf.GrpcLayer.Converters.TempFormFieldDescriptor.Client">
|
|
3714
|
+
<inheritdoc/>
|
|
3715
|
+
</member>
|
|
3716
|
+
<member name="P:IronPdf.GrpcLayer.Converters.TempFormFieldDescriptor.Choices">
|
|
3717
|
+
<inheritdoc/>
|
|
3718
|
+
</member>
|
|
3719
|
+
<member name="P:IronPdf.GrpcLayer.Converters.TempFormFieldDescriptor.DefaultAppearance">
|
|
3720
|
+
<inheritdoc/>
|
|
3721
|
+
</member>
|
|
3722
|
+
<member name="P:IronPdf.GrpcLayer.Converters.TempFormFieldDescriptor.FormFlags">
|
|
3723
|
+
<inheritdoc/>
|
|
3724
|
+
</member>
|
|
3725
|
+
<member name="P:IronPdf.GrpcLayer.Converters.TempFormFieldDescriptor.FormType">
|
|
3726
|
+
<inheritdoc/>
|
|
3727
|
+
</member>
|
|
3728
|
+
<member name="P:IronPdf.GrpcLayer.Converters.TempFormFieldDescriptor.FullName">
|
|
3729
|
+
<inheritdoc/>
|
|
3730
|
+
</member>
|
|
3731
|
+
<member name="P:IronPdf.GrpcLayer.Converters.TempFormFieldDescriptor.MaxLength">
|
|
3732
|
+
<inheritdoc/>
|
|
3733
|
+
</member>
|
|
3734
|
+
<member name="P:IronPdf.GrpcLayer.Converters.TempFormFieldDescriptor.Name">
|
|
3735
|
+
<inheritdoc/>
|
|
3736
|
+
</member>
|
|
3737
|
+
<member name="P:IronPdf.GrpcLayer.Converters.TempFormFieldDescriptor.ReadOnly">
|
|
3738
|
+
<inheritdoc/>
|
|
3739
|
+
</member>
|
|
3740
|
+
<member name="P:IronPdf.GrpcLayer.Converters.TempFormFieldDescriptor.RichText">
|
|
3741
|
+
<inheritdoc/>
|
|
3742
|
+
</member>
|
|
3743
|
+
<member name="P:IronPdf.GrpcLayer.Converters.TempFormFieldDescriptor.ObjNum">
|
|
3744
|
+
<inheritdoc/>
|
|
3745
|
+
</member>
|
|
3746
|
+
<member name="P:IronPdf.GrpcLayer.Converters.TempFormFieldDescriptor.ObjType">
|
|
3747
|
+
<inheritdoc/>
|
|
3748
|
+
</member>
|
|
3749
|
+
<member name="P:IronPdf.GrpcLayer.Converters.TempFormFieldDescriptor.PdfDocumentId">
|
|
3750
|
+
<inheritdoc/>
|
|
3751
|
+
</member>
|
|
3752
|
+
<member name="P:IronPdf.GrpcLayer.Converters.TempFormFieldDescriptor.Type">
|
|
3753
|
+
<inheritdoc/>
|
|
3754
|
+
</member>
|
|
3755
|
+
<member name="P:IronPdf.GrpcLayer.Converters.TempFormFieldDescriptor.Value">
|
|
3756
|
+
<inheritdoc/>
|
|
3757
|
+
</member>
|
|
3662
3758
|
<member name="M:IronPdf.GrpcLayer.Utils.Util.Chunk``1(System.Collections.Generic.IEnumerable{``0},System.Int32)">
|
|
3663
3759
|
<summary>
|
|
3664
3760
|
Split the elements of a sequence into chunks of size at most <paramref name="size" />.
|
|
@@ -3687,6 +3783,35 @@
|
|
|
3687
3783
|
<paramref name="size" /> is below 1.
|
|
3688
3784
|
</exception>
|
|
3689
3785
|
</member>
|
|
3786
|
+
<member name="M:IronPdf.HeaderFooterHelper.AutosizeHeaderFooterMarginsIfNeeded(IronPdf.Engines.Chrome.IChromeClient,System.Uri,System.String,IronPdf.ChromePdfRenderOptions@)">
|
|
3787
|
+
<summary>
|
|
3788
|
+
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.
|
|
3789
|
+
</summary>
|
|
3790
|
+
<param name="chromeClient">An instance conforming to <see cref="T:IronPdf.Engines.Chrome.IChromeClient" />.</param>
|
|
3791
|
+
<param name="baseUrl">Optional: a base URL.</param>
|
|
3792
|
+
<param name="proxy">Optional: a proxy.</param>
|
|
3793
|
+
<param name="renderOptions">A reference to a <see cref="T:IronPdf.ChromePdfRenderOptions"/> instance.</param>
|
|
3794
|
+
</member>
|
|
3795
|
+
<member name="M:IronPdf.HeaderFooterHelper.ShouldAutosizeMargin(IronPdf.HtmlHeaderFooter)">
|
|
3796
|
+
<summary>
|
|
3797
|
+
Check if we should perform auto-sizing for a given HTML fragment.
|
|
3798
|
+
</summary>
|
|
3799
|
+
<param name="fragment">The fragment to check.</param>
|
|
3800
|
+
<returns>A boolean value indicating whether auto-sizing should be done.</returns>
|
|
3801
|
+
</member>
|
|
3802
|
+
<member name="M:IronPdf.HeaderFooterHelper.CalculateFragmentHeightMm(IronPdf.Engines.Chrome.IChromeClient,System.Uri,System.String,System.String,System.Double,System.Double)">
|
|
3803
|
+
<summary>
|
|
3804
|
+
Calculate the height of a HTML fragment taking into account the minimum margin height.
|
|
3805
|
+
If the height of a fragment is less then the minimum height, the minimum height will be returned.
|
|
3806
|
+
</summary>
|
|
3807
|
+
<param name="chromeClient"></param>
|
|
3808
|
+
<param name="baseUrl"></param>
|
|
3809
|
+
<param name="proxy"></param>
|
|
3810
|
+
<param name="fragment">An HTML fragment to measure.</param>
|
|
3811
|
+
<param name="pageWidthMm">The page width in millimeters.</param>
|
|
3812
|
+
<param name="minimumMarginHeightMm">The minimum margin height, which will be returned if fragment height is less than minimum margin height.</param>
|
|
3813
|
+
<returns></returns>
|
|
3814
|
+
</member>
|
|
3690
3815
|
<member name="T:IronPdf.HtmlHeaderFooter">
|
|
3691
3816
|
<summary>
|
|
3692
3817
|
A HTML Header or Footer which will be printed onto every page of the PDF. This can be used to override
|
|
@@ -3694,6 +3819,11 @@
|
|
|
3694
3819
|
<para>Merge meta-data into your HTML using any of these placeholder strings: {page} {total-pages} {url} {date} {time} {html-title} {pdf-title}</para>
|
|
3695
3820
|
</summary>
|
|
3696
3821
|
</member>
|
|
3822
|
+
<member name="F:IronPdf.HtmlHeaderFooter.FragmentHeight">
|
|
3823
|
+
<summary>
|
|
3824
|
+
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.
|
|
3825
|
+
</summary>
|
|
3826
|
+
</member>
|
|
3697
3827
|
<member name="P:IronPdf.HtmlHeaderFooter.BaseUrl">
|
|
3698
3828
|
<summary>
|
|
3699
3829
|
The Base URL all URLS in the <see cref="P:IronPdf.HtmlHeaderFooter.HtmlFragment">HtmlFragment</see> will be relative to. This includes
|
|
@@ -3958,6 +4088,11 @@
|
|
|
3958
4088
|
</summary>
|
|
3959
4089
|
<remarks>Useful for IronPdf.Slim</remarks>
|
|
3960
4090
|
</member>
|
|
4091
|
+
<member name="P:IronPdf.Installation.ConnectionType">
|
|
4092
|
+
<summary>
|
|
4093
|
+
Get the current connection type.
|
|
4094
|
+
</summary>
|
|
4095
|
+
</member>
|
|
3961
4096
|
<member name="P:IronPdf.Installation.LicenseKey">
|
|
3962
4097
|
<summary>
|
|
3963
4098
|
Synonym of IronPdf.License.LicenseKey
|
|
@@ -3974,6 +4109,17 @@
|
|
|
3974
4109
|
</summary>
|
|
3975
4110
|
<remarks>Warning! This feature is experimental and unstable. Useful for environments where execution permissions are not possible.</remarks>
|
|
3976
4111
|
</member>
|
|
4112
|
+
<member name="P:IronPdf.Installation.EnableWebSecurity">
|
|
4113
|
+
<summary>
|
|
4114
|
+
Enable web security for Chrome renderer. Disabled by default.
|
|
4115
|
+
<para>
|
|
4116
|
+
Enabling web security will disable operations which require local disk access or cross-origin requests.
|
|
4117
|
+
</para>
|
|
4118
|
+
<para>
|
|
4119
|
+
Useful when injecting untrusted HTML from users.
|
|
4120
|
+
</para>
|
|
4121
|
+
</summary>
|
|
4122
|
+
</member>
|
|
3977
4123
|
<member name="P:IronPdf.Installation.ChromeBrowserCachePath">
|
|
3978
4124
|
<summary>
|
|
3979
4125
|
Disk cache path for chrome browser instances
|
|
@@ -4050,6 +4196,29 @@
|
|
|
4050
4196
|
Custom paper width, in mm
|
|
4051
4197
|
</summary>
|
|
4052
4198
|
</member>
|
|
4199
|
+
<member name="T:IronPdf.Javascript.IJavascriptExtension">
|
|
4200
|
+
<summary>
|
|
4201
|
+
Javascript extension interface
|
|
4202
|
+
</summary>
|
|
4203
|
+
</member>
|
|
4204
|
+
<member name="P:IronPdf.Javascript.IJavascriptExtension.Javascript">
|
|
4205
|
+
<summary>
|
|
4206
|
+
Javascript to-be-injected
|
|
4207
|
+
</summary>
|
|
4208
|
+
</member>
|
|
4209
|
+
<member name="T:IronPdf.Javascript.JavascriptExtensionFactory">
|
|
4210
|
+
<summary>
|
|
4211
|
+
Helper class for generating javascript from a list of extensions
|
|
4212
|
+
</summary>
|
|
4213
|
+
</member>
|
|
4214
|
+
<member name="M:IronPdf.Javascript.JavascriptExtensionFactory.GenerateJavascript(System.Collections.Generic.IEnumerable{IronPdf.Javascript.IJavascriptExtension},System.String)">
|
|
4215
|
+
<summary>
|
|
4216
|
+
Generate a singular javascript string for a list of extensions
|
|
4217
|
+
</summary>
|
|
4218
|
+
<param name="extensions">Javascript extensions</param>
|
|
4219
|
+
<param name="userJavaScript">User-specified javascript</param>
|
|
4220
|
+
<returns>Javascript string</returns>
|
|
4221
|
+
</member>
|
|
4053
4222
|
<member name="T:IronPdf.ImageType">
|
|
4054
4223
|
<exclude/>
|
|
4055
4224
|
</member>
|
|
@@ -4089,6 +4258,138 @@
|
|
|
4089
4258
|
Every page of the PDF will be compiled into a single multi-page TIFF image file (aka. multi-frame TIFF).
|
|
4090
4259
|
</summary>
|
|
4091
4260
|
</member>
|
|
4261
|
+
<member name="T:IronPdf.Forms.CheckBoxField">
|
|
4262
|
+
<summary>
|
|
4263
|
+
Represents a check-box in a PDF form.
|
|
4264
|
+
</summary>
|
|
4265
|
+
<seealso cref="!:IronPdf.Forms.FormField"/>
|
|
4266
|
+
</member>
|
|
4267
|
+
<member name="P:IronPdf.Forms.CheckBoxField.BooleanValue">
|
|
4268
|
+
<summary>
|
|
4269
|
+
Gets or sets a value indicating whether the check-box is checked (ticked).
|
|
4270
|
+
</summary>
|
|
4271
|
+
<value>
|
|
4272
|
+
<c>true</c> if checked; otherwise, <c>false</c>.
|
|
4273
|
+
</value>
|
|
4274
|
+
</member>
|
|
4275
|
+
<member name="T:IronPdf.Forms.ComboBoxField">
|
|
4276
|
+
<summary>
|
|
4277
|
+
Represents a combo-box (drop down menu) in a PDF form.
|
|
4278
|
+
</summary>
|
|
4279
|
+
<seealso cref="!:IronPdf.Forms.FormField"/>
|
|
4280
|
+
</member>
|
|
4281
|
+
<member name="P:IronPdf.Forms.ComboBoxField.Options">
|
|
4282
|
+
<summary>
|
|
4283
|
+
Gets the available options for the combo-box in zero based index order.
|
|
4284
|
+
</summary>
|
|
4285
|
+
<value>
|
|
4286
|
+
The option names as strings.
|
|
4287
|
+
</value>
|
|
4288
|
+
</member>
|
|
4289
|
+
<member name="P:IronPdf.Forms.ComboBoxField.SelectedIndex">
|
|
4290
|
+
<summary>
|
|
4291
|
+
Gets the index of the selected option.
|
|
4292
|
+
</summary>
|
|
4293
|
+
<value>
|
|
4294
|
+
The index of the selected. 0 based.
|
|
4295
|
+
</value>
|
|
4296
|
+
</member>
|
|
4297
|
+
<member name="T:IronPdf.Forms.PdfForm">
|
|
4298
|
+
<summary>
|
|
4299
|
+
A collection of the user-editable form fields within a PDF document
|
|
4300
|
+
</summary>
|
|
4301
|
+
</member>
|
|
4302
|
+
<member name="T:IronPdf.Forms.TextField">
|
|
4303
|
+
<summary>
|
|
4304
|
+
Represents an editable text input field in a PDF document.
|
|
4305
|
+
</summary>
|
|
4306
|
+
<seealso cref="!:IronPdf.Forms.FormField"/>
|
|
4307
|
+
</member>
|
|
4308
|
+
<member name="T:IronPdf.Forms.FormFieldTypes">
|
|
4309
|
+
<summary>
|
|
4310
|
+
Form field types
|
|
4311
|
+
</summary>
|
|
4312
|
+
</member>
|
|
4313
|
+
<member name="T:IronPdf.Forms.IFormField">
|
|
4314
|
+
<summary>
|
|
4315
|
+
Generic base class from which all PDF Form fields are derived.
|
|
4316
|
+
</summary>
|
|
4317
|
+
</member>
|
|
4318
|
+
<member name="T:IronPdf.Forms.CommonFormField">
|
|
4319
|
+
<summary>
|
|
4320
|
+
Generic base class from which all PDF Form fields are derived.
|
|
4321
|
+
</summary>
|
|
4322
|
+
</member>
|
|
4323
|
+
<member name="M:IronPdf.Forms.CommonFormField.ToString">
|
|
4324
|
+
<summary>
|
|
4325
|
+
Returns the value of this field.
|
|
4326
|
+
</summary>
|
|
4327
|
+
<returns>
|
|
4328
|
+
The value of this field.
|
|
4329
|
+
</returns>
|
|
4330
|
+
</member>
|
|
4331
|
+
<member name="P:IronPdf.Forms.CommonFormField.AnnotationIndex">
|
|
4332
|
+
<summary>
|
|
4333
|
+
Index of annotation associated with this form field
|
|
4334
|
+
</summary>
|
|
4335
|
+
</member>
|
|
4336
|
+
<member name="P:IronPdf.Forms.CommonFormField.FullName">
|
|
4337
|
+
<summary>
|
|
4338
|
+
Gets the fully qualified name of this field. This is constructed from all partial field names of the field and all of its ancestors.
|
|
4339
|
+
<para>
|
|
4340
|
+
Example 1: <code>parent's_full_name.child's_partial_name</code>
|
|
4341
|
+
Example 2: <code>PersonalData.Address.ZipCode</code>
|
|
4342
|
+
</para>
|
|
4343
|
+
</summary>
|
|
4344
|
+
<value>
|
|
4345
|
+
The fully qualified name as a string.
|
|
4346
|
+
</value>
|
|
4347
|
+
</member>
|
|
4348
|
+
<member name="P:IronPdf.Forms.CommonFormField.Name">
|
|
4349
|
+
<summary>
|
|
4350
|
+
Gets the ID name of this field.
|
|
4351
|
+
</summary>
|
|
4352
|
+
<value>
|
|
4353
|
+
The name as a string.
|
|
4354
|
+
</value>
|
|
4355
|
+
</member>
|
|
4356
|
+
<member name="P:IronPdf.Forms.CommonFormField.PageIndex">
|
|
4357
|
+
<summary>
|
|
4358
|
+
Page index which contains this form field
|
|
4359
|
+
</summary>
|
|
4360
|
+
</member>
|
|
4361
|
+
<member name="P:IronPdf.Forms.CommonFormField.Type">
|
|
4362
|
+
<summary>
|
|
4363
|
+
Form field type
|
|
4364
|
+
</summary>
|
|
4365
|
+
</member>
|
|
4366
|
+
<member name="P:IronPdf.Forms.CommonFormField.Width">
|
|
4367
|
+
<summary>
|
|
4368
|
+
Form field width
|
|
4369
|
+
</summary>
|
|
4370
|
+
</member>
|
|
4371
|
+
<member name="P:IronPdf.Forms.CommonFormField.Height">
|
|
4372
|
+
<summary>
|
|
4373
|
+
Form field height
|
|
4374
|
+
</summary>
|
|
4375
|
+
</member>
|
|
4376
|
+
<member name="P:IronPdf.Forms.CommonFormField.X">
|
|
4377
|
+
<summary>
|
|
4378
|
+
Form field x position
|
|
4379
|
+
</summary>
|
|
4380
|
+
</member>
|
|
4381
|
+
<member name="P:IronPdf.Forms.CommonFormField.Y">
|
|
4382
|
+
<summary>
|
|
4383
|
+
Form field x position
|
|
4384
|
+
</summary>
|
|
4385
|
+
</member>
|
|
4386
|
+
<member name="M:IronPdf.Forms.CommonFormField.SetFont(IronSoftware.Drawing.FontTypes,System.Double)">
|
|
4387
|
+
<summary>
|
|
4388
|
+
Sets the font to the text field of pdf form.
|
|
4389
|
+
</summary>
|
|
4390
|
+
<param name="fontType">Type of the font.</param>
|
|
4391
|
+
<param name="fontSize">Size of the font.</param>
|
|
4392
|
+
</member>
|
|
4092
4393
|
<member name="T:IronPdf.Font.FontTypes">
|
|
4093
4394
|
<exclude/>
|
|
4094
4395
|
</member>
|
|
@@ -4120,12 +4421,12 @@
|
|
|
4120
4421
|
</member>
|
|
4121
4422
|
<member name="T:IronPdf.Logging.Logger">
|
|
4122
4423
|
<summary>
|
|
4123
|
-
Provides functionality for developers to view debug logs and export log files from IronPdf.
|
|
4424
|
+
OBSOLETE. Provides functionality for developers to view debug logs and export log files from IronPdf.
|
|
4124
4425
|
</summary>
|
|
4125
4426
|
</member>
|
|
4126
4427
|
<member name="T:IronPdf.Logging.Logger.LoggingModes">
|
|
4127
4428
|
<summary>
|
|
4128
|
-
Different Ways to log developer notices and warnings
|
|
4429
|
+
OBSOLETE. Different Ways to log developer notices and warnings
|
|
4129
4430
|
</summary>
|
|
4130
4431
|
</member>
|
|
4131
4432
|
<member name="F:IronPdf.Logging.Logger.LoggingModes.None">
|
|
@@ -4160,7 +4461,7 @@
|
|
|
4160
4461
|
</member>
|
|
4161
4462
|
<member name="P:IronPdf.Logging.Logger.CustomLogger">
|
|
4162
4463
|
<summary>
|
|
4163
|
-
Custom logger implementation
|
|
4464
|
+
OBSOLETE. Custom logger implementation
|
|
4164
4465
|
</summary>
|
|
4165
4466
|
</member>
|
|
4166
4467
|
<member name="P:IronPdf.Logging.Logger.EnableDebugging">
|
|
@@ -4170,25 +4471,22 @@
|
|
|
4170
4471
|
</member>
|
|
4171
4472
|
<member name="E:IronPdf.Logging.Logger.MessageLogged">
|
|
4172
4473
|
<summary>
|
|
4173
|
-
Event handler to intercept logged messages.
|
|
4474
|
+
OBSOLETE. Event handler to intercept logged messages.
|
|
4174
4475
|
</summary>
|
|
4175
4476
|
</member>
|
|
4176
4477
|
<member name="P:IronPdf.Logging.Logger.LoggingMode">
|
|
4177
4478
|
<summary>
|
|
4178
|
-
Activate or disable detailed developer messages sent to your choice of location in the IDE or application console.
|
|
4479
|
+
OBSOLETE. Activate or disable detailed developer messages sent to your choice of location in the IDE or application console.
|
|
4179
4480
|
</summary>
|
|
4180
4481
|
</member>
|
|
4181
4482
|
<member name="P:IronPdf.Logging.Logger.LogFilePath">
|
|
4182
4483
|
<summary>
|
|
4183
|
-
|
|
4184
|
-
<para>LogFilePath may be set to a directory name or a full file name.</para>
|
|
4185
|
-
<para>Setting <c>LogFilePath = null</c> will turn off log files.</para>
|
|
4484
|
+
OBSOLETE. Log file path
|
|
4186
4485
|
</summary>
|
|
4187
|
-
<seealso cref="M:IronPdf.Logging.Logger.ClearLogFiles"/>
|
|
4188
4486
|
</member>
|
|
4189
4487
|
<member name="M:IronPdf.Logging.Logger.ClearLogFiles">
|
|
4190
4488
|
<summary>
|
|
4191
|
-
Removes any Iron Software log files at the <see cref="P:IronPdf.Logging.Logger.LogFilePath"/>.
|
|
4489
|
+
OBSOLETE. Removes any Iron Software log files at the <see cref="P:IronPdf.Logging.Logger.LogFilePath"/>.
|
|
4192
4490
|
</summary>
|
|
4193
4491
|
<seealso cref="P:IronPdf.Logging.Logger.LogFilePath"/>
|
|
4194
4492
|
</member>
|
|
@@ -4572,6 +4870,13 @@
|
|
|
4572
4870
|
<param name="Width">The width of your annotation's icon and interactive area in pixels</param>
|
|
4573
4871
|
<param name="Height">The height of your annotation's icon and interactive area in pixels</param>
|
|
4574
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>
|
|
4575
4880
|
<member name="P:IronPdf.PdfDocument.Attachments">
|
|
4576
4881
|
<summary>
|
|
4577
4882
|
Collection of attachments contained within the pdf document
|
|
@@ -4793,6 +5098,11 @@
|
|
|
4793
5098
|
<param name="EndIndex">The index of the last PDF page to copy.></param>
|
|
4794
5099
|
<returns>A new <see cref="T:IronPdf.PdfDocument"/></returns>
|
|
4795
5100
|
</member>
|
|
5101
|
+
<member name="P:IronPdf.PdfDocument.Fonts">
|
|
5102
|
+
<summary>
|
|
5103
|
+
PDF Document's Font collection management.
|
|
5104
|
+
</summary>
|
|
5105
|
+
</member>
|
|
4796
5106
|
<member name="M:IronPdf.PdfDocument.AddTextFooters(IronPdf.TextHeaderFooter,System.Int32,System.Collections.Generic.IEnumerable{System.Int32})">
|
|
4797
5107
|
<summary>
|
|
4798
5108
|
Stamps page footers on top of an existing Pdf.
|
|
@@ -4927,6 +5237,26 @@
|
|
|
4927
5237
|
<param name="DesiredHeight">Desired Height</param>
|
|
4928
5238
|
<param name="PixelFormat">Pixel format</param>
|
|
4929
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>
|
|
4930
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)">
|
|
4931
5261
|
<summary>
|
|
4932
5262
|
Draw a bitmap multiple times according to the specified parameters; all occurrences of the bitmap will share a single data stream
|
|
@@ -4947,6 +5277,17 @@
|
|
|
4947
5277
|
<param name="ScaleToVisibleSize">Scale down the image resolution according to its visible size in the PDF document</param>
|
|
4948
5278
|
<exception cref="T:System.ArgumentOutOfRangeException">Argument out of range</exception>
|
|
4949
5279
|
</member>
|
|
5280
|
+
<member name="M:IronPdf.PdfDocument.CompressStructTree">
|
|
5281
|
+
<summary>
|
|
5282
|
+
Remove document struct tree information which describes the logical layout of the document.
|
|
5283
|
+
<para>
|
|
5284
|
+
Removing the "structure tree" can significantly reduce the disk space used by the document.
|
|
5285
|
+
</para>
|
|
5286
|
+
<para>
|
|
5287
|
+
Removing the "structure tree" of a complicated document can negatively impact text selection.
|
|
5288
|
+
</para>
|
|
5289
|
+
</summary>
|
|
5290
|
+
</member>
|
|
4950
5291
|
<member name="M:IronPdf.PdfDocument.ExtractAllBitmaps">
|
|
4951
5292
|
<summary>
|
|
4952
5293
|
Finds all embedded Images from within the PDF and returns then as <see cref="T:IronSoftware.Drawing.AnyBitmap"/> objects
|
|
@@ -5077,7 +5418,7 @@
|
|
|
5077
5418
|
<param name="Password">Document password</param>
|
|
5078
5419
|
<param name="OwnerPassword">Document owner password</param>
|
|
5079
5420
|
</member>
|
|
5080
|
-
<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)">
|
|
5081
5422
|
<summary>
|
|
5082
5423
|
Opens an existing PDF document for editing.
|
|
5083
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>
|
|
@@ -5089,7 +5430,7 @@
|
|
|
5089
5430
|
<exception cref="T:System.IO.IOException">Exception thrown if can not be opened.</exception>
|
|
5090
5431
|
<exception cref="T:System.ArgumentException"><paramref name="PdfFilePath"/> is null, empty, or consists only of white-space characters.</exception>
|
|
5091
5432
|
</member>
|
|
5092
|
-
<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)">
|
|
5093
5434
|
<summary>
|
|
5094
5435
|
Opens an existing PDF document from the specified Uri for editing.
|
|
5095
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>
|
|
@@ -5100,7 +5441,7 @@
|
|
|
5100
5441
|
<param name="TrackChanges">Optionally track changes to the document (for use with incremental saves)</param>
|
|
5101
5442
|
<exception cref="T:IronPdf.Exceptions.IronPdfProductException">Exception thrown if PDF cannot be found at URI or if password is incorrect.</exception>
|
|
5102
5443
|
</member>
|
|
5103
|
-
<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)">
|
|
5104
5445
|
<summary>
|
|
5105
5446
|
Opens an existing PDF document for editing.
|
|
5106
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>
|
|
@@ -5111,7 +5452,7 @@
|
|
|
5111
5452
|
<param name="TrackChanges">Optionally track changes to the document (for use with incremental saves)</param>
|
|
5112
5453
|
<exception cref="T:System.IO.IOException">Exception thrown if can not be opened.</exception>
|
|
5113
5454
|
</member>
|
|
5114
|
-
<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)">
|
|
5115
5456
|
<summary>
|
|
5116
5457
|
Opens an existing PDF document for editing.
|
|
5117
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>
|
|
@@ -5143,7 +5484,7 @@
|
|
|
5143
5484
|
<exception cref="T:IronPdf.Exceptions.IronPdfProductException">Exception thrown if cannot read the PDF due to incorrect uri or password.</exception>
|
|
5144
5485
|
<returns>An IronPdf.PdfDocument object as loaded from the file path.</returns>
|
|
5145
5486
|
</member>
|
|
5146
|
-
<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)">
|
|
5147
5488
|
<summary>
|
|
5148
5489
|
Opens an existing PDF document for editing.
|
|
5149
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>
|
|
@@ -5854,7 +6195,7 @@
|
|
|
5854
6195
|
<summary>
|
|
5855
6196
|
Return a list of all fonts referenced in this document
|
|
5856
6197
|
</summary>
|
|
5857
|
-
<returns>List of font
|
|
6198
|
+
<returns>List of font info structure used in this document</returns>
|
|
5858
6199
|
</member>
|
|
5859
6200
|
<member name="M:IronPdf.PdfDocument.ReplaceTextOnPage(System.Int32,System.String,System.String)">
|
|
5860
6201
|
<summary>
|
|
@@ -6288,6 +6629,39 @@
|
|
|
6288
6629
|
<param name="LicenseKey">IronPDF license key as a string</param>
|
|
6289
6630
|
<returns>True if the license key given is valid.</returns>
|
|
6290
6631
|
</member>
|
|
6632
|
+
<member name="T:IronPdf.Pages.LineTextObject">
|
|
6633
|
+
<summary>
|
|
6634
|
+
Represents a line of text within a document
|
|
6635
|
+
</summary>
|
|
6636
|
+
</member>
|
|
6637
|
+
<member name="P:IronPdf.Pages.LineTextObject.PdfDocumentId">
|
|
6638
|
+
<inheritdoc/>
|
|
6639
|
+
</member>
|
|
6640
|
+
<member name="P:IronPdf.Pages.LineTextObject.ObjNum">
|
|
6641
|
+
<inheritdoc/>
|
|
6642
|
+
</member>
|
|
6643
|
+
<member name="P:IronPdf.Pages.LineTextObject.Left">
|
|
6644
|
+
<inheritdoc/>
|
|
6645
|
+
</member>
|
|
6646
|
+
<member name="P:IronPdf.Pages.LineTextObject.Right">
|
|
6647
|
+
<inheritdoc/>
|
|
6648
|
+
</member>
|
|
6649
|
+
<member name="P:IronPdf.Pages.LineTextObject.Top">
|
|
6650
|
+
<inheritdoc/>
|
|
6651
|
+
</member>
|
|
6652
|
+
<member name="P:IronPdf.Pages.LineTextObject.Bottom">
|
|
6653
|
+
<inheritdoc/>
|
|
6654
|
+
</member>
|
|
6655
|
+
<member name="P:IronPdf.Pages.LineTextObject.Contents">
|
|
6656
|
+
<inheritdoc/>
|
|
6657
|
+
</member>
|
|
6658
|
+
<member name="M:IronPdf.Pages.LineTextObject.#ctor(IronSoftware.IPdfDocumentId,IronSoftware.IDocumentTextObject)">
|
|
6659
|
+
<summary>
|
|
6660
|
+
Create a new line text object and add the specified chunk
|
|
6661
|
+
</summary>
|
|
6662
|
+
<param name="id">Document identifier</param>
|
|
6663
|
+
<param name="chunk">Chunk to add</param>
|
|
6664
|
+
</member>
|
|
6291
6665
|
<member name="T:IronPdf.Pages.PdfPage">
|
|
6292
6666
|
<summary>
|
|
6293
6667
|
A class which represents one page of a PDF Document.
|
|
@@ -6323,6 +6697,37 @@
|
|
|
6323
6697
|
Gets the page index
|
|
6324
6698
|
</summary>
|
|
6325
6699
|
</member>
|
|
6700
|
+
<member name="P:IronPdf.Pages.PdfPage.Characters">
|
|
6701
|
+
<summary>
|
|
6702
|
+
A collection of all characters on this page and their position
|
|
6703
|
+
<para>
|
|
6704
|
+
Also see <seealso cref="P:IronPdf.Pages.PdfPage.TextChunks"/> and <seealso cref="P:IronPdf.Pages.PdfPage.Lines"/>
|
|
6705
|
+
</para>
|
|
6706
|
+
</summary>
|
|
6707
|
+
</member>
|
|
6708
|
+
<member name="P:IronPdf.Pages.PdfPage.TextChunks">
|
|
6709
|
+
<summary>
|
|
6710
|
+
A collection of all text objects on this page and their position
|
|
6711
|
+
<para>
|
|
6712
|
+
The contents of each text object is rendered as a single unit
|
|
6713
|
+
</para>
|
|
6714
|
+
<para>
|
|
6715
|
+
The contents of each text object share font, origin position, etc.
|
|
6716
|
+
</para>
|
|
6717
|
+
<para>
|
|
6718
|
+
Also see <seealso cref="P:IronPdf.Pages.PdfPage.Characters"/> and <seealso cref="P:IronPdf.Pages.PdfPage.Lines"/>
|
|
6719
|
+
</para>
|
|
6720
|
+
</summary>
|
|
6721
|
+
</member>
|
|
6722
|
+
<member name="P:IronPdf.Pages.PdfPage.Lines">
|
|
6723
|
+
<summary>
|
|
6724
|
+
A collection of all lines of text on this page and their position
|
|
6725
|
+
</summary>
|
|
6726
|
+
<para>
|
|
6727
|
+
Also see <seealso cref="P:IronPdf.Pages.PdfPage.TextChunks"/> and <seealso cref="P:IronPdf.Pages.PdfPage.Characters"/>
|
|
6728
|
+
</para>
|
|
6729
|
+
<remarks>Derived from <see cref="P:IronPdf.Pages.PdfPage.TextChunks"/> for your convenience</remarks>
|
|
6730
|
+
</member>
|
|
6326
6731
|
<member name="T:IronPdf.Pages.PdfPagesCollection">
|
|
6327
6732
|
<summary>
|
|
6328
6733
|
Class for managing the collection of <see cref="T:IronPdf.Pages.PdfPage"/> elements.
|
|
@@ -6434,7 +6839,7 @@
|
|
|
6434
6839
|
</member>
|
|
6435
6840
|
<member name="P:IronPdf.HtmlFormatOptions.BackgroundColor">
|
|
6436
6841
|
<summary>
|
|
6437
|
-
The background color of the HTML body. Default is
|
|
6842
|
+
The background color of the HTML body. Default is white.
|
|
6438
6843
|
</summary>
|
|
6439
6844
|
</member>
|
|
6440
6845
|
<member name="P:IronPdf.HtmlFormatOptions.PdfPageMargin">
|
|
@@ -6444,7 +6849,7 @@
|
|
|
6444
6849
|
</member>
|
|
6445
6850
|
<member name="P:IronPdf.HtmlFormatOptions.H1Color">
|
|
6446
6851
|
<summary>
|
|
6447
|
-
The color of the title (h1) in the HTML document. Default is
|
|
6852
|
+
The color of the title (h1) in the HTML document. Default is black.
|
|
6448
6853
|
</summary>
|
|
6449
6854
|
</member>
|
|
6450
6855
|
<member name="P:IronPdf.HtmlFormatOptions.H1FontSize">
|
|
@@ -6805,6 +7210,59 @@
|
|
|
6805
7210
|
<c>true</c> if successful.
|
|
6806
7211
|
</returns>
|
|
6807
7212
|
</member>
|
|
7213
|
+
<member name="M:IronPdf.TableOfContents.TableOfContentsCssMerger.MergeCss(System.String,System.String)">
|
|
7214
|
+
<summary>
|
|
7215
|
+
Merge a source CSS file into a target CSS file.
|
|
7216
|
+
</summary>
|
|
7217
|
+
<param name="tableOfContentsCss">The source CSS file.</param>
|
|
7218
|
+
<param name="customCss">The target CSS file which will be updated with values from source CSS file.</param>
|
|
7219
|
+
<returns>A CSS string in which the tableOfContentsCss is merged with the customCss.</returns>
|
|
7220
|
+
</member>
|
|
7221
|
+
<member name="M:IronPdf.TableOfContents.TableOfContentsHelper.ParseHeaderPageNumbers(IronPdf.PdfDocument,System.String)">
|
|
7222
|
+
<summary>
|
|
7223
|
+
Find all headers in an HTML document and parse the related page numbers.
|
|
7224
|
+
</summary>
|
|
7225
|
+
<param name="document">A PDF document</param>
|
|
7226
|
+
<param name="html">The HTML used to generate the PDF document.</param>
|
|
7227
|
+
<returns>A collection of page numbers.</returns>
|
|
7228
|
+
</member>
|
|
7229
|
+
<member name="M:IronPdf.TableOfContents.TableOfContentsHelper.FindPageNumbers(IronPdf.PdfDocument,System.Collections.Generic.Queue{System.String})">
|
|
7230
|
+
<summary>
|
|
7231
|
+
Look inside a PDF document to find page numbers for each header inside the headerQueue.
|
|
7232
|
+
</summary>
|
|
7233
|
+
<param name="document">A PDF document in which to search for headers.</param>
|
|
7234
|
+
<param name="headerQueue">A queue of headers.</param>
|
|
7235
|
+
<returns>An enumeration of page numbers.</returns>
|
|
7236
|
+
</member>
|
|
7237
|
+
<member name="M:IronPdf.TableOfContents.TableOfContentsHelper.ParseHeaders(System.String)">
|
|
7238
|
+
<summary>
|
|
7239
|
+
Parse all headers from an HTML string.
|
|
7240
|
+
<para>Headers should use the appropriate header tags, so from <h1> up to </h6>.</para>
|
|
7241
|
+
</summary>
|
|
7242
|
+
<param name="html">The HTML to parse headers from.</param>
|
|
7243
|
+
<returns>A queue of header titles.</returns>
|
|
7244
|
+
</member>
|
|
7245
|
+
<member name="T:IronPdf.TableOfContentsTypes">
|
|
7246
|
+
<summary>
|
|
7247
|
+
Table of contents layout type
|
|
7248
|
+
</summary>
|
|
7249
|
+
</member>
|
|
7250
|
+
<member name="F:IronPdf.TableOfContentsTypes.None">
|
|
7251
|
+
<summary>
|
|
7252
|
+
Do not create a table of contents
|
|
7253
|
+
</summary>
|
|
7254
|
+
</member>
|
|
7255
|
+
<member name="F:IronPdf.TableOfContentsTypes.Basic">
|
|
7256
|
+
<summary>
|
|
7257
|
+
Create a table of contents without page numbers
|
|
7258
|
+
</summary>
|
|
7259
|
+
<remarks>More performant, but does not include page numbers</remarks>
|
|
7260
|
+
</member>
|
|
7261
|
+
<member name="F:IronPdf.TableOfContentsTypes.WithPageNumbers">
|
|
7262
|
+
<summary>
|
|
7263
|
+
Create a table of contents WITH page numbers
|
|
7264
|
+
</summary>
|
|
7265
|
+
</member>
|
|
6808
7266
|
<member name="T:IronPdf.TextHeaderFooter">
|
|
6809
7267
|
<summary>
|
|
6810
7268
|
Defines PDF Header and Footer display options.
|
|
@@ -6831,7 +7289,7 @@
|
|
|
6831
7289
|
</member>
|
|
6832
7290
|
<member name="P:IronPdf.TextHeaderFooter.Font">
|
|
6833
7291
|
<summary>
|
|
6834
|
-
Font family <see cref="T:IronSoftware.Drawing.FontTypes"/>. Default is <see cref="P:IronSoftware.Drawing.FontTypes.
|
|
7292
|
+
Font family <see cref="T:IronSoftware.Drawing.FontTypes"/>. Default is <see cref="P:IronSoftware.Drawing.FontTypes.Helvetica"/>
|
|
6835
7293
|
</summary>
|
|
6836
7294
|
</member>
|
|
6837
7295
|
<member name="P:IronPdf.TextHeaderFooter.FontSize">
|