Share via


IHierarchicalDifferenceCollection Interface

Represents a difference collection in which the left and right sequences are ITokenizedStringList objects, and each difference may itself contain an IHierarchicalDifferenceCollection.

Namespace:  Microsoft.VisualStudio.Text.Differencing
Assembly:  Microsoft.VisualStudio.Text.Data (in Microsoft.VisualStudio.Text.Data.dll)

Syntax

'Declaration
Public Interface IHierarchicalDifferenceCollection _
    Inherits IDifferenceCollection(Of String), IEnumerable(Of Difference),  _
    IEnumerable
public interface IHierarchicalDifferenceCollection : IDifferenceCollection<string>, 
    IEnumerable<Difference>, IEnumerable
public interface class IHierarchicalDifferenceCollection : IDifferenceCollection<String^>, 
    IEnumerable<Difference^>, IEnumerable
type IHierarchicalDifferenceCollection =  
    interface 
        interface IDifferenceCollection<string>
        interface IEnumerable<Difference>
        interface IEnumerable 
    end
public interface IHierarchicalDifferenceCollection extends IDifferenceCollection<String>, IEnumerable<Difference>, IEnumerable

The IHierarchicalDifferenceCollection type exposes the following members.

Properties

  Name Description
Public property Differences Returns the difference collection as a list. (Inherited from IDifferenceCollection<T>.)
Public property LeftDecomposition Gets the original left tokenized list.
Public property LeftSequence Gets the left sequence that was used to create this difference collection. (Inherited from IDifferenceCollection<T>.)
Public property MatchSequence Gets the original match sequence that was used to create this difference collection. (Inherited from IDifferenceCollection<T>.)
Public property RightDecomposition Get the original right tokenized list.
Public property RightSequence Gets the right sequence that was used to create this difference collection. (Inherited from IDifferenceCollection<T>.)

Top

Methods

  Name Description
Public method GetContainedDifferences Gets the contained difference collection for the given element, if it has any.
Public method GetEnumerator Returns an enumerator that iterates through the collection. (Inherited from IEnumerable<Difference>.)
Public method HasContainedDifferences Determines whether the Difference at the given index itself contains differences.

Top

Remarks

You can get this collection by using the IHierarchicalStringDifferenceService.

hen you request multiple types of string differencing (e.g. line and word), the first level of differences will be the lines, and each line difference may contain an IHierarchicalDifferenceCollection of word differences. See IHierarchicalStringDifferenceService for more information and examples.

See Also

Reference

Microsoft.VisualStudio.Text.Differencing Namespace