StringDifferenceOptions::Locality Property

Visual Studio 2015
 
Note: This API is now obsolete.

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

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

C#
C++
F#
VB
Copy 
public:
[ObsoleteAttribute("This value is no longer used and will be ignored.")]
property int Locality {
	int get();
	void set(int value);
}

Property Value

Type: System::Int32

The greatest distance, in number of lines.

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.

This option is used for the highest differencing type only. If the user requests both line and word differencing, then this property will be used only for line differencing, not for word differencing. The default value is int.MaxValue, which means that moves of any distance are allowed.

Return to top
Show: