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 文字列を使用して、1 種類のファイル 、音楽ファイルに制限されています。 最も一般的な AQS フィルターの 2 つでは、例の "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);
}

注釈

ローカル コンテンツの候補が有効になっている場合、ユーザーがクエリ テキストを入力すると、ユーザーのローカル ファイルから検索候補が表示されます。 たとえば、画像アプリケーションでは、検索候補がユーザーの画像ライブラリに格納されている特定の種類の画像ファイルからのみ取得されるように、ローカル コンテンツの候補を構成できます。

ローカル ライブラリを検索するには、アプリ マニフェストで適切な機能を宣言する必要があります。 詳しくは、「アプリ機能の宣言」をご覧ください。

適用対象