SearchSuggestion
SearchSuggestion
SearchSuggestion
SearchSuggestion
Class
Definition
Enables access to the search suggestions that the SearchSuggestionManager provides.
public : sealed class SearchSuggestion : ISearchSuggestionpublic sealed class SearchSuggestion : ISearchSuggestionPublic NotInheritable Class SearchSuggestion Implements ISearchSuggestion// You can use this class in JavaScript.
- Attributes
| Device family |
Windows Desktop Extension SDK (introduced v10.0.10240.0)
|
| API contract |
Windows.ApplicationModel.Search.Core.SearchCoreContract (introduced v1)
|
Properties
DetailText DetailText DetailText DetailText
Gets the value that was passed to the detailText parameter of the AppendResultSuggestion method.
public : PlatForm::String DetailText { get; }public string DetailText { get; }Public ReadOnly Property DetailText As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The detail text, or null if the search suggestion is not a Result.
Image Image Image Image
Gets the value that was passed to the image parameter of the AppendResultSuggestion method.
public : IRandomAccessStreamReference Image { get; }public IRandomAccessStreamReference Image { get; }Public ReadOnly Property Image As IRandomAccessStreamReference// You can use this property in JavaScript.
- Value
- IRandomAccessStreamReference IRandomAccessStreamReference IRandomAccessStreamReference IRandomAccessStreamReference
The image, or null if the search suggestion is not a Result.
ImageAlternateText ImageAlternateText ImageAlternateText ImageAlternateText
Gets the value that was passed to the imageAlternateText parameter of the AppendResultSuggestion method.
public : PlatForm::String ImageAlternateText { get; }public string ImageAlternateText { get; }Public ReadOnly Property ImageAlternateText As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The alternate text for Image, or null if the search suggestion is not a Result.
- See Also
Kind Kind Kind Kind
Gets the type of suggestion.
public : SearchSuggestionKind Kind { get; }public SearchSuggestionKind Kind { get; }Public ReadOnly Property Kind As SearchSuggestionKind// You can use this property in JavaScript.
The type of suggestion.
Remarks
If the suggestion was supplied by the system, it has a SearchSuggestionKind of Query. If the suggestion was supplied by the application, in response to a SuggestionsRequested event, the kind is determined by the method of SearchSuggestionCollection that was used to add the suggestion.
| SearchSuggestionCollection method | SearchSuggestionKind |
|---|---|
| AppendQuerySuggestion | Query |
| AppendQuerySuggestions | Query |
| AppendResultSuggestion | Result |
| AppendSearchSeparator | Separator |
| AppendStorageFile | StorageFile |
- See Also
Tag Tag Tag Tag
Gets the value that was passed to the tag parameter of the AppendResultSuggestion method.
public : PlatForm::String Tag { get; }public string Tag { get; }Public ReadOnly Property Tag As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The tag, or null if the search suggestion is not a Result.
Remarks
The Tag property is an opaque value that the app uses to identify the result suggestions that it has added when the user selects a suggestion in the UI.
Text Text Text Text
Gets the localized text of the suggestion for display in the search suggestions UI.
public : PlatForm::String Text { get; }public string Text { get; }Public ReadOnly Property Text As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The text to display.
Remarks
This property is set for all kinds of suggestions, including Separator.