You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: libraries/radpdfprocessing/formats-and-conversion/pdf/pdfformatprovider/settings.md
+11-8Lines changed: 11 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,7 +29,7 @@ The **PdfFormatProvider** class offers the **ImportSettings** property which all
29
29
30
30
|Property|Description|
31
31
|----|----|
32
-
|**ReadingMode**|Gets or sets the mode for loading the document pages content on import. *Introduced in R2 2020*.<table><tr><tdwidth="20%">**ReadAllAtOnce**</td><td>All document pages content will be loaded on import. This is the default behavior.</td></tr><tr><td>**OnDemand**</td><td>The document pages content will be loaded on demand. This mode is made for use with PdfViewers and only the currently visible page will be loaded. </td></tr></table> Currently, the **OnDemand** mode should be applied when using with viewers only.|
32
+
|**ReadingMode**|Gets or sets the mode for loading the document pages content on import. *Introduced in R2 2020*.<ul><li>**ReadAllAtOnce**: All document pages content will be loaded on import. This is the default behavior.</li><li>**OnDemand**: The document pages content will be loaded on demand. This mode is made for use with PdfViewers and only the currently visible page will be loaded. </td></tr></ul> Currently, the **OnDemand** mode should be applied when using with viewers only.|
33
33
|**CopyStream**|Gets or sets whether to copy the document stream on import. When false and ReadingMode is OnDemand, the original stream must be kept open while the document is in use. When true, the original stream can be disposed after import, regardless of the reading mode.|
34
34
35
35
|Event|Description|
@@ -50,20 +50,23 @@ The **PdfFormatProvider** class offers the **ExportSettings** property which all
50
50
|----|----|
51
51
|**StripJavaScriptActions**|Specifies if the PDF document should strip JavaScript actions on export. *Introduced in Q4 2024*.|
52
52
|**ShouldEmbedFonts** (obsolete)|Specifies whether the font files should be embedded in the PDF document. The default value is *true* because the fonts should be embedded in the file by the PDF Standard. This means that by default the fonts are added which allows proper viewing on any device. If the fonts are not embedded and the file is viewed on a device that does not have the used fonts the font might be substituted. If the font is embedded in the PDF file, it ensures the most predictable and dependable results. As of **Q2 2024** the **ShouldEmbedFonts** property is obsolete. Use the **FontEmbeddingType** property instead.|
53
-
|**FontEmbeddingType**|The property controls what part of the fonts will be embedded in the file offering the following options: <table><tr><tdwidth="20%">**None**</td><td>Does not embed fonts.</td></tr><tr><td>**Full**</td><td>Fully embeds fonts.</td></tr><tr><td>**Subset**</td><td>Embeds only the used characters subset of the fonts. This is the default approach.</td></tr></table> The subset export option is currently implemented **only** for TrueType fonts (.ttf).|
53
+
|**FontEmbeddingType**|The property controls what part of the fonts will be embedded in the file offering the following options: <ul><li>**None**: Does not embed fonts.</li><li>**Full**: Fully embeds fonts.</li><li>**Subset**: Embeds only the used characters subset of the fonts. This is the default approach.</li></tr></ul> The subset export option is currently implemented **only** for TrueType fonts (.ttf).|
54
54
|**IsEncrypted**|This property specifies if the document should be encrypted. The default value is *false*. You can specify the encryption algorithm by setting the **EncryptionType** property. The supported values are **AES256** and **RC4**. </br>**All passwords for revision 6 (AES-256) shall be based on Unicode**. Preprocessing of a user-provided password consists first of normalizing its representation by applying the "SASLPrep" profile (Internet RFC 4013) of the "stringprep" algorithm (Internet RFC 3454) to the supplied password using the Normalize and BiDi options. </br> This setting is ignored when __ComplianceLevel__ differs from __None__ as PDF/A compliant documents do not allow encryption.|
55
55
|**UserPassword**|The password to be used if the document is encrypted. The default password is an empty string.|
56
56
|**OwnerPassword**|The password that governs permissions for operations such as printing, copying, and modifying the document. The default password is an empty string.|
57
-
|**UserAccessPermissions**|Gets or sets the user access permissions. These permissions specify which access permissions should be granted when the document is opened with user access. In order to be applied, the **IsEncrypted** property should be set to *true*. This property specifies three types of user access permissions: [Available UserAccessPermissions]({%slug radpdfprocessing-formats-and-conversion-pdf-settings%})#available-useraccesspermissions|
57
+
|**UserAccessPermissions**|Gets or sets the user access permissions. These permissions specify which access permissions should be granted when the document is opened with user access. In order to be applied, the **IsEncrypted** property should be set to *true*. This property specifies three types of user access permissions: [Available UserAccessPermissions]({%slug radpdfprocessing-formats-and-conversion-pdf-settings%}#available-useraccesspermissions)|
58
58
|**ImageQuality**|Specifies the quality with which images are exported to PDF. More information about how it works is available in [this article]({%slug radpdfprocessing-concepts-imagequality%}). </br> **.NET Standard** specification does not define APIs for converting images or scaling their quality. That is why to allow the library to export images different than Jpeg and Jpeg2000 or ImageQuality different than High, you will need to provide an implementation of the **JpegImageConverterBase** abstract class. This implementation should be passed to the **JpegImageConverter** property of the **FixedExtensibilityManager**. For more information check the [Cross-Platform Support]({%slug radpdfprocessing-cross-platform%}) help article.|
59
-
|**ImageCompression**|Sets the desired compression for the images when exporting. You can set one of the following values of the **ImageFilterTypes**: <table><tr><tdwidth="20%">**Default**</td><td>The image compression will be preserved as it is in the original document.</td></tr><tr><td>**None**</td><td>The images won't be encoded.</td></tr><tr><td>**FlateDecode**</td><td>The images will be encoded with a FlateDecode filter. Compresses data using the zlib/deflate compression method.</td></tr><tr><td>**DCTDecode**</td><td> The images will be encoded with a DCTDecode filter. Compresses data using a DCT (discrete cosine transform) technique based on the JPEG standard.</td></tr></table>|
60
-
|**StreamCompression**|Gets or sets the content stream compression type. Possible Values are: <table><tr><tdwidth="20%">**None**</td><td>The content streams won't be encoded.</td></tr><tr><td>**FlateDecode**</td><td>Compresses data using the zlib/deflate compression method.</td></tr></table>|
61
-
|**ComplianceLevel**|Specifies the PDF/A compliance level. It can have one of the following values: <table><tr><tdwidth="20%">**None**</td><td>Specify no compliance level.</td></tr><tr><td>**PdfA1B**</td><td>Specify PDF/A-1b compliance level.</td></tr><tr><td>**PdfA2B**</td><td>Specify PDF/A-2b compliance level.</td></tr><tr><td>**PdfA2U**</td><td>Specify PDF/A-2u compliance level.</td></tr><tr><td>**PdfA3B**</td><td>Specify PDF/A-3b compliance level.</td></tr><tr><td>**PdfA3U**</td><td>Specify PDF/A-3u compliance level.</td></tr></table> The default value is __None__. For more information on PDF/A compliance, check the [PDF/A Compliance article]({%slug radpdfprocessing-howto-comply-with-pdfa-standard%}).|
59
+
|**ImageCompression**|Sets the desired compression for the images when exporting. You can set one of the following values of the **ImageFilterTypes**: <ul><li>**Default**: The image compression will be preserved as it is in the original document.</li><li>**None**: The images won't be encoded.</li><li>**FlateDecode**: The images will be encoded with a FlateDecode filter. Compresses data using the zlib/deflate compression method.</li><li>**DCTDecode**: The images will be encoded with a DCTDecode filter. Compresses data using a DCT (discrete cosine transform) technique based on the JPEG standard.</li></ul>|
60
+
|**StreamCompression**|Gets or sets the content stream compression type. Possible Values are: <ul><li>**None**: The content streams won't be encoded.</li><li>**FlateDecode**: Compresses data using the zlib/deflate compression method.</li></ul>|
61
+
|**ComplianceLevel**|Specifies the PDF/A compliance level. It can have one of the following values: <ul><li>**None**: Specify no compliance level.</li><li>**PdfA1B**: Specify PDF/A-1b compliance level.</li><li>**PdfA2B**: Specify PDF/A-2b compliance level.</li><li>**PdfA2U**: Specify PDF/A-2u compliance level.</li><li>**PdfA3B**: Specify PDF/A-3b compliance level.</td></tr><tr><td>**PdfA3U**</td><td>Specify PDF/A-3u compliance level.</td></tr></ul> The default value is __None__. For more information on PDF/A compliance, check the [PDF/A Compliance article]({%slug radpdfprocessing-howto-comply-with-pdfa-standard%}).|
62
62
|**ShouldExportXfa**|Specifies whether the PDF document should export XFA content (if any). Default value: *false*. Introduced in **Q1 2025**.|
63
63
64
64
### Available UserAccessPermissions
65
-
66
-
<table><tr><td width="20%" style="font-weight:bold;">PrintingPermissionType</td><td>Sets the permissions for document printing. Possible values: <table><tr><td width="40%" style="font-weight:bold;">None</td><td>Specify no printing is allowed.</td></tr><tr><td style="font-weight:bold;">LowResolution</td><td>Specify low resolution (150 dpi) printing is allowed.</td></tr><tr><td style="font-weight:bold;">HighResolution</td><td>Specify printing on the highest resolution is allowed.</td></tr></table></td></tr><tr><td style="font-weight:bold;">ChangingPermissionType</td><td>Sets the permissions for making changes to the document. Possible values: <table><tr><td width="40%" style="font-weight:bold;">None</td><td>Specify no document changes are allowed.</td></tr><tr><td style="font-weight:bold;">DocumentAssembly</td><td>Specify inserting, deleting, and rotating page changes are allowed.</td></tr><tr><td style="font-weight:bold;">FormFieldFillingOrSigning</td><td>Specify filling in form fields and signing existing signature fields changes are allowed.</td></tr><tr><td style="font-weight:bold;">FormFieldFillingOrSigningAndCommenting</td><td>Specify commenting, filling in form fields, and signing existing signature fields changes are allowed.</td></tr><tr><td style="font-weight:bold;">AnyExceptExtractingPages</td><td>Specify any changes except extracting pages are allowed.</td></tr></table></td></tr><tr><td style="font-weight:bold;">CopyingPermissionType</td><td>Sets the permissions for document copying. Possible values: <table><tr><td width="40%" style="font-weight:bold;">None</td><td>Specify no copying is allowed.</td></tr><tr><td style="font-weight:bold;">Copying</td><td>Specify copying is allowed.</td></tr><tr><td style="font-weight:bold;">TextAccess</td><td>Specify that text access for screen reader devices for copying is allowed.</td></tr><tr><td style="font-weight:bold;">NumberingFieldsPrecisionLevel</td><td>Represents precision level when updating numbering fields. When the Normal option is selected the fields are updated once, not taking into account if their new values would have shifted the already measured layout. In such cases, the results could be outdated. This is the MS Word-like behavior. If you need more accurate results, use NumberingFieldsPrecisionLevel.High where the fields are updated until their values become more accurate. This precision level is more accurate than NumberingFieldsPrecisionLevel.Normal but requires more resources.</td></tr></table></td></tr></table>
65
+
|UserAccessPermission Type|Description|
66
+
|----|----|
67
+
|**PrintingPermissionType**|Sets the permissions for document printing. Possible values: <ul><li>**None**: Specify no printing is allowed.</li><li>**LowResolution**: Specify low resolution (150 dpi) printing is allowed.</li><li>**HighResolution**: Specify printing on the highest resolution is allowed.</li></ul>|
68
+
|**ChangingPermissionType**|Sets the permissions for making changes to the document. Possible values: <ul><li>**None**: Specify no document changes are allowed.</li><li>**DocumentAssembly**: Specify inserting, deleting, and rotating page changes are allowed.</li><li>**FormFieldFillingOrSigning**: Specify filling in form fields and signing existing signature fields changes are allowed.</li><li>**FormFieldFillingOrSigningAndCommenting**: Specify commenting, filling in form fields, and signing existing signature fields changes are allowed.</li><li>**AnyExceptExtractingPages**: Specify any changes except extracting pages are allowed.</li></ul>|
69
+
|**CopyingPermissionType**|Sets the permissions for document copying. Possible values: <ul><li>**None**: Specify no copying is allowed.</li><li>**Copying**: Specify copying is allowed.</li><li>**TextAccess**: Specify that text access for screen reader devices for copying is allowed.</li><li>**NumberingFieldsPrecisionLevel**: Represents precision level when updating numbering fields. When the Normal option is selected the fields are updated once, not taking into account if their new values would have shifted the already measured layout. In such cases, the results could be outdated. This is the MS Word-like behavior. If you need more accurate results, use NumberingFieldsPrecisionLevel.High where the fields are updated until their values become more accurate. This precision level is more accurate than NumberingFieldsPrecisionLevel.Normal but requires more resources.</li></ul>|
67
70
68
71
>important The receiver of a PDF document must have the same fonts that were originally used to create it. If a different font is substituted, its character set, glyph shapes, and metrics may differ from those in the original font. This substitution can produce unexpected and unwanted results, such as lines of text extending into margins or overlapping with graphics. A PDF file can refer by name to fonts that are not embedded in the PDF file. In this case, a PDF consumer can use those fonts if they are available in its environment. This approach suffers from the uncertainties noted above.
0 commit comments