# FarPoint.Web.Spread.FpSpread.SearchHeaders

## Content

<div class="doc-site-dotnet-api-container">



<h1 id="FarPoint_Web_Spread_FpSpread_SearchHeaders_" data-uid="FarPoint.Web.Spread.FpSpread.SearchHeaders*">SearchHeaders Method
</h1>
<div class="markdown level0 summary"></div>
<div class="markdown level0 conceptual"></div>



<a id="FarPoint_Web_Spread_FpSpread_SearchHeaders_" data-uid="FarPoint.Web.Spread.FpSpread.SearchHeaders*"></a>
<h4 id="FarPoint_Web_Spread_FpSpread_SearchHeaders_System_Int32_System_String_System_Boolean_System_Int32__System_Int32__" data-uid="FarPoint.Web.Spread.FpSpread.SearchHeaders(System.Int32,System.String,System.Boolean,System.Int32@,System.Int32@)">SearchHeaders(int, string, bool, ref int, ref int)</h4>
<div class="markdown level1 summary"><p>Searches the text in the header cells in the specified sheet<br>
for the specified string with the specified criteria.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="declaration">Declaration</h5>
<div class="codewrapper">
  <pre><code class="lang-csharp hljs">public SearchFoundFlags SearchHeaders(int sheetIndex, string searchString, bool searchRowHeaders, ref int foundRowIndex, ref int foundColumnIndex)</code></pre>
</div>
<div class="codewrapper">
  <pre><code class="lang-vbnet hljs">Public Function SearchHeaders(sheetIndex As Integer, searchString As String, searchRowHeaders As Boolean, ByRef foundRowIndex As Integer, ByRef foundColumnIndex As Integer) As SearchFoundFlags</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-condensed">
  <thead>
    <tr>
      <th>Type</th>
      <th>Name</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></td>
      <td><span class="parametername">sheetIndex</span></td>
      <td><p>Index of sheet on which to search</p>
</td>
    </tr>
    <tr>
      <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
      <td><span class="parametername">searchString</span></td>
      <td><p>String for which to search</p>
</td>
    </tr>
    <tr>
      <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
      <td><span class="parametername">searchRowHeaders</span></td>
      <td><p>Whether to search row headers instead of column headers</p>
</td>
    </tr>
    <tr>
      <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></td>
      <td><span class="parametername">foundRowIndex</span></td>
      <td><p>Index of row at which match is found</p>
</td>
    </tr>
    <tr>
      <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></td>
      <td><span class="parametername">foundColumnIndex</span></td>
      <td><p>Index of column at which match is found</p>
</td>
    </tr>
  </tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-condensed">
  <thead>
    <tr>
      <th>Type</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><a class="xref" href="FarPoint.Web.Spread.SearchFoundFlags.html">SearchFoundFlags</a></td>
      <td></td>
    </tr>
  </tbody>
</table>


<a id="FarPoint_Web_Spread_FpSpread_SearchHeaders_" data-uid="FarPoint.Web.Spread.FpSpread.SearchHeaders*"></a>
<h4 id="FarPoint_Web_Spread_FpSpread_SearchHeaders_System_Int32_System_String_System_Boolean_System_Boolean_System_Boolean_System_Boolean_System_Boolean_System_Boolean_System_Boolean_System_Boolean_System_Int32_System_Int32_System_Int32_System_Int32_System_Int32__System_Int32__" data-uid="FarPoint.Web.Spread.FpSpread.SearchHeaders(System.Int32,System.String,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32@,System.Int32@)">SearchHeaders(int, string, bool, bool, bool, bool, bool, bool, bool, bool, int, int, int, int, ref int, ref int)</h4>
<div class="markdown level1 summary"><p>Searches the text in the specified range of header cells in the specified sheet<br>
for the specified string with the specified criteria.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="declaration">Declaration</h5>
<div class="codewrapper">
  <pre><code class="lang-csharp hljs">public SearchFoundFlags SearchHeaders(int sheetIndex, string searchString, bool searchRowHeaders, bool caseSensitive, bool exactMatch, bool alternateSearch, bool useWildcards, bool includeCellText, bool includeNotes, bool includeTags, int startRowIndex, int startColumnIndex, int endRowIndex, int endColumnIndex, ref int foundRowIndex, ref int foundColumnIndex)</code></pre>
</div>
<div class="codewrapper">
  <pre><code class="lang-vbnet hljs">Public Function SearchHeaders(sheetIndex As Integer, searchString As String, searchRowHeaders As Boolean, caseSensitive As Boolean, exactMatch As Boolean, alternateSearch As Boolean, useWildcards As Boolean, includeCellText As Boolean, includeNotes As Boolean, includeTags As Boolean, startRowIndex As Integer, startColumnIndex As Integer, endRowIndex As Integer, endColumnIndex As Integer, ByRef foundRowIndex As Integer, ByRef foundColumnIndex As Integer) As SearchFoundFlags</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-condensed">
  <thead>
    <tr>
      <th>Type</th>
      <th>Name</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></td>
      <td><span class="parametername">sheetIndex</span></td>
      <td><p>Index of sheet on which to search</p>
</td>
    </tr>
    <tr>
      <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
      <td><span class="parametername">searchString</span></td>
      <td><p>String for which to search</p>
</td>
    </tr>
    <tr>
      <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
      <td><span class="parametername">searchRowHeaders</span></td>
      <td><p>Whether to search row headers instead of column headers</p>
</td>
    </tr>
    <tr>
      <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
      <td><span class="parametername">caseSensitive</span></td>
      <td><p>Whether the search considers the case of the letters in the search string</p>
</td>
    </tr>
    <tr>
      <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
      <td><span class="parametername">exactMatch</span></td>
      <td><p>Whether the search considers only an exact match</p>
</td>
    </tr>
    <tr>
      <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
      <td><span class="parametername">alternateSearch</span></td>
      <td><p>Whether the search goes by alternate coordinates of column, row (instead of row, column)</p>
</td>
    </tr>
    <tr>
      <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
      <td><span class="parametername">useWildcards</span></td>
      <td><p>Whether the search considers wildcard characters (*, ?) in the search string</p>
</td>
    </tr>
    <tr>
      <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
      <td><span class="parametername">includeCellText</span></td>
      <td><p>Whether the search includes the content in the cell</p>
</td>
    </tr>
    <tr>
      <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
      <td><span class="parametername">includeNotes</span></td>
      <td><p>Whether the search includes the content in the cell notes</p>
</td>
    </tr>
    <tr>
      <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
      <td><span class="parametername">includeTags</span></td>
      <td><p>Whether the search includes the content in the cell tags or their string representations</p>
</td>
    </tr>
    <tr>
      <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></td>
      <td><span class="parametername">startRowIndex</span></td>
      <td><p>Index of row at which to start</p>
</td>
    </tr>
    <tr>
      <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></td>
      <td><span class="parametername">startColumnIndex</span></td>
      <td><p>Index of column at which to start</p>
</td>
    </tr>
    <tr>
      <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></td>
      <td><span class="parametername">endRowIndex</span></td>
      <td><p>Index of row at which to end</p>
</td>
    </tr>
    <tr>
      <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></td>
      <td><span class="parametername">endColumnIndex</span></td>
      <td><p>Index of column at which to end</p>
</td>
    </tr>
    <tr>
      <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></td>
      <td><span class="parametername">foundRowIndex</span></td>
      <td><p>Index of row at which match is found</p>
</td>
    </tr>
    <tr>
      <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></td>
      <td><span class="parametername">foundColumnIndex</span></td>
      <td><p>Index of column at which match is found</p>
</td>
    </tr>
  </tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-condensed">
  <thead>
    <tr>
      <th>Type</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><a class="xref" href="FarPoint.Web.Spread.SearchFoundFlags.html">SearchFoundFlags</a></td>
      <td></td>
    </tr>
  </tbody>
</table>
</div>