In This Topic ▼

matchDistance Property

Summary

How far to search for a match.

Syntax

TypeScript

JavaScript

Object.defineProperty(DocumentCompareOptions.prototype, 'matchDistance', 
   get: function(), 
   set: function(value) 
)

matchDistance: number;

Property Value

An integer corresponding to the distance the pattern can be from the expected location. Default value is 1000.

Remarks

A value of 0 indicates an exact location. The higher the value the farther away the pattern can be in order to be considered a match. If the comparer finds a match this many characters away from the expected location, this will add 1.0 to the overall score of the match where 0.0 indicates a perfect match.

Requirements

Target Platforms