New to Telerik UI for WinForms? Start a free 30-day trial

Provides visual options and helper methods for rendering tracked text, table, and changed-line revisions.

Definition

Namespace:Telerik.WinForms.Documents.Model.Revisions

Assembly:Telerik.WinControls.RichTextEditor.dll

Syntax:

C#
public class TrackChangesOptions

Inheritance: objectTrackChangesOptions

Constructors

Initializes the default inserted/deleted text, table-cell, and changed-line display options.

C#
public TrackChangesOptions()

Properties

Gets the display options for change indicators along the document's changed lines.

C#
public ChangedLinesOptions ChangedLinesDecorationColorOptions { get; }

Gets the comment-related track-change options; the current in-repository comment rendering code does not consume them.

C#
public CommentsOptions Comments { get; }

Gets or sets the color associated with the current author.

C#
public Color CurrentAuthorColor { get; set; }

Gets the color and decoration options used to render deleted text revisions.

C#
public StructureRevisionOptions Delete { get; }

Gets the highlight options for deleted table cells.

C#
public TableRevisionOptions DeletedCells { get; }

Gets the stored visual options for formatting revisions; the current in-repository revision rendering code does not consume them.

C#
public StructureRevisionOptions Formatting { get; }

Gets the color and decoration options used to render inserted text revisions.

C#
public StructureRevisionOptions Insert { get; }

Gets the highlight options for inserted table cells.

C#
public TableRevisionOptions InsertedCells { get; }

Gets or sets whether formatting changes should be tracked; the current in-repository revision code does not read this value.

C#
public bool TrackFormatting { get; set; }

Methods

Gets the color for changed-line indicators, or null when they are disabled.

C#
public Color? GetChangedLinesColor()
Returns:

Color?

The configured color, black for automatic or by-author modes, or null when disabled.

Gets the palette color assigned to an author, reusing that color for later requests with the same name.

C#
public Color GetColorByAuthor(string authorUserName)
Parameters:authorUserNamestring

The author name used as the color-map key.

Returns:

Color

The color assigned to the author from the revision palette.

Gets the color for a deleted-cell revision, or null when deleted-cell highlighting is disabled.

C#
public Color? GetTableDeleteColor(string authorUserName)
Parameters:authorUserNamestring

The author used when the color mode is by author.

Returns:

Color?

The configured or author-derived color, or null when disabled.

Gets the color for an inserted-cell revision, or null when inserted-cell highlighting is disabled.

C#
public Color? GetTableInsertColor(string authorUserName)
Parameters:authorUserNamestring

The author used when the color mode is by author.

Returns:

Color?

The configured or author-derived color, or null when disabled.

Applies the configured color and decoration for deleted text to the supplied span properties.

C#
public void SetDeletedTextProperties(string userName, SpanProperties properties)
Parameters:userNamestring

The author associated with the deleted text.

propertiesSpanProperties

The span properties to update.

Applies the configured color and decoration for inserted text to the supplied span properties.

C#
public void SetInsertedTextProperties(string userName, SpanProperties properties)
Parameters:userNamestring

The author of the inserted text.

propertiesSpanProperties

The span properties to update.