ListBox.FindString Méthode

Définition

Recherche le premier élément dans ListBox qui commence par la chaîne spécifiée.Finds the first item in the ListBox that starts with the specified string.

Surcharges

FindString(String)

Recherche le premier élément dans ListBox qui commence par la chaîne spécifiée.Finds the first item in the ListBox that starts with the specified string.

FindString(String, Int32)

Recherche le premier élément dans ListBox qui commence par la chaîne spécifiée.Finds the first item in the ListBox that starts with the specified string. La recherche commence à un index de départ spécifique.The search starts at a specific starting index.

FindString(String)

Recherche le premier élément dans ListBox qui commence par la chaîne spécifiée.Finds the first item in the ListBox that starts with the specified string.

public:
 int FindString(System::String ^ s);
public int FindString (string s);
member this.FindString : string -> int
Public Function FindString (s As String) As Integer

Paramètres

s
String

Le texte à rechercher.The text to search for.

Retours

Index de base zéro du premier élément trouvé ; retourne ListBox.NoMatches si aucune correspondance n'est trouvée.The zero-based index of the first item found; returns ListBox.NoMatches if no match is found.

Exceptions

La valeur du paramètre s est inférieure à -1 ou supérieure ou égale au nombre d'éléments.The value of the s parameter is less than -1 or greater than or equal to the item count.

Exemples

L’exemple de code suivant montre comment utiliser la méthode FindString pour rechercher la première instance d’une chaîne dans une ListBox.The following code example demonstrates how to use the FindString method to search for the first instance of a string in a ListBox. Si aucun élément correspondant à la chaîne de recherche n’est trouvé FindString retourne une valeur-1 et l’exemple affiche une MessageBox.If no items are found that match the search string FindString returns a -1 value and the example displays a MessageBox. Si un élément correspondant au texte recherché est trouvé, l’exemple utilise la méthode SetSelected pour sélectionner l’élément dans le ListBox.If an item is found that matches the search text, the example uses the SetSelected method to select the item in the ListBox.

private:
   void FindMyString( String^ searchString )
   {
      // Ensure we have a proper string to search for.
      if ( searchString != String::Empty )
      {
         // Find the item in the list and store the index to the item.
         int index = listBox1->FindString( searchString );

         // Determine if a valid index is returned. Select the item if it is valid.
         if ( index != -1 )
                  listBox1->SetSelected( index, true );
         else
                  MessageBox::Show( "The search string did not match any items in the ListBox" );
      }
   }
private void FindMyString(string searchString)
{
   // Ensure we have a proper string to search for.
   if (!string.IsNullOrEmpty(searchString))
   {
      // Find the item in the list and store the index to the item.
      int index = listBox1.FindString(searchString);
      // Determine if a valid index is returned. Select the item if it is valid.
      if (index != -1)
         listBox1.SetSelected(index,true);
      else
         MessageBox.Show("The search string did not match any items in the ListBox");
   }
}
Private Sub FindMyString(ByVal searchString As String)
   ' Ensure we have a proper string to search for.
   If searchString <> String.Empty Then
      ' Find the item in the list and store the index to the item.
      Dim index As Integer = listBox1.FindString(searchString)
      ' Determine if a valid index is returned. Select the item if it is valid.
      If index <> -1 Then
         listBox1.SetSelected(index, True)
      Else
         MessageBox.Show("The search string did not match any items in the ListBox")
      End If
   End If
End Sub

Remarques

La recherche effectuée par cette méthode ne respecte pas la casse.The search performed by this method is not case-sensitive. La recherche recherche les mots qui correspondent partiellement au paramètre de chaîne de recherche spécifié, s.The search looks for words that partially match the specified search string parameter, s. Vous pouvez utiliser cette méthode pour rechercher le premier élément qui correspond à la chaîne spécifiée.You can use this method to search for the first item that matches the specified string. Vous pouvez ensuite effectuer des tâches telles que la suppression de l’élément qui contient le texte recherché à l’aide de la méthode Remove ou la modification du texte de l’élément.You can then perform tasks such as removing the item that contains the search text by using the Remove method or changing the item's text. Une fois que vous avez trouvé le texte spécifié, si vous souhaitez rechercher d’autres instances du texte dans la ListBox, vous pouvez utiliser la version de la méthode FindString qui fournit un paramètre pour spécifier un index de départ dans le ListBox.Once you have found the specified text, if you want to search for other instances of the text in the ListBox, you can use the version of the FindString method that provides a parameter for specifying a starting index within the ListBox. Si vous souhaitez effectuer une recherche pour une correspondance exacte de mot au lieu d’une correspondance partielle, utilisez la méthode FindStringExact.If you want to perform a search for an exact word match instead of a partial match, use the FindStringExact method.

Voir aussi

FindString(String, Int32)

Recherche le premier élément dans ListBox qui commence par la chaîne spécifiée.Finds the first item in the ListBox that starts with the specified string. La recherche commence à un index de départ spécifique.The search starts at a specific starting index.

public:
 int FindString(System::String ^ s, int startIndex);
public int FindString (string s, int startIndex);
member this.FindString : string * int -> int
Public Function FindString (s As String, startIndex As Integer) As Integer

Paramètres

s
String

Le texte à rechercher.The text to search for.

startIndex
Int32

Index de base zéro de l'élément précédant le premier élément sur lequel la recherche est effectuée.The zero-based index of the item before the first item to be searched. Affectez la valeur -1 pour rechercher à partir du début du contrôle.Set to negative one (-1) to search from the beginning of the control.

Retours

Index de base zéro du premier élément trouvé ; retourne ListBox.NoMatches si aucune correspondance n'est trouvée.The zero-based index of the first item found; returns ListBox.NoMatches if no match is found.

Exceptions

Le paramètre startIndex est inférieur à zéro ou supérieur ou égal à la valeur de la propriété Count de la classe ListBox.ObjectCollection.The startIndex parameter is less than zero or greater than or equal to the value of the Count property of the ListBox.ObjectCollection class.

Exemples

L’exemple de code suivant montre comment utiliser la méthode FindString pour rechercher toutes les instances du texte recherché dans les éléments du ListBox.The following code example demonstrates how to use the FindString method to search for all instances of the search text in the items of the ListBox. L’exemple utilise la version de la méthode FindString qui vous permet de spécifier un index de recherche de début à partir duquel effectuer une recherche continue de tous les éléments du ListBox.The example uses the version of the FindString method that enables you to specify a starting search index from which to do a continual search of all items in the ListBox. L’exemple montre également comment déterminer quand la méthode FindString commence la recherche à partir du haut de la liste après avoir atteint le bas de la liste d’éléments pour empêcher une recherche récursive.The example also demonstrates how to determine when the FindString method begins searching from the top of the list after it reaches the bottom of the list of items to prevent a recursive search. Une fois les éléments trouvés dans le ListBox, ils sont sélectionnés à l’aide de la méthode SetSelected.Once items are found in the ListBox, they are selected using the SetSelected method.

private:
   void FindAllOfMyString( String^ searchString )
   {
      // Set the SelectionMode property of the ListBox to select multiple items.
      listBox1->SelectionMode = SelectionMode::MultiExtended;

      // Set our intial index variable to -1.
      int x = -1;

      // If the search string is empty exit.
      if ( searchString->Length != 0 )
      {
         // Loop through and find each item that matches the search string.
         do
         {
            // Retrieve the item based on the previous index found. Starts with -1 which searches start.
            x = listBox1->FindString( searchString, x );

            // If no item is found that matches exit.
            if ( x != -1 )
            {
               // Since the FindString loops infinitely, determine if we found first item again and exit.
               if ( listBox1->SelectedIndices->Count > 0 )
               {
                  if ( x == listBox1->SelectedIndices[ 0 ] )
                                    return;
               }

               // Select the item in the ListBox once it is found.
               listBox1->SetSelected( x, true );
            }
         }
         while ( x != -1 );
      }
   }
private void FindAllOfMyString(string searchString)
{
   // Set the SelectionMode property of the ListBox to select multiple items.
   listBox1.SelectionMode = SelectionMode.MultiExtended;
   
   // Set our intial index variable to -1.
   int x =-1;
   // If the search string is empty exit.
   if (searchString.Length != 0)
   {
      // Loop through and find each item that matches the search string.
      do
      {
         // Retrieve the item based on the previous index found. Starts with -1 which searches start.
         x = listBox1.FindString(searchString, x);
         // If no item is found that matches exit.
         if (x != -1)
         {
            // Since the FindString loops infinitely, determine if we found first item again and exit.
            if (listBox1.SelectedIndices.Count > 0)
            {
               if(x == listBox1.SelectedIndices[0])
                  return;
            }
            // Select the item in the ListBox once it is found.
            listBox1.SetSelected(x,true);
         }
      }while(x != -1);
   }
}
Private Sub FindAllOfMyString(ByVal searchString As String)
   ' Set the SelectionMode property of the ListBox to select multiple items.
   listBox1.SelectionMode = SelectionMode.MultiExtended

   ' Set our intial index variable to -1.
   Dim x As Integer = -1
   ' If the search string is empty exit.
   If searchString.Length <> 0 Then
      ' Loop through and find each item that matches the search string.
      Do
         ' Retrieve the item based on the previous index found. Starts with -1 which searches start.
         x = listBox1.FindString(searchString, x)
         ' If no item is found that matches exit.
         If x <> -1 Then
            ' Since the FindString loops infinitely, determine if we found first item again and exit.
            If ListBox1.SelectedIndices.Count > 0 Then
               If x = ListBox1.SelectedIndices(0) Then
                  Return
               End If
            End If
            ' Select the item in the ListBox once it is found.
            ListBox1.SetSelected(x, True)
         End If
      Loop While x <> -1
   End If
End Sub

Remarques

La recherche effectuée par cette méthode ne respecte pas la casse.The search performed by this method is not case-sensitive. La recherche recherche les mots qui correspondent partiellement au paramètre de chaîne de recherche spécifié, s.The search looks for words that partially match the specified search string parameter, s. Vous pouvez utiliser cette méthode pour rechercher le premier élément qui correspond à la chaîne spécifiée à l’index de départ spécifié dans la liste des éléments de la ListBox.You can use this method to search for the first item that matches the specified string at the specified starting index within the list of items for the ListBox. Vous pouvez ensuite effectuer des tâches telles que la suppression de l’élément qui contient le texte recherché à l’aide de la méthode Remove ou la modification du texte de l’élément.You can then perform tasks such as removing the item that contains the search text by using the Remove method or changing the item's text. Cette méthode est généralement utilisée après qu’un appel a été effectué à l’aide de la version de cette méthode qui ne spécifie pas d’index de départ.This method is typically used after a call has been made using the version of this method that does not specify a starting index. Une fois qu’un élément initial a été trouvé dans la liste, cette méthode est généralement utilisée pour rechercher d’autres instances du texte recherché en spécifiant la position d’index dans le paramètre startIndex de l’élément après la première instance trouvée du texte recherché.Once an initial item has been found in the list, this method is typically used to find further instances of the search text by specifying the index position in the startIndex parameter of the item after the first found instance of the search text. Si vous souhaitez effectuer une recherche pour une correspondance exacte de mot au lieu d’une correspondance partielle, utilisez la méthode FindStringExact.If you want to perform a search for an exact word match instead of a partial match, use the FindStringExact method.

Notes

Lorsque la recherche atteint le bas de la ListBox, elle continue à effectuer une recherche à partir du haut de la ListBox vers l’élément spécifié par le paramètre startIndex.When the search reaches the bottom of the ListBox, it continues searching from the top of the ListBox back to the item specified by the startIndex parameter.

Voir aussi

S’applique à