Class TrackChangesOptions

Represents the options for tracking changes in a document.

Inheritance
System.Object
TrackChangesOptions
Namespace: Telerik.Windows.Documents.Model.Revisions
Assembly: Telerik.Windows.Controls.RichTextBox.dll

Syntax

public class TrackChangesOptions : Object

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
ChangedLinesOptions

Comments

Gets or sets the options for tracking changes related to comments in the document.

Declaration
public CommentsOptions Comments { get; }
Property Value
CommentsOptions

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
System.Windows.Media.Color

A System.Windows.Media.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
StructureRevisionOptions

DeletedCells

Gets or sets the options for tracking deleted cells in a document.

Declaration
public TableRevisionOptions DeletedCells { get; }
Property Value
TableRevisionOptions

Formatting

Represents the options for formatting when tracking changes in documents.

Declaration
public StructureRevisionOptions Formatting { get; }
Property Value
StructureRevisionOptions

Insert

Specifies the options for inserting changes in the document's revisions tracking feature.

Declaration
public StructureRevisionOptions Insert { get; }
Property Value
StructureRevisionOptions

InsertedCells

Gets or sets the options for tracking changes related to inserted cells in a document.

Declaration
public TableRevisionOptions InsertedCells { get; }
Property Value
TableRevisionOptions

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
System.Boolean

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 Nullable<Color> GetChangedLinesColor()
Returns
System.Nullable<System.Windows.Media.Color>

A System.Windows.Media.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
System.String authorUserName

The name of the author whose change color is to be retrieved.
Returns
System.Windows.Media.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 Nullable<Color> GetTableDeleteColor(string authorUserName)
Parameters
System.String authorUserName

The user name if the author.
Returns
System.Nullable<System.Windows.Media.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 Nullable<Color> GetTableInsertColor(string authorUserName)
Parameters
System.String authorUserName

The user name of the author
Returns
System.Nullable<System.Windows.Media.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
System.String userName

The user that makes the change.
SpanProperties 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
System.String userName

The user that makes the change
SpanProperties properties

The properties to be applied to the inserted text.

Extension Methods