Apryse Node SDK

Class: TransPDFOptions

PDFNet.TransPDF. TransPDFOptions

new TransPDFOptions()

Options for PDFNet.TransPDF.TransPDFOptions

Members

<static> XLIFFVersion

An enumeration used to specify the XLIFF version.
Type:
  • number
Properties:
Name Type Description
e_xliff_version_1 number XLIFF version 1.2.
e_xliff_version_2 number XLIFF version 2.0.

Methods

getBatchSize()

Gets the value BatchSize from the options object. The number of pages to process before saving an intermediate PDF to free resources. A greater number of pages will increase memory usage, and a smaller number will increase processing time. Default is 20.
Returns:
The current value for BatchSize.
Type
number

getFlipPageContentsForBiDirectionalTranslations()

Gets the value FlipPageContentsForBiDirectionalTranslations from the options object. If true, any text and images on the page will have their positions inverted on the x-axis and vector artwork will be flipped on the x-axis.
Returns:
The current value for FlipPageContentsForBiDirectionalTranslations.
Type
boolean

getPages()

Gets the value Pages from the options object. Specifies a set of pages to process, such as "1-5", or "1-3,5,7-10". Open ended ranges are supported, e.g., "3-". By default all pages are processed. The first page is page number 1. This option only affects XLIFF extraction.
Returns:
The current value for Pages.
Type
string

getResizeSingleLine()

Gets the value ResizeSingleLine from the options object. If true, single line text boxes will grow and shrink to accommodate translated text.
Returns:
The current value for ResizeSingleLine.
Type
boolean

getSourceLanguage()

Gets the value SourceLanguage from the options object. A language code as specified in [RFC 4646] that identifies the language of the source PDF. This will be set as the 'source-language' attribute of the file tag in the extracted XLIFF. Default is 'en' (English).
Returns:
The current value for SourceLanguage.
Type
string

getXLIFFVersion()

Gets the value XLIFFVersion from the options object. Specifies the XLIFF version to use for export. Only 1.2 and 2.0 are currently supported. Any other versions will default to 1.2.
Returns:
The current value for XLIFFVersion.
Type
number
Example
Return value:
<pre>
PDFNet.TransPDF.TransPDFOptions.XLIFFVersion = {
 e_xliff_version_1 : 1
 e_xliff_version_2 : 2
}
</pre>

setBatchSize(value)

Sets the value for BatchSize in the options object. The number of pages to process before saving an intermediate PDF to free resources. A greater number of pages will increase memory usage, and a smaller number will increase processing time. Default is 20.
Parameters:
Name Type Description
value number The new value for BatchSize
Returns:
This object, for call chaining.
Type
PDFNet.TransPDF.TransPDFOptions

setFlipPageContentsForBiDirectionalTranslations(value)

Sets the value for FlipPageContentsForBiDirectionalTranslations in the options object. If true, any text and images on the page will have their positions inverted on the x-axis and vector artwork will be flipped on the x-axis.
Parameters:
Name Type Description
value boolean The new value for FlipPageContentsForBiDirectionalTranslations
Returns:
This object, for call chaining.
Type
PDFNet.TransPDF.TransPDFOptions

setPages(value)

Sets the value for Pages in the options object. Specifies a set of pages to process, such as "1-5", or "1-3,5,7-10". Open ended ranges are supported, e.g., "3-". By default all pages are processed. The first page is page number 1.
Parameters:
Name Type Description
value string The new value for Pages
Returns:
This object, for call chaining.
Type
PDFNet.TransPDF.TransPDFOptions

setResizeSingleLine(value)

Sets the value for ResizeSingleLine in the options object. If true, single line text boxes will grow and shrink to accommodate translated text.
Parameters:
Name Type Description
value boolean The new value for ResizeSingleLine
Returns:
This object, for call chaining.
Type
PDFNet.TransPDF.TransPDFOptions

setSourceLanguage(value)

Sets the value for SourceLanguage in the options object. A language code as specified in [RFC 4646] that identifies the language of the source PDF. This will be set as the 'source-language' attribute of the file tag in the extracted XLIFF. Default is 'en' (English).
Parameters:
Name Type Description
value string The new value for SourceLanguage
Returns:
This object, for call chaining.
Type
PDFNet.TransPDF.TransPDFOptions

setXLIFFVersion(value)

Sets the value for XLIFFVersion in the options object. Specifies the XLIFF version to use for export. Only 1.2 and 2.0 are currently supported. Any other versions will default to 1.2.
Parameters:
Name Type Description
value number The new value for XLIFFVersion 
PDFNet.TransPDF.TransPDFOptions.XLIFFVersion = {
 e_xliff_version_1 : 1
 e_xliff_version_2 : 2
}
Returns:
This object, for call chaining.
Type
PDFNet.TransPDF.TransPDFOptions