SearchForVirtualItemEventArgs Class
TOC
Collapse the table of content
Expand the table of content

SearchForVirtualItemEventArgs Class

 

Provides data for the SearchForVirtualItem event.

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

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

public class SearchForVirtualItemEventArgs : EventArgs

NameDescription
System_CAPS_pubmethodSearchForVirtualItemEventArgs(Boolean, Boolean, Boolean, String, Point, SearchDirectionHint, Int32)

Initializes a new instance of the SearchForVirtualItemEventArgs class.

NameDescription
System_CAPS_pubpropertyDirection

Gets the direction from the current item that the search should take place.

System_CAPS_pubpropertyIncludeSubItemsInSearch

Gets a value indicating whether the search should include subitems of list items.

System_CAPS_pubpropertyIndex

Gets or sets the index of the ListViewItem found in the ListView .

System_CAPS_pubpropertyIsPrefixSearch

Gets a value indicating whether the search should return an item if its text starts with the search text.

System_CAPS_pubpropertyIsTextSearch

Gets a value indicating whether the search is a text search.

System_CAPS_pubpropertyStartIndex

Gets the index of the ListViewItem where the search starts.

System_CAPS_pubpropertyStartingPoint

Gets the starting location of the search.

System_CAPS_pubpropertyText

Gets the text used to find an item in the ListView control.

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

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
Available since 2.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft