# FarPoint.Win.StringSearch

## Content

<div class="doc-site-dotnet-api-container">



  <h1 id="FarPoint_Win_StringSearch" data-uid="FarPoint.Win.StringSearch" class="text-break">StringSearch Class
</h1>
  <div class="markdown level0 summary"><p>Represents the string search capabilities using regular expressions.</p>
</div>
  <div class="markdown level0 conceptual"></div>
  <div class="inheritance">
    <h5>Inheritance</h5>
    <div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
    <div class="level1"><span class="xref">StringSearch</span></div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="FarPoint.Win.html">FarPoint.Win</a></h6>
  <h6><strong>Assembly</strong>: FarPoint.Win.dll</h6>
  <h5 id="FarPoint_Win_StringSearch_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class StringSearch</code></pre>
  </div>
  <div class="codewrapper">
    <pre><code class="lang-vbnet hljs">Public Class StringSearch</code></pre>
  </div>
  <h3 id="constructors">Constructors
</h3>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td id="FarPoint_Win_StringSearch__ctor" data-uid="FarPoint.Win.StringSearch.#ctor">
          <a class="xref" href="FarPoint.Win.StringSearch.-ctor.html#FarPoint_Win_StringSearch__ctor">StringSearch()</a>
        </td>
        <td class="markdown level1 summary"><p>Creates a new string search.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_StringSearch__ctor_System_String_" data-uid="FarPoint.Win.StringSearch.#ctor(System.String)">
          <a class="xref" href="FarPoint.Win.StringSearch.-ctor.html#FarPoint_Win_StringSearch__ctor_System_String_">StringSearch(string)</a>
        </td>
        <td class="markdown level1 summary"><p>Creates a new string search with the specified search pattern.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="properties">Properties
</h3>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td id="FarPoint_Win_StringSearch_Greedy" data-uid="FarPoint.Win.StringSearch.Greedy">
          <a class="xref" href="FarPoint.Win.StringSearch.Greedy.html#FarPoint_Win_StringSearch_Greedy">Greedy</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets whether the regular expression should do a greedy search. A non-Greedy search
on the string &quot;FarPoint Technologies&quot; with the pattern &quot;F*o&quot; would return &quot;FarPo&quot;.  A Greedy
search of the same string would return &quot;FarPoint Techno&quot;.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_StringSearch_MatchExact" data-uid="FarPoint.Win.StringSearch.MatchExact">
          <a class="xref" href="FarPoint.Win.StringSearch.MatchExact.html#FarPoint_Win_StringSearch_MatchExact">MatchExact</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets whether the match must be exact.  An exact match is a string that is
delimited at the beginning and end by either whitespace or end of line.
Note: This property does not have any affect on the search pattern if the
pattern was set using the RegularExpressionPattern property.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_StringSearch_MatchIndex" data-uid="FarPoint.Win.StringSearch.MatchIndex">
          <a class="xref" href="FarPoint.Win.StringSearch.MatchIndex.html#FarPoint_Win_StringSearch_MatchIndex">MatchIndex</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the index of the first character in the matched substring</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_StringSearch_MatchLength" data-uid="FarPoint.Win.StringSearch.MatchLength">
          <a class="xref" href="FarPoint.Win.StringSearch.MatchLength.html#FarPoint_Win_StringSearch_MatchLength">MatchLength</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the length of the matched substring</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_StringSearch_MatchString" data-uid="FarPoint.Win.StringSearch.MatchString">
          <a class="xref" href="FarPoint.Win.StringSearch.MatchString.html#FarPoint_Win_StringSearch_MatchString">MatchString</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the matched substring</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_StringSearch_RegularExpressionPattern" data-uid="FarPoint.Win.StringSearch.RegularExpressionPattern">
          <a class="xref" href="FarPoint.Win.StringSearch.RegularExpressionPattern.html#FarPoint_Win_StringSearch_RegularExpressionPattern">RegularExpressionPattern</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the regular expression pattern to use for the search.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_StringSearch_SearchPattern" data-uid="FarPoint.Win.StringSearch.SearchPattern">
          <a class="xref" href="FarPoint.Win.StringSearch.SearchPattern.html#FarPoint_Win_StringSearch_SearchPattern">SearchPattern</a>
        </td>
        <td class="markdown level1 summary"><p>Sets the search pattern. Note: This is not a regular expression pattern.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="methods">Methods
</h3>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td id="FarPoint_Win_StringSearch_Find_System_String_System_Int32_" data-uid="FarPoint.Win.StringSearch.Find(System.String,System.Int32)">
          <a class="xref" href="FarPoint.Win.StringSearch.Find.html#FarPoint_Win_StringSearch_Find_System_String_System_Int32_">Find(string, int)</a>
        </td>
        <td class="markdown level1 summary"><p>Searches the value string, starting at a specified index, for a character
sequence that matches the provided pattern.</p>
</td>
      </tr>
    </tbody>
  </table>

</div>
