LocalContentSuggestionSettings.PropertiesToMatch Property

  • Reference

Definition

Namespace:
Windows.ApplicationModel.Search
Edit

A list of the file properties whose values are used to provide suggestions from local files. If the list is empty, all of the file properties that are available for suggestions are used.

public:
 property IVector<Platform::String ^> ^ PropertiesToMatch { IVector<Platform::String ^> ^ get(); };
IVector<winrt::hstring> PropertiesToMatch();
public IList<string> PropertiesToMatch { get; }
var iVector = localContentSuggestionSettings.propertiesToMatch;
Public ReadOnly Property PropertiesToMatch As IList(Of String)

Property Value

IVector<String>

IList<String>

IVector<Platform::String>

IVector<winrt::hstring>

The list of the file properties that are used to provide suggestions from local files. By default, this list is empty and all of the file properties that are available for suggestions are used.

Remarks

Important

To implement search in an app for Windows 10 or later, use AutoSuggestBox. See Auto-suggest box for more info.

You should not use Windows.ApplicationModel.Search APIs (SearchPane, SearchContract) or SearchBox APIs in apps for Windows 10 or later.

If local suggestions are disabled, this property has no effect.

Adding properties to this list limits local suggestions to the values of the specified properties for local, indexed files. For example, if you want to limit suggestions to musical artists, you would append the "System.Music.AlbumArtist" (Album artists) or the "System.Music.Artist" (Contributing artists) property to the PropertiesToMatch list.

Adding properties to this list limits local suggestions to local, indexed files that have the listed properties.

Applies to

See also