SetFingerprintSearchArea

Specifies the portion of the current page that is used during fingerprint matching.

Syntax

bool SetFingerprintSearchArea(string matchStart, string matchEnd)

Parameters

string matchStart

string matchEnd

Parameters

Two parameters:

A decimal value from 0.01 (1%) to 1.00 (all) to indicate how much of the page is to be matched. If the second parameter is empty the first parameter represents the bottom of the area for matching, starting from the top of the page. If the second parameter is not empty, the first parameter is the top or start of the area for matching. For example, a single parameter of 0.5 indicates that fingerprint matching is limited to the first half of the page (0 - 50%). Decimal separators must be appropriate for the current locale. In applications that might be used in locales with different decimal separators, use percentage notation.
Optional: A decimal value from 0.01 (1%) to 1.0 (all) to indicate the end point on the page to be used for fingerprint matching. If this parameter is supplied, the fist parameter is the starting point. For example: if the first parameter is 0.6, and the second parameter is 1.0, the last 40% of the page is used for fingerprint matching (60-100%).

Smart parameters are supported.

Attention: In both cases, you can replace a decimal value with a percentage. To indicate that the value is a percentage, the action can use a number followed by p, such as 50p to represent 50%.

When you are using the percentage values, the number must be a whole number and must not contain a decimal separator. Decimal separators must be appropriate for the current locale. In applications that are used in locales with different decimal separators, use percentage notation.

Returns

False, if the first parameter is missing or is not numeric. Also returns False, if the second parameter is not numeric. Otherwise, True.

Level

All levels, but generally at the Page level.

Details

This action uses the numeric values that you supply to determine the portion of the current page that is used to find a matching fingerprint.

Example

SetFingerprintSearchArea("0.5","")

This example compares lines and words in the upper 50% of the current page to the lines and words in the same portion of each fingerprint. Notice that the second parameter is empty.

SetFingerprintSearchArea("0.5","1.0")

This example compares lines and words in the lower 50% of the current page to the lines and words in the same portion of each fingerprint. You can replace a parameter's decimal value with a percentage(p) or metric(m) number.