ClassTrackChangesOptions
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 TrackChangesOptionsInheritance: objectTrackChangesOptions
Constructors
TrackChangesOptions()
Declaration
public TrackChangesOptions()Properties
ChangedLinesDecorationColorOptions
Specifies the options for the changed lines decoration color in the track changes feature.
Declaration
public ChangedLinesOptions ChangedLinesDecorationColorOptions { get; }Property Value
Comments
Gets or sets the options for tracking changes related to comments in the document.
Declaration
public CommentsOptions Comments { get; }Property Value
An instance of TrackChangesOptions representing the settings for comment tracking.
CurrentAuthorColor
Gets or sets the color associated with the current author in the track changes feature.
Declaration
public Color CurrentAuthorColor { get; set; }Property Value
Color
A Color value that represents the current author's color.
Delete
Represents the options for tracking changes in delete operations within the document model.
Declaration
public StructureRevisionOptions Delete { get; }Property Value
DeletedCells
Gets or sets the options for tracking deleted cells in a document.
Declaration
public TableRevisionOptions DeletedCells { get; }Property Value
Formatting
Represents the options for formatting when tracking changes in documents.
Declaration
public StructureRevisionOptions Formatting { get; }Property Value
Insert
Specifies the options for inserting changes in the document's revisions tracking feature.
Declaration
public StructureRevisionOptions Insert { get; }Property Value
InsertedCells
Gets or sets the options for tracking changes related to inserted cells in a document.
Declaration
public TableRevisionOptions InsertedCells { get; }Property Value
The options that specify how inserted cells are handled when tracking changes.
TrackFormatting
Gets or sets a value indicating whether to track formatting changes in revisions.
Declaration
public bool TrackFormatting { get; set; }Property Value
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()
Gets the color of the changed lines in the document.
Declaration
public Color? GetChangedLinesColor()Returns
Color?
A Color representing the color assigned to the changed lines.
GetColorByAuthor(string)
Retrieves the color associated with the specified author's changes in a document.
Declaration
public Color GetColorByAuthor(string authorUserName)Parameters
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.
GetTableDeleteColor(string)
Retrieves the color used to indicate deleted tables in the tracked changes of a document.
Declaration
public Color? GetTableDeleteColor(string authorUserName)Parameters
authorUserName
The user name if the author.
Returns
Color?
Returns the color associated with the deletion of the specified table as a string.
GetTableInsertColor(string)
Retrieves the color used for inserting tables in the tracked changes feature.
Declaration
public Color? GetTableInsertColor(string authorUserName)Parameters
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.
SetDeletedTextProperties(string, SpanProperties)
Sets the properties for text that has been marked as deleted in the document.
Declaration
public void SetDeletedTextProperties(string userName, SpanProperties properties)Parameters
userName
The user that makes the change.
properties
The span properties to apply to the deleted text.
SetInsertedTextProperties(string, SpanProperties)
Sets the properties for the inserted text in the track changes feature.
Declaration
public void SetInsertedTextProperties(string userName, SpanProperties properties)Parameters
userName
The user that makes the change
properties
The properties to be applied to the inserted text.