Apryse Node SDK

Class: PDFUAOptions

PDFNet.PDFUAConformance. PDFUAOptions

new PDFUAOptions()

Options for PDFNet.PDFUAConformance's validate and convert functions.

Methods

getConformanceLevel()

Gets the value ConformanceLevel from the options object. The PDF/UA conformance level. By default the conformance level is PDF/UA-1.
Returns:
The current value for ConformanceLevel.
Type
number

getDefaultLangCode()

Gets the value DefaultLangCode from the options object. The natural language code to set on the document if it is missing.
Returns:
The current value for DefaultLangCode.
Type
string

getFigureAltTextPrefix()

Gets the value FigureAltTextPrefix from the options object. The prefix to use when setting Alt for Image and Graphic tags. By default, and when this is empty, the tag name will be used.
Returns:
The current value for FigureAltTextPrefix.
Type
string

getFirstStop()

Gets the value FirstStop from the options object. Whether to stop processing after the first PDF/UA error is detected. By default, processing continues.
Returns:
The current value for FirstStop.
Type
boolean

getMaxRefObjs()

Gets the value MaxRefObjs from the options object. The maximum number of object references per error condition. This is 10 by default.
Returns:
The current value for MaxRefObjs.
Type
number

getPassword()

Gets the value Password from the options object. The password to be used for encrypted PDF documents. By default, no password is used.
Returns:
The current value for Password.
Type
string

getSaveLinearized()

Gets the value SaveLinearized from the options object. Whether to linearize when saving converted output. By default, the output is not linearized.
Returns:
The current value for SaveLinearized.
Type
boolean

setConformanceLevel(value)

Sets the value for ConformanceLevel in the options object. The PDF/UA conformance level. By default the conformance level is PDF/UA-1.
Parameters:
Name Type Description
value number The new value for ConformanceLevel.
Returns:
This object, for call chaining.
Type
PDFNet.PDFUAConformance.PDFUAOptions

setDefaultLangCode(value)

Sets the value for DefaultLangCode in the options object. The natural language code to set on the document if it is missing.
Parameters:
Name Type Description
value string The new value for DefaultLangCode
Returns:
This object, for call chaining.
Type
PDFNet.PDFUAConformance.PDFUAOptions

setFigureAltTextPrefix(value)

Sets the value for FigureAltTextPrefix in the options object. The prefix to use when setting Alt for Image and Graphic tags. By default, and when this is empty, the tag name will be used.
Parameters:
Name Type Description
value string The new value for FigureAltTextPrefix
Returns:
This object, for call chaining.
Type
PDFNet.PDFUAConformance.PDFUAOptions

setFirstStop(value)

Sets the value for FirstStop in the options object. Whether to stop processing after the first PDF/UA error is detected. By default, processing continues.
Parameters:
Name Type Description
value boolean The new value for FirstStop.
Returns:
This object, for call chaining.
Type
PDFNet.PDFUAConformance.PDFUAOptions

setMaxRefObjs(value)

Sets the value for MaxRefObjs in the options object. The maximum number of object references per error condition. This is 10 by default.
Parameters:
Name Type Description
value number The new value for MaxRefObjs.
Returns:
This object, for call chaining.
Type
PDFNet.PDFUAConformance.PDFUAOptions

setPassword(value)

Sets the value for Password in the options object. The password to be used for encrypted PDF documents. By default, no password is used.
Parameters:
Name Type Description
value string The new value for Password.
Returns:
This object, for call chaining.
Type
PDFNet.PDFUAConformance.PDFUAOptions

setSaveLinearized(value)

Sets the value for SaveLinearized in the options object. Whether to linearize when saving converted output. By default, the output is not linearized.
Parameters:
Name Type Description
value boolean The new value for SaveLinearized.
Returns:
This object, for call chaining.
Type
PDFNet.PDFUAConformance.PDFUAOptions