This topic has not yet been rated - Rate this topic

SearchForVirtualItemEventArgs Class

Provides data for the SearchForVirtualItem event.

System.Object
  System.EventArgs
    System.Windows.Forms.SearchForVirtualItemEventArgs

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)
public class SearchForVirtualItemEventArgs : EventArgs

The SearchForVirtualItemEventArgs type exposes the following members.

  Name Description
Public method SearchForVirtualItemEventArgs Initializes a new instance of the SearchForVirtualItemEventArgs class.
Top
  Name Description
Public property Direction Gets the direction from the current item that the search should take place.
Public property IncludeSubItemsInSearch Gets a value indicating whether the search should include subitems of list items.
Public property Index Gets or sets the index of the ListViewItem found in the ListView .
Public property IsPrefixSearch Gets a value indicating whether the search should return an item if its text starts with the search text.
Public property IsTextSearch Gets a value indicating whether the search is a text search.
Public property StartIndex Gets the index of the ListViewItem where the search starts.
Public property StartingPoint Gets the starting location of the search.
Public property Text Gets the text used to find an item in the ListView control.
Top
  Name Description
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top

The SearchForVirtualItemEventArgs is constructed and passed to the SearchForVirtualItem event when you call the FindItemWithText or FindNearestItem methods on a ListView control in virtual mode.

The following code example demonstrates the use of this type. In the example, an event handler reports on the occurrence of the SearchForVirtualItem event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing Show with Console.WriteLine or appending the message to a multiline TextBox.

To run the example code, paste it into a project that contains an instance of type ListView named ListView1. Then ensure that the event handler is associated with the SearchForVirtualItem event.


private void ListView1_SearchForVirtualItem(Object sender, SearchForVirtualItemEventArgs e) {

System.Text.StringBuilder messageBoxCS = new System.Text.StringBuilder();
messageBoxCS.AppendFormat("{0} = {1}", "IsTextSearch", e.IsTextSearch );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "IncludeSubItemsInSearch", e.IncludeSubItemsInSearch );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "Index", e.Index );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "IsPrefixSearch", e.IsPrefixSearch );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "Text", e.Text );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "StartingPoint", e.StartingPoint );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "Direction", e.Direction );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "StartIndex", e.StartIndex );
messageBoxCS.AppendLine();
MessageBox.Show(messageBoxCS.ToString(), "SearchForVirtualItem Event" );
}


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ