SearchForVirtualItemEventArgs.IncludeSubItemsInSearch Property
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets a value indicating whether the search should include subitems of list items.
public:
property bool IncludeSubItemsInSearch { bool get(); };
public bool IncludeSubItemsInSearch { get; }
member this.IncludeSubItemsInSearch : bool
Public ReadOnly Property IncludeSubItemsInSearch As Boolean
true
if subitems should be included in the search; otherwise, false
.
The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the ListView.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 MessageBox.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 ListView.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" );
}
Private Sub ListView1_SearchForVirtualItem(sender as Object, e as SearchForVirtualItemEventArgs) _
Handles ListView1.SearchForVirtualItem
Dim messageBoxVB as New System.Text.StringBuilder()
messageBoxVB.AppendFormat("{0} = {1}", "IsTextSearch", e.IsTextSearch)
messageBoxVB.AppendLine()
messageBoxVB.AppendFormat("{0} = {1}", "IncludeSubItemsInSearch", e.IncludeSubItemsInSearch)
messageBoxVB.AppendLine()
messageBoxVB.AppendFormat("{0} = {1}", "Index", e.Index)
messageBoxVB.AppendLine()
messageBoxVB.AppendFormat("{0} = {1}", "IsPrefixSearch", e.IsPrefixSearch)
messageBoxVB.AppendLine()
messageBoxVB.AppendFormat("{0} = {1}", "Text", e.Text)
messageBoxVB.AppendLine()
messageBoxVB.AppendFormat("{0} = {1}", "StartingPoint", e.StartingPoint)
messageBoxVB.AppendLine()
messageBoxVB.AppendFormat("{0} = {1}", "Direction", e.Direction)
messageBoxVB.AppendLine()
messageBoxVB.AppendFormat("{0} = {1}", "StartIndex", e.StartIndex)
messageBoxVB.AppendLine()
MessageBox.Show(messageBoxVB.ToString(),"SearchForVirtualItem Event")
End Sub
Subitems are typically used when a ListView is in Details view.
Product | Versions |
---|---|
.NET Framework | 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
Windows Desktop | 3.0, 3.1, 5, 6, 7, 8, 9 |
.NET feedback
.NET is an open source project. Select a link to provide feedback: