StringDifferenceOptions.Locality Property

Definition

Namespace:

Microsoft.VisualStudio.Text.Differencing

Assembly:

Microsoft.VisualStudio.Text.Data.dll

Package:

Microsoft.VisualStudio.Text.Data v17.9.187

Caution

This value is no longer used and will be ignored.

The greatest distance a differencing element (line, span, or character) can move and still be considered part of the same source. A value of 0 disables locality checking.

public:
 property int Locality { int get(); void set(int value); };

public:
 property int Locality { int get(); void set(int value); };

[System.Obsolete("This value is no longer used and will be ignored.")]
public int Locality { [System.Runtime.CompilerServices.IsReadOnly] get; set; }

[<System.Obsolete("This value is no longer used and will be ignored.")>]
[<get: System.Runtime.CompilerServices.IsReadOnly>]
member this.Locality : int with get, set

Public Property Locality As Integer

Property Value

Int32

The greatest distance, in number of lines.

Attributes

ObsoleteAttribute IsReadOnlyAttribute

Remarks

The use of locality in the default differencing implementation is now deprecated, and the value of this field is ignored (the same as being 0).

For example, if Locality is set to 100, a line is considered the same line if it is separated by 100 or fewer lines from its neighboring lines. If it is separated by more than 100 lines, it is considered a different line.