Class PDFNet.PDFACompliance
PDFNet.PDFACompliance
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
PDFACompliance class is used to validate PDF documents for PDF/A (ISO 19005:1/2/3)
compliance or to convert existing PDF files to PDF/A compliant documents.
|
| Method Attributes | Method Name and Description |
|---|---|
| <static> |
PDFNet.PDFACompliance.createFromBuffer(convert, buf, password, {string}, max_ref_objs, max_ref_objs, first_stop, first_stop)
perform PDF/A validation or PDF/A conversion on the input PDF document
which is stored in a memory buffer.
|
|
destroy()
Frees the native memory of the object.
|
|
|
getError(idx)
|
|
| <static> |
PDFNet.PDFACompliance.getPDFAErrorMessage(id)
|
|
getRefObj(id, err_idx)
|
|
|
getRefObjCount(id)
|
|
|
saveAsFromBuffer(linearized)
[Documentation Not Yet Added]
|
|
|
saveAsFromFileName(file_path, linearized)
serializes the converted PDF/A document to a file on disk.
|
Class Detail
PDFNet.PDFACompliance(id)
PDFACompliance class is used to validate PDF documents for PDF/A (ISO 19005:1/2/3)
compliance or to convert existing PDF files to PDF/A compliant documents.
The conversion option analyzes the content of existing PDF files and performs
a sequence of modifications in order to produce a PDF/A compliant document.
Features that are not suitable for long-term archiving (such as encryption,
obsolete compression schemes, missing fonts, or device-dependent color) are
replaced with their PDF/A compliant equivalents. Because the conversion process
applies only necessary changes to the source file, the information loss is
minimal. Also, because the converter provides a detailed report for each change,
it is simple to inspect changes and to determine whether the conversion loss
is acceptable.
The validation option in PDF/A Manager can be used to quickly determine whether
a PDF file fully complies with the PDF/A specification according to the
international standard ISO 19005:1/2/3. For files that are not compliant, the
validation option can be used to produce a detailed report of compliance
violations as well as a list of relevant error objects.
Key Functions:
- Checks if a PDF file is compliant with PDF/A (ISO 19005:1/2/3) specification.
- Converts any PDF to a PDF/A compliant document.
- Supports PDF/A-1a, PDF/A-1b, PDF/A-2b
- Produces a detailed report of compliance violations and associated PDF objects.
- Keeps the required changes a minimum, preserving the consistency of the original.
- Tracks all changes to allow for automatic assessment of data loss.
- Allows user to customize compliance checks or omit specific changes.
- Preserves tags, logical structure, and color information in existing PDF documents.
- Offers automatic font substitution, embedding, and subsetting options.
- Supports automation and batch operation. PDF/A Converter is designed to be used
in unattended mode in high throughput server or batch environments
- Parameters:
- id
Method Detail
<static>
{PDFACompliance}
PDFNet.PDFACompliance.createFromBuffer(convert, buf, password, {string}, max_ref_objs, max_ref_objs, first_stop, first_stop)
perform PDF/A validation or PDF/A conversion on the input PDF document
which is stored in a memory buffer.
- Parameters:
- {boolean} convert
- A flag used to instruct PDF/A processor to perform PDF/A conversion (if 'true') or PDF/A validation (if 'false'). After PDF/A conversion you can save the resulting document using Save() method(s).
- {Array} buf
- A memory buffer containing the serialized PDF document.
- {number} password
- An optional parameter that can be used to specify the password for encrypted PDF documents (typically only useful in the conversion mode).
- {number [Y]} {string}
- conf The PDF conformance level. The default value is e_Level1B.
- {number [Y]} max_ref_objs
- The maximum number of object references per error condition.
- {number} max_ref_objs
- (generated documentation)
- {number} first_stop
- (generated documentation)
- first_stop
- Returns:
- {PDFACompliance} A promise that resolves to an object of type: "PDFACompliance" (generated documentation)
destroy()
Frees the native memory of the object.
{number}
getError(idx)
Return value enum:
PDFNet.PDFACompliance.ErrorCode = {
e_PDFA0_1_0 : 10
e_PDFA0_1_1 : 11
e_PDFA0_1_2 : 12
e_PDFA0_1_3 : 13
e_PDFA0_1_4 : 14
e_PDFA0_1_5 : 15
e_PDFA1_2_1 : 121
e_PDFA1_2_2 : 122
e_PDFA1_3_1 : 131
e_PDFA1_3_2 : 132
e_PDFA1_3_3 : 133
e_PDFA1_3_4 : 134
e_PDFA1_4_1 : 141
e_PDFA1_4_2 : 142
e_PDFA1_6_1 : 161
e_PDFA1_7_1 : 171
e_PDFA1_7_2 : 172
e_PDFA1_7_3 : 173
e_PDFA1_7_4 : 174
e_PDFA1_8_1 : 181
e_PDFA1_8_2 : 182
e_PDFA1_8_3 : 183
e_PDFA1_8_4 : 184
e_PDFA1_8_5 : 185
e_PDFA1_8_6 : 186
e_PDFA1_10_1 : 1101
e_PDFA1_11_1 : 1111
e_PDFA1_11_2 : 1112
e_PDFA1_12_1 : 1121
e_PDFA1_12_2 : 1122
e_PDFA1_12_3 : 1123
e_PDFA1_12_4 : 1124
e_PDFA1_12_5 : 1125
e_PDFA1_12_6 : 1126
e_PDFA1_13_1 : 1131
e_PDFA2_2_1 : 221
e_PDFA2_3_2 : 232
e_PDFA2_3_3 : 233
e_PDFA2_3_3_1 : 2331
e_PDFA2_3_3_2 : 2332
e_PDFA2_3_4_1 : 2341
e_PDFA2_4_1 : 241
e_PDFA2_4_2 : 242
e_PDFA2_4_3 : 243
e_PDFA2_4_4 : 244
e_PDFA2_5_1 : 251
e_PDFA2_5_2 : 252
e_PDFA2_6_1 : 261
e_PDFA2_7_1 : 271
e_PDFA2_8_1 : 281
e_PDFA2_9_1 : 291
e_PDFA2_10_1 : 2101
e_PDFA3_2_1 : 321
e_PDFA3_3_1 : 331
e_PDFA3_3_2 : 332
e_PDFA3_3_3_1 : 3331
e_PDFA3_3_3_2 : 3332
e_PDFA3_4_1 : 341
e_PDFA3_5_1 : 351
e_PDFA3_5_2 : 352
e_PDFA3_5_3 : 353
e_PDFA3_5_4 : 354
e_PDFA3_5_5 : 355
e_PDFA3_5_6 : 356
e_PDFA3_6_1 : 361
e_PDFA3_7_1 : 371
e_PDFA3_7_2 : 372
e_PDFA3_7_3 : 373
e_PDFA4_1 : 41
e_PDFA4_2 : 42
e_PDFA4_3 : 43
e_PDFA4_4 : 44
e_PDFA4_5 : 45
e_PDFA4_6 : 46
e_PDFA5_2_1 : 521
e_PDFA5_2_2 : 522
e_PDFA5_2_3 : 523
e_PDFA5_2_4 : 524
e_PDFA5_2_5 : 525
e_PDFA5_2_6 : 526
e_PDFA5_2_7 : 527
e_PDFA5_2_8 : 528
e_PDFA5_2_9 : 529
e_PDFA5_2_10 : 5210
e_PDFA5_2_11 : 5211
e_PDFA5_3_1 : 531
e_PDFA5_3_2_1 : 5321
e_PDFA5_3_2_2 : 5322
e_PDFA5_3_2_3 : 5323
e_PDFA5_3_2_4 : 5324
e_PDFA5_3_2_5 : 5325
e_PDFA5_3_3_1 : 5331
e_PDFA5_3_3_2 : 5332
e_PDFA5_3_3_3 : 5333
e_PDFA5_3_3_4 : 5334
e_PDFA5_3_4_0 : 5340
e_PDFA5_3_4_1 : 5341
e_PDFA5_3_4_2 : 5342
e_PDFA5_3_4_3 : 5343
e_PDFA6_1_1 : 611
e_PDFA6_1_2 : 612
e_PDFA6_2_1 : 621
e_PDFA6_2_2 : 622
e_PDFA6_2_3 : 623
e_PDFA7_2_1 : 721
e_PDFA7_2_2 : 722
e_PDFA7_2_3 : 723
e_PDFA7_2_4 : 724
e_PDFA7_2_5 : 725
e_PDFA7_3_1 : 731
e_PDFA7_3_2 : 732
e_PDFA7_3_3 : 733
e_PDFA7_3_4 : 734
e_PDFA7_3_5 : 735
e_PDFA7_3_6 : 736
e_PDFA7_3_7 : 737
e_PDFA7_3_8 : 738
e_PDFA7_3_9 : 739
e_PDFA7_5_1 : 751
e_PDFA7_8_1 : 781
e_PDFA7_8_2 : 782
e_PDFA7_8_3 : 783
e_PDFA7_8_4 : 784
e_PDFA7_8_5 : 785
e_PDFA7_8_6 : 786
e_PDFA7_8_7 : 787
e_PDFA7_8_8 : 788
e_PDFA7_8_9 : 789
e_PDFA7_8_10 : 7810
e_PDFA7_8_11 : 7811
e_PDFA7_8_12 : 7812
e_PDFA7_8_13 : 7813
e_PDFA7_8_14 : 7814
e_PDFA7_8_15 : 7815
e_PDFA7_8_16 : 7816
e_PDFA7_8_17 : 7817
e_PDFA7_8_18 : 7818
e_PDFA7_8_19 : 7819
e_PDFA7_8_20 : 7820
e_PDFA7_8_21 : 7821
e_PDFA7_8_22 : 7822
e_PDFA7_8_23 : 7823
e_PDFA7_8_24 : 7824
e_PDFA7_8_25 : 7825
e_PDFA7_8_26 : 7826
e_PDFA7_8_27 : 7827
e_PDFA7_8_28 : 7828
e_PDFA7_8_29 : 7829
e_PDFA7_8_30 : 7830
e_PDFA7_8_31 : 7831
e_PDFA7_11_1 : 7111
e_PDFA7_11_2 : 7112
e_PDFA7_11_3 : 7113
e_PDFA7_11_4 : 7114
e_PDFA7_11_5 : 7115
e_PDFA9_1 : 91
e_PDFA9_2 : 92
e_PDFA9_3 : 93
e_PDFA9_4 : 94
e_PDFA3_8_1 : 381
e_PDFA8_2_2 : 822
e_PDFA8_3_3_1 : 8331
e_PDFA8_3_3_2 : 8332
e_PDFA8_3_4_1 : 8341
e_PDFA1_2_3 : 123
e_PDFA1_10_2 : 1102
e_PDFA1_10_3 : 1103
e_PDFA1_12_10 : 11210
e_PDFA1_13_5 : 1135
e_PDFA2_3_10 : 2310
e_PDFA2_4_2_10 : 24220
e_PDFA2_4_2_11 : 24221
e_PDFA2_4_2_12 : 24222
e_PDFA2_4_2_13 : 24223
e_PDFA2_5_10 : 2510
e_PDFA2_5_11 : 2511
e_PDFA2_5_12 : 2512
e_PDFA2_8_3_1 : 2831
e_PDFA2_8_3_2 : 2832
e_PDFA2_8_3_3 : 2833
e_PDFA2_8_3_4 : 2834
e_PDFA2_8_3_5 : 2835
e_PDFA2_10_20 : 21020
e_PDFA2_10_21 : 21021
e_PDFA11_0_0 : 11000
e_PDFA6_2_11_8 : 62118
e_PDFA8_1 : 81
e_PDFA_3E1 : 1
e_PDFA_3E2 : 2
e_PDFA_3E3 : 3
e_PDFA_LAST : 4
}
- Parameters:
- {number} idx
- The index in the array of error code identifiers. The array is indexed starting from zero.
- Returns:
- {number} A promise that resolves to the error identifier.
{number}
getErrorCount()
- Returns:
- {number} A promise that resolves to the number of compliance violations.
<static>
{string}
PDFNet.PDFACompliance.getPDFAErrorMessage(id)
- Parameters:
- {number} id
- error code identifier (obtained using GetError() method).
- Returns:
- {string} A promise that resolves to a descriptive error message for the given error identifier.
{number}
getRefObj(id, err_idx)
- Parameters:
- {number} id
- error code identifier (obtained using GetError() method).
- {number} err_idx
- The index in the array of object references. The array is indexed starting from zero.
- Returns:
- {number} A promise that resolves to a specific object reference associated with a given error type. The return value is a PDF object identifier (i.e. object number for 'pdftron.SDF.Obj)) for the that is associated with the error.
{number}
getRefObjCount(id)
- Parameters:
- {number} id
- error code identifier (obtained using GetError() method).
- Returns:
- {number} A promise that resolves to the number of object references associated with a given error.
saveAsFromBuffer(linearized)
[Documentation Not Yet Added]
- Parameters:
- {string} linearized
- (generated documentation)
saveAsFromFileName(file_path, linearized)
serializes the converted PDF/A document to a file on disk.
- Parameters:
- {string} file_path
- the output file name.
- {boolean} linearized
- An optional flag used to specify whether the the resulting PDF/A document should be web-optimized (linearized).