TrackChangesOptions
Represents the options for tracking changes in a document.
Definition
Namespace:Telerik.Windows.Documents.Model.Revisions
Assembly:Telerik.Windows.Controls.RichTextBox.dll
Syntax:
public class TrackChangesOptions
Inheritance: objectTrackChangesOptions
Constructors
public TrackChangesOptions()
Properties
Specifies the options for the changed lines decoration color in the track changes feature.
public ChangedLinesOptions ChangedLinesDecorationColorOptions { get; }
Gets or sets the options for tracking changes related to comments in the document.
public CommentsOptions Comments { get; }
An instance of TrackChangesOptions representing the settings for comment tracking.
CurrentAuthorColor
Color
Gets or sets the color associated with the current author in the track changes feature.
public Color CurrentAuthorColor { get; set; }
A Color value that represents the current author's color.
Represents the options for tracking changes in delete operations within the document model.
public StructureRevisionOptions Delete { get; }
Gets or sets the options for tracking deleted cells in a document.
public TableRevisionOptions DeletedCells { get; }
Represents the options for formatting when tracking changes in documents.
public StructureRevisionOptions Formatting { get; }
Specifies the options for inserting changes in the document's revisions tracking feature.
public StructureRevisionOptions Insert { get; }
Gets or sets the options for tracking changes related to inserted cells in a document.
public TableRevisionOptions InsertedCells { get; }
The options that specify how inserted cells are handled when tracking changes.
Gets or sets a value indicating whether to track formatting changes in revisions.
public bool TrackFormatting { get; set; }
A boolean value that determines if formatting changes are tracked. If true, formatting changes will be included in the revision tracking; otherwise, they will not.
Methods
GetChangedLinesColor()
Color?
Gets the color of the changed lines in the document.
public Color? GetChangedLinesColor()
Color?
A Color representing the color assigned to the changed lines.
Retrieves the color associated with the specified author's changes in a document.
public Color GetColorByAuthor(string authorUserName)
The name of the author whose change color is to be retrieved.
Returns:Color
The color assigned to the author's changes, represented as a string.
Retrieves the color used to indicate deleted tables in the tracked changes of a document.
public Color? GetTableDeleteColor(string authorUserName)
The user name if the author.
Returns:Color?
Returns the color associated with the deletion of the specified table as a string.
Retrieves the color used for inserting tables in the tracked changes feature.
public Color? GetTableInsertColor(string authorUserName)
The user name of the author
Returns:Color?
A string representing the color associated with inserting tables. The color format is typically in hexadecimal representation.
Sets the properties for text that has been marked as deleted in the document.
public void SetDeletedTextProperties(string userName, SpanProperties properties)
The user that makes the change.
propertiesSpanPropertiesThe span properties to apply to the deleted text.
Sets the properties for the inserted text in the track changes feature.
public void SetInsertedTextProperties(string userName, SpanProperties properties)
The user that makes the change
propertiesSpanPropertiesThe properties to be applied to the inserted text.