SearchBox.SetLocalContentSuggestionSettings 方法

定义

命名空间:

Windows.UI.Xaml.Controls

指定基于本地文件的建议是否自动显示在搜索框建议中，并定义 Windows 用于查找和筛选这些建议的条件。

public:
 virtual void SetLocalContentSuggestionSettings(LocalContentSuggestionSettings ^ settings) = SetLocalContentSuggestionSettings;

void SetLocalContentSuggestionSettings(LocalContentSuggestionSettings const& settings);

public void SetLocalContentSuggestionSettings(LocalContentSuggestionSettings settings);

function setLocalContentSuggestionSettings(settings)

Public Sub SetLocalContentSuggestionSettings (settings As LocalContentSuggestionSettings)

参数

settings

LocalContentSuggestionSettings

本地内容建议的新设置。

示例

在这里，建议仅限于使用 AQS 字符串的一种文件（音乐文件）。 两个最常见的 AQS 筛选器基于文件类型限制，例如示例中的“kind：music”;和 基于文件扩展名，如“ext:.mp3”。

public MainPage()
{
    this.InitializeComponent();

    // Let Windows provide suggestions from local files.
    var settings = new Windows.ApplicationModel.Search.LocalContentSuggestionSettings();
    settings.Enabled = true;
    // Access to the music library requires that the Music Library capability
    // be declared in the app manifest .
    settings.Locations.Add(Windows.Storage.KnownFolders.MusicLibrary);
    settings.AqsFilter = "kind:Music";
    MySearchBox.SetLocalContentSuggestionSettings(settings);
}

注解

启用本地内容建议后，Windows 将在用户输入查询文本时提供用户本地文件中的搜索建议。 例如，图片应用程序可以配置本地内容建议，以便搜索建议仅来自存储在用户图片库中的特定类型的图像文件。

若要搜索本地库，必须在应用清单中声明相应的功能。 有关详细信息，请参阅应用功能声明。