# FarPoint.Win.Spread.SearchDialog

## Content

<div class="doc-site-dotnet-api-container">



  <h1 id="FarPoint_Win_Spread_SearchDialog" data-uid="FarPoint.Win.Spread.SearchDialog" class="text-break">SearchDialog Class
</h1>
  <div class="markdown level0 summary"><p>Represents a search dialog.</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"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.marshalbyrefobject">MarshalByRefObject</a></div>
    <div class="level2"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.componentmodel.component">Component</a></div>
    <div class="level3"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.windows.forms.control">Control</a></div>
    <div class="level4"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.windows.forms.scrollablecontrol">ScrollableControl</a></div>
    <div class="level5"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.windows.forms.containercontrol">ContainerControl</a></div>
    <div class="level6"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.windows.forms.form">Form</a></div>
    <div class="level7"><span class="xref">SearchDialog</span></div>
      <div class="level8"><a class="xref" href="FarPoint.Win.Spread.AdvancedSearchDialog.html">AdvancedSearchDialog</a></div>
  </div>
  <div class="implements">
    <h5>Implements</h5>
    <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.windows.forms.idroptarget">IDropTarget</a></div>
    <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.componentmodel.isynchronizeinvoke">ISynchronizeInvoke</a></div>
    <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.windows.forms.iwin32window">IWin32Window</a></div>
    <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.windows.forms.ibindablecomponent">IBindableComponent</a></div>
    <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.componentmodel.icomponent">IComponent</a></div>
    <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.idisposable">IDisposable</a></div>
    <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.windows.forms.icontainercontrol">IContainerControl</a></div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="FarPoint.Win.Spread.html">FarPoint.Win.Spread</a></h6>
  <h6><strong>Assembly</strong>: FarPoint.Win.Spread.dll</h6>
  <h5 id="FarPoint_Win_Spread_SearchDialog_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class SearchDialog : Form, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, IContainerControl</code></pre>
  </div>
  <div class="codewrapper">
    <pre><code class="lang-vbnet hljs">Public Class SearchDialog
    Inherits Form
    Implements IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, IContainerControl</code></pre>
  </div>
  <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_Spread_SearchDialog_AlternateSearch" data-uid="FarPoint.Win.Spread.SearchDialog.AlternateSearch">
          <a class="xref" href="FarPoint.Win.Spread.SearchDialog.AlternateSearch.html#FarPoint_Win_Spread_SearchDialog_AlternateSearch">AlternateSearch</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets whether to search down rows first then across columns,
which is the alternate way of searching.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_Spread_SearchDialog_CaseSensitive" data-uid="FarPoint.Win.Spread.SearchDialog.CaseSensitive">
          <a class="xref" href="FarPoint.Win.Spread.SearchDialog.CaseSensitive.html#FarPoint_Win_Spread_SearchDialog_CaseSensitive">CaseSensitive</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets whether to consider upper case and lower case when performing the search.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_Spread_SearchDialog_ExactMatch" data-uid="FarPoint.Win.Spread.SearchDialog.ExactMatch">
          <a class="xref" href="FarPoint.Win.Spread.SearchDialog.ExactMatch.html#FarPoint_Win_Spread_SearchDialog_ExactMatch">ExactMatch</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets whether to consider only strings that match exactly.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_Spread_SearchDialog_FoundColumnIndex" data-uid="FarPoint.Win.Spread.SearchDialog.FoundColumnIndex">
          <a class="xref" href="FarPoint.Win.Spread.SearchDialog.FoundColumnIndex.html#FarPoint_Win_Spread_SearchDialog_FoundColumnIndex">FoundColumnIndex</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the column index of the matched string.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_Spread_SearchDialog_FoundRowIndex" data-uid="FarPoint.Win.Spread.SearchDialog.FoundRowIndex">
          <a class="xref" href="FarPoint.Win.Spread.SearchDialog.FoundRowIndex.html#FarPoint_Win_Spread_SearchDialog_FoundRowIndex">FoundRowIndex</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the row index of the matched string.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_Spread_SearchDialog_FoundSheetIndex" data-uid="FarPoint.Win.Spread.SearchDialog.FoundSheetIndex">
          <a class="xref" href="FarPoint.Win.Spread.SearchDialog.FoundSheetIndex.html#FarPoint_Win_Spread_SearchDialog_FoundSheetIndex">FoundSheetIndex</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the sheet index of the matched string.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_Spread_SearchDialog_FoundString" data-uid="FarPoint.Win.Spread.SearchDialog.FoundString">
          <a class="xref" href="FarPoint.Win.Spread.SearchDialog.FoundString.html#FarPoint_Win_Spread_SearchDialog_FoundString">FoundString</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the string that matches the one searched for.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_Spread_SearchDialog_RepeatFromStart" data-uid="FarPoint.Win.Spread.SearchDialog.RepeatFromStart">
          <a class="xref" href="FarPoint.Win.Spread.SearchDialog.RepeatFromStart.html#FarPoint_Win_Spread_SearchDialog_RepeatFromStart">RepeatFromStart</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets whether to repeat the search from the start.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_Spread_SearchDialog_SearchString" data-uid="FarPoint.Win.Spread.SearchDialog.SearchString">
          <a class="xref" href="FarPoint.Win.Spread.SearchDialog.SearchString.html#FarPoint_Win_Spread_SearchDialog_SearchString">SearchString</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the string for which to search.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_Spread_SearchDialog_SearchStrings" data-uid="FarPoint.Win.Spread.SearchDialog.SearchStrings">
          <a class="xref" href="FarPoint.Win.Spread.SearchDialog.SearchStrings.html#FarPoint_Win_Spread_SearchDialog_SearchStrings">SearchStrings</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the strings that were searched for in the search dialog.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_Spread_SearchDialog_SheetIndex" data-uid="FarPoint.Win.Spread.SearchDialog.SheetIndex">
          <a class="xref" href="FarPoint.Win.Spread.SearchDialog.SheetIndex.html#FarPoint_Win_Spread_SearchDialog_SheetIndex">SheetIndex</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the index of the sheet to search.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_Spread_SearchDialog_StartColumnIndex" data-uid="FarPoint.Win.Spread.SearchDialog.StartColumnIndex">
          <a class="xref" href="FarPoint.Win.Spread.SearchDialog.StartColumnIndex.html#FarPoint_Win_Spread_SearchDialog_StartColumnIndex">StartColumnIndex</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the column at which to start the search.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_Spread_SearchDialog_StartRowIndex" data-uid="FarPoint.Win.Spread.SearchDialog.StartRowIndex">
          <a class="xref" href="FarPoint.Win.Spread.SearchDialog.StartRowIndex.html#FarPoint_Win_Spread_SearchDialog_StartRowIndex">StartRowIndex</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the row at which to start the search.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_Spread_SearchDialog_UseWildcards" data-uid="FarPoint.Win.Spread.SearchDialog.UseWildcards">
          <a class="xref" href="FarPoint.Win.Spread.SearchDialog.UseWildcards.html#FarPoint_Win_Spread_SearchDialog_UseWildcards">UseWildcards</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets whether to use wildcard characters in the search.</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_Spread_SearchDialog_Dispose_System_Boolean_" data-uid="FarPoint.Win.Spread.SearchDialog.Dispose(System.Boolean)">
          <a class="xref" href="FarPoint.Win.Spread.SearchDialog.Dispose.html#FarPoint_Win_Spread_SearchDialog_Dispose_System_Boolean_">Dispose(bool)</a>
        </td>
        <td class="markdown level1 summary"><p>Cleans up any resources being used.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_Spread_SearchDialog_OnClosing_System_ComponentModel_CancelEventArgs_" data-uid="FarPoint.Win.Spread.SearchDialog.OnClosing(System.ComponentModel.CancelEventArgs)">
          <a class="xref" href="FarPoint.Win.Spread.SearchDialog.OnClosing.html#FarPoint_Win_Spread_SearchDialog_OnClosing_System_ComponentModel_CancelEventArgs_">OnClosing(CancelEventArgs)</a>
        </td>
        <td class="markdown level1 summary"><p>Occurs on closing.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_Spread_SearchDialog_PaintSeparator_System_Windows_Forms_Label_System_Windows_Forms_PaintEventArgs_" data-uid="FarPoint.Win.Spread.SearchDialog.PaintSeparator(System.Windows.Forms.Label,System.Windows.Forms.PaintEventArgs)">
          <a class="xref" href="FarPoint.Win.Spread.SearchDialog.PaintSeparator.html#FarPoint_Win_Spread_SearchDialog_PaintSeparator_System_Windows_Forms_Label_System_Windows_Forms_PaintEventArgs_">PaintSeparator(Label, PaintEventArgs)</a>
        </td>
        <td class="markdown level1 summary"><p>Paints a highlighted line from the end of a label control text to the width of the control to make
the label look more like a separator.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_Spread_SearchDialog_SetCustomText_System_String_System_String_System_String_System_String_System_String_System_String_System_String_System_String_System_String_" data-uid="FarPoint.Win.Spread.SearchDialog.SetCustomText(System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String)">
          <a class="xref" href="FarPoint.Win.Spread.SearchDialog.SetCustomText.html#FarPoint_Win_Spread_SearchDialog_SetCustomText_System_String_System_String_System_String_System_String_System_String_System_String_System_String_System_String_System_String_">SetCustomText(string, string, string, string, string, string, string, string, string)</a>
        </td>
        <td class="markdown level1 summary"><p>Sets the custom text in the form to specified values.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_Spread_SearchDialog_SetCustomText_System_String_System_String_System_String_System_String_System_String_System_String_System_String_System_String_System_String_System_String_" data-uid="FarPoint.Win.Spread.SearchDialog.SetCustomText(System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String)">
          <a class="xref" href="FarPoint.Win.Spread.SearchDialog.SetCustomText.html#FarPoint_Win_Spread_SearchDialog_SetCustomText_System_String_System_String_System_String_System_String_System_String_System_String_System_String_System_String_System_String_System_String_">SetCustomText(string, string, string, string, string, string, string, string, string, string)</a>
        </td>
        <td class="markdown level1 summary"><p>Sets the custom text in the form to specified values.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Win_Spread_SearchDialog_SetCustomTextToDefaults" data-uid="FarPoint.Win.Spread.SearchDialog.SetCustomTextToDefaults">
          <a class="xref" href="FarPoint.Win.Spread.SearchDialog.SetCustomTextToDefaults.html#FarPoint_Win_Spread_SearchDialog_SetCustomTextToDefaults">SetCustomTextToDefaults()</a>
        </td>
        <td class="markdown level1 summary"><p>Sets the custom text in the form to default values.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="events">Events
</h3>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td id="FarPoint_Win_Spread_SearchDialog_StringNotFound" data-uid="FarPoint.Win.Spread.SearchDialog.StringNotFound">
          <a class="xref" href="FarPoint.Win.Spread.SearchDialog.StringNotFound.html">StringNotFound</a>
        </td>
        <td class="markdown level1 summary"><p>Occurs when the search is cancelled with the string not found.</p>
</td>
      </tr>
    </tbody>
  </table>

</div>
