Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

OfficeDiff

OfficeIMO.Diff

Namespace
OfficeIMO.Diff
Assembly
OfficeIMO.Core
Source revision
ba882f6b0d07 with working tree changes
Modifiers
static

Computes edit scripts between sequences: generic items with a comparer, or text split into lines, words or characters.

Inheritance

  • object
  • OfficeDiff

Remarks

Items are interned to integer ids first, so the comparer is called once per item rather than once per comparison. Every result is complete: when a work or time limit stops the alignment, the remaining regions are reported as whole deletions and insertions and OfficeDiffResult<T>.LimitReached is set.

Methods

public static OfficeDiffResult<OfficeTextToken> CompareCharacters(string? oldText, string? newText, OfficeDiffOptions? options = null, CancellationToken cancellationToken = default) #

Compares two texts by user-perceived character (grapheme cluster).

Parameters

oldText string? required
newText string? required
options OfficeIMO.Diff.OfficeDiffOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional
public static OfficeDiffResult<OfficeTextToken> CompareLines(string? oldText, string? newText, OfficeDiffOptions? options = null, CancellationToken cancellationToken = default) #

Compares two texts line by line. Line terminators are part of each line.

Parameters

oldText string? required
newText string? required
options OfficeIMO.Diff.OfficeDiffOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional
public static OfficeDiffResult<OfficeTextToken> CompareTokens(IReadOnlyList<OfficeTextToken> oldTokens, IReadOnlyList<OfficeTextToken> newTokens, OfficeDiffOptions? options = null, CancellationToken cancellationToken = default) #

Compares two token sequences produced by OfficeTextTokenizer or by a caller, honouring the text settings in options.

Parameters

oldTokens System.Collections.Generic.IReadOnlyList<OfficeIMO.Diff.OfficeTextToken> required
newTokens System.Collections.Generic.IReadOnlyList<OfficeIMO.Diff.OfficeTextToken> required
options OfficeIMO.Diff.OfficeDiffOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional
public static OfficeDiffResult<OfficeTextToken> CompareWords(string? oldText, string? newText, OfficeDiffOptions? options = null, CancellationToken cancellationToken = default) #

Compares two texts word by word (see OfficeTextTokenizer.Words).

Parameters

oldText string? required
newText string? required
options OfficeIMO.Diff.OfficeDiffOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional
public static OfficeDiffResult<T?> Compare<T>(IReadOnlyList<T?> oldItems, IReadOnlyList<T?> newItems, IEqualityComparer<T?>? comparer = null, OfficeDiffOptions? options = null, CancellationToken cancellationToken = default) #

Compares two sequences.

Type Parameters

T

Parameters

oldItems System.Collections.Generic.IReadOnlyList<T?> required
Old sequence.
newItems System.Collections.Generic.IReadOnlyList<T?> required
New sequence.
comparer System.Collections.Generic.IEqualityComparer<T?>? = null optional
Item comparer. Defaults to EqualityComparer<T>.Default.
options OfficeIMO.Diff.OfficeDiffOptions? = null optional
Diff settings.
cancellationToken System.Threading.CancellationToken = default optional
Cancels the alignment.