<doc>
  <legacy_id>2307</legacy_id>
  <name>wholeMatches</name>
  <type>property</type>
  <syntax>
    <example>set the wholeMatches to {true | false}</example>
  </syntax>
  <library></library>
  <objects>
    <local/>
  </objects>
  <synonyms>
  </synonyms>
  <classification>
    <category>Text and Data Processing</category>
  </classification>
  <references>
    <function tag="wordOffset">wordOffset Function</function>
    <property tag="caseSensitive">caseSensitive Property</property>
    <operator tag="is among">is among Operator</operator>
    <function tag="itemOffset">itemOffset Function</function>
    <function tag="lineOffset">lineOffset Function</function>
    <keyword tag="whole">whole Keyword</keyword>
  </references>
  <history>
    <introduced version="1.0">Added.</introduced>
  </history>
  <platforms>
    <mac/>
    <windows/>
    <linux/>
    <ios/>
    <android/>
  </platforms>
  <classes>
    <desktop/>
    <server/>
    <web/>
    <mobile/>
  </classes>
  <security>
  </security>
  <summary>Specifies whether the <function tag="lineOffset">lineOffset</function>, <function tag="wordOffset">wordOffset</function>, and <function tag="itemOffset">itemOffset</function> <glossary tag="function">functions</glossary> search only for entire <keyword tag="lines">lines</keyword>, <keyword tag="words">words</keyword>, or <keyword tag="items">items</keyword>.</summary>
  <examples>
    <example>set the wholeMatches to true</example>
  </examples>
  <description>
    <p>Use the <b>wholeMatches</b> <glossary tag="property">property</glossary> to find <keyword tag="lines">lines</keyword>, <keyword tag="words">words</keyword>, or <keyword tag="items">items</keyword> in a <glossary tag="container">container</glossary> only if what you're searching for matches an entire <keyword tag="line">line</keyword>, <keyword tag="word">word</keyword>, or <keyword tag="item">item</keyword>.</p><p/><p><b>Value:</b></p><p>The <b>wholeMatches</b> is true or false.</p><p/><p>By default, the <b>wholeMatches</b> <glossary tag="property">property</glossary> is set to false.</p><p/><p><b>Comments:</b></p><p>For example, suppose line 6 of a field named "Test" is "additive". The expression</p><p>  lineOffset("add",field "Test")</p><p>evaluates to 6 if the<b> wholeMatches</b> is false, because "add" is part of the <keyword tag="line">line</keyword> "additive". If the<b> wholeMatches</b> is true, this <glossary tag="function call">function call</glossary> <glossary tag="return">returns</glossary> 0 (zero), because "add" does not exactly match the <keyword tag="line">line</keyword> "additive".</p><p/><p>If the <b>wholeMatches</b> <glossary tag="property">property</glossary> is set to true, the expression</p><p>  lineOffset<i>(phrase</i>,<i> container</i>)</p><p>is equivalent to the expression</p><p><i>  phrase</i> is among the lines<i> of container</i></p><p>except that the first evaluates to a line number and the second evaluates to true or false. Similarly, the <function tag="wordOffset">wordOffset</function> and <function tag="itemOffset">itemOffset</function> <glossary tag="function">functions</glossary> operate similarly to the <operator tag="is among">is among</operator> <glossary tag="operator">operator</glossary> if the <b>wholeMatches</b> <glossary tag="property">property</glossary> is true.</p><p/><p>Since the <b>wholeMatches</b> is a <href tag="../dictionary/local_property.xml">local property</href>, its <function tag="value">value</function> is <command tag="reset">reset</command> to false when the current <glossary tag="handler">handler</glossary> finishes <glossary tag="execute">executing</glossary>. It retains its <function tag="value">value</function> only for the current <glossary tag="handler">handler</glossary>, and setting it in one <glossary tag="handler">handler</glossary> does not affect its value in other <glossary tag="handler">handlers</glossary> it <glossary tag="call">calls</glossary>.</p>
  </description>
</doc>