StringDifferenceOptions.Locality Property
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)
Syntax
'Declaration
<ObsoleteAttribute("This value is no longer used and will be ignored.")> _
Public Property Locality As Integer
[ObsoleteAttribute("This value is no longer used and will be ignored.")]
public int Locality { get; set; }
[ObsoleteAttribute(L"This value is no longer used and will be ignored.")]
public:
property int Locality {
int get ();
void set (int value);
}
[<ObsoleteAttribute("This value is no longer used and will be ignored.")>]
member Locality : int with get, set
function get Locality () : int
function set Locality (value : int)
Property Value
Type: System.Int32
The greatest distance, in number of lines.
Remarks
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.
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.