Apryse Node SDK

Class: DOCXCompareOptions

PDFNet.DOCXCompare. DOCXCompareOptions

new DOCXCompareOptions()

Options for PDFNet.DOCXCompare.DOCXCompareOptions

Members

<static> DateMode

Specifies the date to use for tracked changes in the output document.
Type:
  • number
Properties:
Name Type Description
e_revised_save_date number Default value. Use the save date of the revised document.
e_current_date number Use the current date.
e_empty_date number Use an empty date.

Methods

getDateMode()

Gets the value DateMode from the options object. Specifies the date to use for tracked changes in the output document. By default, the save date of the revised document is used. If RevisedDate is provided this option has no effect.
Returns:
The current value for DateMode.
Type
number
Example
Return value:
<pre>
PDFNet.DOCXCompare.DOCXCompareOptions.DateMode = {
 e_revised_save_date : 0
 e_current_date : 1
 e_empty_date : 2
}
</pre>

getRevisedAuthor()

Gets the value RevisedAuthor from the options object. The author to use for tracked changes in the output document. If this option is not set the author will be extracted from the last-modified user in the metadata of the revised DOCX file. If that is not available, it will use the fixed author string "Comparison".
Returns:
The current value for RevisedAuthor.
Type
string

getRevisedDate()

Gets the value RevisedDate from the options object. A specific date to use for tracked changes in the output document, in the ISO 8601 format (YYYY-MM-DDThh:mm:ss). If this option is not set, the date will be determined based on the DateMode option. If an invalid value is given (not ISO 8601 format), it will result in an error.
Returns:
The current value for RevisedDate.
Type
string

getTreatStruckoutTextAsDeleted()

Gets the value TreatStruckoutTextAsDeleted from the options object. If this is true, both input files are pre-processed to remove text with strikeout. For example, supposed the original DOCX contains the text "ABC", and the revised DOCX contains the same "ABC" but it is struckout. When this option is false (default), this will be reported in the output as a tracked formatting change. However when this option is true, it will appear as a tracked deletion.
Returns:
The current value for TreatStruckoutTextAsDeleted.
Type
boolean

setDateMode(value)

Sets the value for DateMode in the options object. Specifies the date to use for tracked changes in the output document. By default, the save date of the revised document is used. If RevisedDate is provided this option has no effect.
Parameters:
Name Type Description
value number The new value for DateMode 
PDFNet.DOCXCompare.DOCXCompareOptions.DateMode = {
 e_revised_save_date : 0
 e_current_date : 1
 e_empty_date : 2
}
Returns:
This object, for call chaining.
Type
PDFNet.DOCXCompare.DOCXCompareOptions

setRevisedAuthor(value)

Sets the value for RevisedAuthor in the options object. The author to use for tracked changes in the output document. If this option is not set the author will be extracted from the last-modified user in the metadata of the revised DOCX file. If that is not available, it will use the fixed author string "Comparison".
Parameters:
Name Type Description
value string The new value for RevisedAuthor
Returns:
This object, for call chaining.
Type
PDFNet.DOCXCompare.DOCXCompareOptions

setRevisedDate(value)

Sets the value for RevisedDate in the options object. A specific date to use for tracked changes in the output document, in the ISO 8601 format (YYYY-MM-DDThh:mm:ss). If this option is not set, the date will be determined based on the DateMode option. If an invalid value is given (not ISO 8601 format), it will result in an error.
Parameters:
Name Type Description
value string The new value for RevisedDate
Returns:
This object, for call chaining.
Type
PDFNet.DOCXCompare.DOCXCompareOptions

setTreatStruckoutTextAsDeleted(value)

Sets the value for TreatStruckoutTextAsDeleted in the options object. If this is true, both input files are pre-processed to remove text with strikeout. For example, supposed the original DOCX contains the text "ABC", and the revised DOCX contains the same "ABC" but it is struckout. When this option is false (default), this will be reported in the output as a tracked formatting change. However when this option is true, it will appear as a tracked deletion.
Parameters:
Name Type Description
value boolean The new value for TreatStruckoutTextAsDeleted
Returns:
This object, for call chaining.
Type
PDFNet.DOCXCompare.DOCXCompareOptions