Document Editor - RevisionSettings

30 Sep 20262 minutes to read

Represents the revision settings.

Properties

customData string

Gets or sets the custom data value

Defaults to ’’

deleteRevisionColor string

Gets or sets the color value used for delete revisions for visual identification within the Document Editor.
The default value is ‘byAuthor’.
This property accepts either ‘byAuthor’ or a hexadecimal color value string (for example, ‘#b5082e’).
If the value is ‘byAuthor’, delete revisions (Deletion/MoveFrom) are highlighted using the author-specific color.
Otherwise, delete revisions are highlighted using the color value specified for this property.

  • Application-level only; not maintained in the DOCX file.

Defaults to ‘byAuthor’

deletedRowColor string

Gets or sets the background color used for deleted table-row for visual identification within the Document Editor.
The default value is ‘byAuthor’.
This property accepts either ‘byAuthor’ or a hexadecimal color value string (for example, ‘#b5082e’).
If the value is ‘byAuthor’, deleted row revisions (Deletion/MoveFrom) use the author-specific color.
Otherwise, deleted row revisions use the color value specified for this property.

  • Application-level only; not maintained in the DOCX file.
  • The applied color is automatically tinted by 10% and used as the row background color to ensure visibility of deleted content within the row.

Defaults to ‘byAuthor’

insertRevisionColor string

Gets or sets the color value used for insert revisions for visual identification within the Document Editor.
The default value is ‘byAuthor’.
This property accepts either ‘byAuthor’ or a hexadecimal color value string (for example, ‘#0e76b1’).
If the value is ‘byAuthor’, insert revisions (Insertion/MoveTo) are highlighted using the author-specific color.
Otherwise, insert revisions are highlighted using the color value specified for this property.

  • Application-level only; not maintained in the DOCX file.

Defaults to ‘byAuthor’

insertedRowColor string

Gets or sets the background color used for inserted table-row for visual identification within the Document Editor.
The default value is ‘byAuthor’.
This property accepts either ‘byAuthor’ or a hexadecimal color value string (for example, ‘#0e76b1’).
If the value is ‘byAuthor’, inserted row revisions (Insertion/MoveTo) use the author-specific color.
Otherwise, inserted row revisions use the color value specified for this property.

  • Application-level only; not maintained in the DOCX file.
  • The applied color is automatically tinted by 10% and used as the row background color to ensure visibility of inserted content within the row.

Defaults to ‘byAuthor’

revisionColors string[]

Gets or sets the array of colors used to render tracked revisions (insertions and deletions) in the document editor.
Each author who makes a revision is assigned a color from this array in a round-robin fashion.
The first author receives the color at index 0, the second author receives the color at index 1, and so on.
When the number of authors exceeds the array length, the assignment wraps around to the beginning of the array.

Defaults to [‘#b5082e’, ‘#0e76b1’, ‘#bb00ff’, ‘#c14f16’, ‘#128317’, ‘#881824’, ‘#a26400’, ‘#50565e’]

showCustomDataWithAuthor boolean

Gets or sets a boolean value indicating whether to show custom data along with author in the Track Changes pane.

Defaults to false