Artikel
11/18/2011

TextSearch Class

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Enables the user to search a list of items in an ItemsControl using keyboard input.

Inheritance Hierarchy

System.Object
System.Windows.DependencyObject
System.Windows.Controls.TextSearch

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

Syntax

'Declaration
Public NotInheritable Class TextSearch _
    Inherits DependencyObject

public sealed class TextSearch : DependencyObject

The TextSearch type exposes the following members.

Properties

	Name	Description
	Dispatcher	Gets the Dispatcher this object is associated with. (Inherited from DependencyObject.)

Top

Attached Properties

	Name	Description
	TextPath	Gets or sets the name of the items' property that identifies each item in a control's collection.

Top

Methods

	Name	Description
	CheckAccess	Determines whether the calling thread has access to this object. (Inherited from DependencyObject.)
	ClearValue	Clears the local value of a dependency property. (Inherited from DependencyObject.)
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	GetAnimationBaseValue	Returns any base value established for a Silverlight dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetTextPath	Returns the name of the property that identifies an item in the specified element's collection.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValue	Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ReadLocalValue	Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
	SetTextPath	Writes the TextPath attached property to the specified element.
	SetValue	Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Fields

	Name	Description
	TextPathProperty	Identifies the TextPath attached property.

Top

Remarks

Use this class to associate strings with ItemsControl items for search purposes. You can specify the property that identifies an item by setting the TextPath attached property. For example, if a ListBox contains a collection of Image objects, you can set the TextPath property to “Name”. Then if you set the Name value for one of the images to "dog", the user could select that image by typing “dog” in the ListBox. When the user types enough of the word to distinguish it from other items in the collection, the dog item is selected and displays in the ListBox.

Note:
The typed text may not display in the ItemsControl unless the list contains strings or the ItemsControl has a data template associated with it that displays the identifying strings.

In addition to using the TextPath property, the system will try to obtain a string for search purposes in the following order:

The DisplayMemberPath property if set and resolvable.
The Text property if the item is a TextBox or TextBlock control.
The Text property if the item is a ContentControl that contains a text control.
The ToString method. If the item is a ContentControl, you can override ToString to provide custom behavior.

The search is always case-insensitive.

Version Information

Silverlight

Supported in: 5

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Thread Safety

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

Bagikan melalui