find()

Finds the first occurrence of a string starting from the current position. The search can be constrained to the series of characters in a text file or to a vertical strip in a PDF file located between leftConstraint and rightConstraint, expressed in characters (or in millimeters for a PDF file). The method returns null if stringToFind cannot be found, otherwise it returns a RectValueText object.

The RectValueText contains the relative Left, Top, Right and Bottom coordinates of the smallest possible rectangle that completely encloses stringToFind.

Note that partial matches are not allowed, i.e. the entire stringToFind must be found between the leftConstraint and rightConstraint parameters. Also, calling this method does not move the current position to the location where stringToFind was found, allowing you to use the method as a look-ahead function without disrupting the rest of the workflow.

Related Objects: Boundaries and Data.

find (stringToFind, leftConstraint, rightConstraint)

Finds the first occurrence of a string starting from the current position.

stringToFind

String to find.

leftConstraint

Number indicating the left limit from which the search is performed.

rightConstraint

Number indicating the right limit from which the search is performed.

Examples

To search the word "text" on a 8 1/2 x 11 page, the syntax is:

data.find("text", 0, 216);

Numbers 0 and 216 are in millimeters and indicate the left and right limits (constraints) within which the search should be. Values (0, 216) in this example represent the entire width of a page. Note that the smaller the area is, the faster the search is. So if you know that the word "text" is within 3 inches from the left edge of the page, provide the following:

data.find("text", 0, 76.2); 76.2mm =  3*25.4 mm

The return value of the function is:

[Left=26,76, Top=149.77, Right=40,700001, Bottom=154.840302]

Which represents the size of the imaginary rectangle that encloses the string in full, in millimeters relative to the upper left corner of the current page. This also means that the data.find () function only works on the current page. If the record contains several pages, you must create a loop that will perform a jump from one page to another by making a find () on each page.

 
  • Last Topic Update: 24/01/2017 09:32
  • Last Published: 7/6/2017 : 9:48 AM