Functions that limit the search area

Reference for functions that specify fuzzy rectangles and limit search areas in the Search Conditions section.

The functions listed in the table below can only be used in the Search Conditions section. Each function specifies a fuzzy rectangle for the search area or adds rectangles to an array of excluded rectangles.

Function	Description
Void LeftOf( XInterval x, Distance offset = 0 )	Limits the search area to a rectangle which is the result of intersecting the rectangle of the page with the vertical half-plane located to the left of the point x.End - offset.
Void LeftOf( FuzzyRect fuzzyRect, Distance offset = 0 )	Limits the search area by the vertical half-plane to the left of the point fuzzyRect.Left.End – offset.
Void LeftOf( Hypothesis hyp, Distance offset = 0 )	Limits the search area to a rectangle which is the result of intersecting the rectangle of the page with the vertical half-plane located to the left of the point hyp.Left.End - offset.
Void LeftOf( HypothesisInstances hyps, Distance offset = 0 )	Limits the search area by the vertical half-plane to the left of the point hyp.Left.End – offset. Global coordinates are used.
Void RightOf( XInterval x, Distance offset = 0 )	Limits the search area to a rectangle which is the result of intersecting the rectangle of the page with the vertical half-plane located to the right of the point x.Start + offset.
Void RightOf( FuzzyRect fuzzyRect, Distance offset = 0 )	Limits the search area by the vertical half-plane to the right of the point hyp.Right.Start + offset. Example: Look for the element to the right of the intersection of fuzzy rectangles Element1 and Element2. FuzzyRect intersection = Element1.FuzzyRect AND Element2.FuzzyRect; RightOf: intersection;
Void RightOf( Hypothesis hyp, Distance offset = 0 )	Limits the search area to a rectangle which is the result of intersecting the rectangle of the page with the vertical half-plane located to the right of the point hyp.Right.Start + offset. Example: Look for the element to the right of the right boundary of the ElementName element with an offset of 100 dots. If the element is not found, the offset will be applied to the LEFT boundary of the search area of the element instead. RightOf: ElementName.Right, 100dt;
Void RightOf( HypothesisInstances hyps, Distance offset = 0 )	Limits the search area by the vertical half-plane to the right of the point hyp.Right.Start + offset. Global coordinates are used.
Void Above( YInterval y, Distance offset = 0 )	Limits the search area to a rectangle which is the result of intersecting the rectangle of the page with the horizontal half-plane located above the point y.End - offset.
Void Above( FuzzyRect fuzzyRect, Distance offset = 0 )	Limits the search area by the horizontal half-plane above the point hyp.Top.End – offset.
Void Above( Hypothesis hyp, Distance offset = 0 )	Limits the search area to a rectangle which is the result of intersecting the rectangle of the page with the horizontal half-plane located above the point hyp.Top.End - offset.
Void Above( HypothesisInstances hyps, Distance offset = 0 )	Limits the search area by the horizontal half-plane above the point hyp.Top.End – offset. Global coordinates are used.
Void Below( YInterval y, Distance offset = 0 )	Limits the search area to a rectangle which is the result of intersecting the rectangle of the page with the horizontal half-plane located below the point y.Start + offset.
Void Below( FuzzyRect fuzzyRect, Distance offset = 0 )	Limits the search area by the horizontal half-plane below the point hyp.Bottom.Start + offset.
Void Below( Hypothesis hyp, Distance offset = 0 )	Limits the search area to a rectangle which is the result of intersecting the rectangle of the page with the horizontal half-plane located below the point hyp.Bottom.Start + offset.
Void Below( HypothesisInstances hyps, Distance offset = 0 )	Limits the search area by the horizontal half-plane below the point hyp.Bottom.Start + offset. Global coordinates are used.
Void Exclude( Hypothesis hyp )	Excludes the region of the hyp hypothesis from the search area. If the hyp hypothesis is not found, excludes the internal rectangle of the search area of the hyp hypothesis. Example: Instruct the program to exclude the ElementName element from the search area. If ElementName is not found, calling this function will not modify the search area. Exclude: ElementName;
Void Exclude( Rect rect )	Excludes the rect rectangle from the search area. Example: Instruct the program to exclude the rectangle of the ElementName element. If ElementName is not found, calling this function will exclude the ElementName search area from the search area for the current element. Exclude: ElementName.Rect;
Void Exclude( RectArray rectArray )	Excludes the rectArray array of rectangles from the search area. Example: Instruct the program to exclude rectangles of elements ElementName1, ElementName2, and ElementName3. If any of these elements are not detected, their search areas will be excluded from the search area of the current element when calling this function. Exclude: RectArray(ElementName1.Rect or ElementName2.Rect or ElementName3.Rect);
Void ExcludeRect( XInterval left, YInterval top, XInterval right, YInterval bottom )	Excludes the fuzzy rectangle described by the ranges left, top, right, and bottom from the search area. Example: Instruct the program to exclude a rectangle of absolute size left = 10 dot, top= 200 dot, right=100 dot, bottom=400 dot from the search area. ExcludeRect: 10dt, 200dt, 100dt, 400dt;
Void ExcludeSet( ImageObjectSet set )	Excludes from the search area the array of rectangles of the set set of objects. Example: Instruct the program to exclude the object array of element ElementName from the search area for the current element. ExcludeSet: ElementName.Set;
Void Exclude( HypothesisInstances )	Excludes from the search area the region of the instances of the hypothesis.
Void RestrictSearchArea( FuzzyRect fuzzyRect )	Limits the search area to the fuzzy rectangle fuzzyRect. Global coordinates are used.
Void RestrictSearchArea( FuzzyRect, IntArray pages )	Limits the search area by the fuzzy rectangle fuzzyRect. Specify the local coordinates and page range pages.
Void RestrictSearchArea( FuzzyRect, SearchAreaPageSetType )	Limits the search area by the fuzzy rectangle fuzzyRect. Specify the local coordinates and page range of the type SearchAreaPageSetType.
Void RestrictSearchArea( RectArray rectArray )	Limits the search area to the array of rectangles rectArray. Global coordinates are used. Example: You can specify that the boundaries of the search area of the current element are defined by the boundaries of the rectangles of the elements ElementName1, ElementName2, and ElementName3. If any of the elements are not detected, when accessing this function, the search area of the current element will be defined by the boundaries of the search areas of the corresponding elements. RestrictSearchArea: RectArray(ElementName1.Rect or ElementName2.Rect or ElementName3.Rect);
Void RestrictSearchArea( RectArray, IntArray pages )	Limits the search area by the array of rectangles rectArray. Specify the local coordinates and page range pages.
Void RestrictSearchArea( RectArray, SearchAreaPageSetType )	Limits the search area by the array of rectangles rectArray. Specify the local coordinates and page range of the type SearchAreaPageSetType.
Void RestrictSearchArea( Region region )	Limits the search area to the region region. Global coordinates are used. Example: You can specify that the search area of the current element is limited by the region of the element ElementName. RestrictSearchArea: ElementName.Region;
Void RestrictSearchArea( Region, IntArray pages )	Limits the search area by the region. Specify the local coordinates and page range pages.
Void RestrictSearchArea( Region, SearchAreaPageSetType )	Limits the search area by the region. Specify the local coordinates and page range of the type SearchAreaPageSetType. Example: You can specify that the element must be searched for in the search area on even pages. RestrictSearchArea: searchArea, EvenPages;
Void RestrictSearchArea( SearchAreaPageRestriction pageRestriction, IntArray pages )	Limits the page range on which to search without limiting the search area on the pages themselves. The pageRestriction parameter acquires the only value: WholePage. Example: You can specify that the element must be searched for on pages 2, 4, 7-9. RestrictSearchArea: WholePage, 2 << 4 << 7 << 8 << 9;
Void RestrictSearchArea( SearchAreaPageRestriction pageRestriction, SearchAreaPageSetType )	Limits the page range on which to search without limiting the search area on the pages themselves. The pageRestriction parameter acquires the only value: WholePage. Example: You can specify that the element must be searched for on the last page. RestrictSearchArea: WholePage, LastPage;

You can use RSA alias instead of full name RestrictSearchArea.

Different constraints for the same page are used jointly, and for different pages independently. (The search is carried out on the pages for which at least one constraint has been specified.)

Auxiliary functions that define the search area

Function	Description
Rect PageRect()	The rectangle of the current page in global coordinates used to specify a search area that depends on the page. The PageRect can only be used to specify a search area. Example: To specify that the element is located in the bottom half of a page (the exact page is not known in advance), write: Below: PageRect.Top + PageRect.Height / 2; In all other cases use the construction Page( N ).Rect to get the rectangle of the page number N or DocumentRect to get the rectangle of the entire document. You can also use the PageNumber function to specify a search area that depends on the page.
Int PageNumber()	The number of the current page. Specifies a search area that depends on the page. Example: Suppose you have a repeating element SearchElements.PageHeader. To search on each page below the instances of this element, write: Below: SearchElements.PageHeader.AllInstances.PageAreaGlobal( PageNumber ).FuzzyRect, 0 * dot;