DetermineLocalityCallback Delegate

Definition

Namespace:

Microsoft.VisualStudio.Text.Differencing

Assembly:

Microsoft.VisualStudio.Text.Data.dll

Package:

Microsoft.VisualStudio.Text.Data v17.12.215

Caution

Methods that use this callback are now deprecated, and instances of this callback will not be used.

A delegate for determining the locality for a given difference type and left/right strings.

public delegate Nullable<int> DetermineLocalityCallback(StringDifferenceTypes differenceType, IList<System::String ^> ^ leftStrings, IList<System::String ^> ^ rightStrings);

[System.Obsolete("Methods that use this callback are now deprecated, and instances of this callback will not be used.")]
public delegate int? DetermineLocalityCallback(StringDifferenceTypes differenceType, IList<string> leftStrings, IList<string> rightStrings);

[<System.Obsolete("Methods that use this callback are now deprecated, and instances of this callback will not be used.")>]
type DetermineLocalityCallback = delegate of StringDifferenceTypes * IList<string> * IList<string> -> Nullable<int>

Public Delegate Function DetermineLocalityCallback(differenceType As StringDifferenceTypes, leftStrings As IList(Of String), rightStrings As IList(Of String)) As Nullable(Of Integer) 

Parameters

differenceType

StringDifferenceTypes

The type of difference to get the locality for. This is guaranteed to be only a single type.

leftStrings

IList<String>

The left text, decomposed into a list of strings.

rightStrings

IList<String>

The right text, decomposed into a list of strings.

Return Value

Nullable<Int32>

The locality, if desired, or null, to fallback to the default locality.

Attributes

ObsoleteAttribute

Remarks

This callback and methods that use it are now deprectated. Neither the default implementation of ITextDifferencingService or extensions that implement that interface are required to use this callback.