情報
要求されたトピックは次のとおりです。しかし、このトピックはこのライブラリには含まれていません。

QueryOptions Class

ストレージ フォルダーの内容を列挙するための検索クエリのパラメーターを指定します。

構文


var queryOptions = new Windows.Storage.Search.QueryOptions();
var queryOptions = new Windows.Storage.Search.QueryOptions(query);
var queryOptions = new Windows.Storage.Search.QueryOptions(query, fileTypeFilter);

属性

[MarshalingBehavior(Agile)]
[Version(0x06020000)]

メンバー

QueryOptionsクラス には次の種類のメンバーがあります。

コンストラクター

QueryOptionsクラス にはこれらのコンストラクターがあります。

コンストラクター説明
QueryOptions() Creates an instance of the QueryOptions class for enumerating storage items, and initializes it with the following default settings: QueryOptions.FolderDepth gets FolderDepth.Shallow and QueryOptions.IndexerOption gets IndexerOption.DoNotUseIndexer.
QueryOptions(CommonFileQuery, IIterable(String)) Creates an instance of the QueryOptions class for enumerating files and initializes it with values provided by the specified CommonFileQuery and an optional file type filter that determines which files to include in query results.
QueryOptions(CommonFolderQuery) Creates an instance of the QueryOptions class for enumerating subfolders and initializes it with values based on the specified CommonFolderQuery.

 

メソッド

The QueryOptions クラス には次のメソッドがあります。 With C#、Visual Basic、および C++ では、以下からもメソッドが継承されます。Object クラス.

メソッド説明
LoadFromString Initializes the current instance of the QueryOptions class with search parameters specified by a string that was created by the SaveToString method.
SaveToString Converts the values of a QueryOptions object to a string that can be used to initialize the values of a QueryOptions object by calling LoadFromString.
SetPropertyPrefetch Specifies properties that the system should load in advance for all items in the query result set while the query is being executed (instead of retrieving them on a case-by-case basis).
SetThumbnailPrefetch Specifies the type and size of thumbnails that the system should start loading immediately when items are accessed (instead of retrieving them on a case-by-case basis).
StorageProviderIdFilter Gets the filter for storage provider identifiers.

 

プロパティ

QueryOptionsクラス には次のプロパティがあります。

プロパティアクセスの種類説明

ApplicationSearchFilter

読み取り/書き込みGets or sets an application-defined Advanced Query Syntax (AQS) string for filtering files by keywords or properties. This property is combined with the UserSearchFilter to create the query's search filter.

DateStackOption

読み取り専用Gets the unit of time used to group files into folders if the QueryOptions object was created with a CommonFolderQuery based on date.

FileTypeFilter

読み取り専用Gets a list of file name extensions used to filter the search results. If the list is empty, the results include all file types.

FolderDepth

読み取り/書き込みIndicates whether the search query should produce a shallow view of the folder contents or a deep recursive view of all files and subfolder.

GroupPropertyName

読み取り専用Gets the name of the property used to group query results if the QueryOptions object was created using a CommonFolderQuery.

IndexerOption

読み取り/書き込みGets or sets a value that specifies whether the system index or the file system is used to retrieve query results.

Language

読み取り/書き込みGets or sets the Internet Engineering Task Force (IETF) language tag (BCP47 standard) that identifies the language associated with the query. This determines the language-specific algorithm used by the system to break the query into individual search tokens.

SortOrder

読み取り専用Gets the list of SortEntry structures that specify how to sort content (like files and subfolders) in query results.

UserSearchFilter

読み取り/書き込みGets or sets a user-defined Advanced Query Syntax (AQS) string for filtering files by keywords or properties. This property is combined with the ApplicationSearchFilter to create the query's search filter.

 

解説

アクセス可能で StorageFolder として取得できるフォルダーのファイル クエリを作成できます。

別のアプリケーションのプロパティ ハンドラーに依存するプロパティを取得する、インデックス サポートされたファイルのクエリを作成するため、QueryOptionsCreateFileQueryWithOptions を使用できます。

QueryOptions の使用方法を示すその他のコード例については、「Folder enumeration sample (フォルダー列挙体のサンプル)」と「Programmatic file search sample (プラグラム的なファイル検索のサンプル)」を参照してください。

プロパティへのアクセスに関するその他のコード サンプルについては、ファイル アクセスのサンプルを参照してください。

Windows Phone 8

この API は実装されていません。呼び出された場合は、例外をスローします。「Windows Phone ランタイム API」を参照してください。

この例では、特定の場所でファイルを照会するために QueryOptions を使用する方法を示します。



// Set query options with filter and sort order for results
var fileTypeFilter = [".jpg", ".png", ".bmp", ".gif"];
var queryOptions = new Windows.Storage.Search.QueryOptions(search.CommonFileQuery.orderByName, fileTypeFilter);

// Create query and retrieve files
var query = Windows.Storage.KnownFolders.picturesLibrary.createFileQueryWithOptions(queryOptions);
query.getFilesAsync().done(function (files) {
    // Process results
    files.forEach(function (file) {
        // Process file
    });
});

前の例では、PicturesLibrary の画像ライブラリ機能によって StorageFolder オブジェクトを取得します。ファイルおよびフォルダーのアクセス方法の詳細については、「File access and permissions in Windows Store apps (Windows ストア アプリでのファイルのアクセスと許可)」を参照してください。

この例では、別のアプリケーションのプロパティ ハンドラー (Title ドキュメント プロパティなど) に依存する可能性があるプロパティを取得するためにシステムのインデックスによってサポートされるファイル クエリを使用する方法を示しています。



// Create index backed file query and get results
var documentsLibrary = Windows.Storage.KnownFolders.documentsLibrary;
var fileTypeFilter = [".docx"];
var queryOptions = new Windows.Storage.Search.QueryOptions(Windows.Storage.Search.CommonFileQuery.orderByName, fileTypeFilter);
queryOptions.indexerOption = Windows.Storage.Search.IndexerOption.onlyUseIndexer;
var fileQuery = documentsLibrary.createFileQueryWithOptions(queryOptions);
fileQuery.getFilesAsync().then(function (files) {
    // Process resulting files
    if (files.size === 0) {
        // Perform tasks to handle no files found
    } else {
        // Access properties for each file
        files.forEach(function (file) {
            // Get document properties
            file.properties.getDocumentPropertiesAsync().done(function (documentProperties) {
                // Perform tasks with document properties
                var title = documentProperties.title;
            });
        });
    }
},
// Handle errors with an error function
function (error) {
    // Handle errors encountered while processing files
});

前の例では、DocumentsLibrary のドキュメント ライブラリ機能によって StorageFolder オブジェクトを取得します。ファイルおよびフォルダーのアクセス方法の詳細については、「File access and permissions in Windows Store apps (Windows ストア アプリでのファイルのアクセスと許可)」を参照してください。

この例では、file は、プロパティを取得するファイルを表す StorageFile を格納しています。

要件

最小限サポートされるクライアント

Windows 8 [Windows ストア アプリのみ]

最小限サポートされるサーバー

Windows Server 2012 [Windows ストア アプリのみ]

最小限サポートされる携帯電話

Windows Phone 8 [実装されていません。"解説" を参照してください]

名前空間

Windows.Storage.Search
Windows::Storage::Search [C++]

メタデータ

Windows.winmd

 

 

表示: