| java.lang.Object | ||
| ↳ | com.pdftron.pdf.OptionsBase | |
| ↳ | com.pdftron.office.DOCXCompareOptions | |
Summary
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| enum | DOCXCompareOptions.DateMode | Specifies the date to use for tracked changes in the output document. | |||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
DOCXCompareOptions()
Constructor.
| |||||||||||
|
DOCXCompareOptions(String json_string)
Constructor.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| DOCXCompareOptions.DateMode |
getDateMode()
Gets the value DateMode from the options object.
| ||||||||||
| String |
getRevisedAuthor()
Gets the value RevisedAuthor from the options object.
| ||||||||||
| String |
getRevisedDate()
Gets the value RevisedDate from the options object.
| ||||||||||
| boolean |
getTreatStruckoutTextAsDeleted()
Gets the value TreatStruckoutTextAsDeleted from the options object.
| ||||||||||
| DOCXCompareOptions |
setDateMode(DOCXCompareOptions.DateMode value)
Sets the value for DateMode in the options object.
| ||||||||||
| DOCXCompareOptions |
setRevisedAuthor(String value)
Sets the value for RevisedAuthor in the options object.
| ||||||||||
| DOCXCompareOptions |
setRevisedDate(String value)
Sets the value for RevisedDate in the options object.
| ||||||||||
| DOCXCompareOptions |
setTreatStruckoutTextAsDeleted(boolean value)
Sets the value for TreatStruckoutTextAsDeleted in the options object.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Public Constructors
Public Methods
public DOCXCompareOptions.DateMode 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.
Throws
| PDFNetException |
|---|
public String 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.
Throws
| PDFNetException |
|---|
public 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.
Throws
| PDFNetException |
|---|
public boolean 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.
Throws
| PDFNetException |
|---|
public DOCXCompareOptions setDateMode (DOCXCompareOptions.DateMode 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
| value | The new value for DateMode. |
|---|
Returns
- This object, for call chaining.
Throws
| PDFNetException |
|---|
public DOCXCompareOptions setRevisedAuthor (String 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
| value | The new value for RevisedAuthor. |
|---|
Returns
- This object, for call chaining.
Throws
| PDFNetException |
|---|
public DOCXCompareOptions setRevisedDate (String 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
| value | The new value for RevisedDate. |
|---|
Returns
- This object, for call chaining.
Throws
| PDFNetException |
|---|
public DOCXCompareOptions setTreatStruckoutTextAsDeleted (boolean 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
| value | The new value for TreatStruckoutTextAsDeleted. |
|---|
Returns
- This object, for call chaining.
Throws
| PDFNetException |
|---|