クエリ結果にprovider がフォルダーとファイルを表示する方法を指定します。

Possible Values

データ型

string

デフォルト値

"RecursiveAll"

解説

FolderOption プロパティは、Microsoft SharePoint のリストおよびライブラリのクエリ結果にファイルとフォルダーを表示する方法を決定します。利用可能なオプションは以下のとおりです。

• FilesOnly — 指定したリストまたはライブラリからフォルダーを除くファイルのみを返します。
• FilesAndFolders — 指定したリストのファイルとフォルダーの両方を返します。
• RecursiveAll — 指定したリストとすべてのサブフォルダーからすべてのファイルを返します。

このプロパティは、ネストしたフォルダー構造を含むリストやライブラリを使用する際に、クエリ結果のスコープを制御するのに役立ちます。REST スキーマでは、フィルタリングはサーバーサイドで適用され、ドキュメントライブラリにのみ影響します。ドキュメントライブラリ以外のリストには影響しません。

パフォーマンスに関する考慮事項

RecursiveAll などの再帰的なオプションを選択すると、特にフォルダー階層が深いリストでは、クエリの実行時間と結果セットのサイズが増加する場合があります。 FilesOnly または FilesAndFolders を使用すると、結果のスコープを絞り込み、データ取得のオーバーヘッドを低減することでパフォーマンスが向上する場合があります。

フォルダースコープに必要な列

FolderOption の設定を反映するため、ShowHiddenColumns および ShowPredefinedColumns の設定によって通常は非表示になる場合でも、本製品 は特定のドキュメントライブラリの列を常に通常のクエリ可能な列として公開します。この動作は REST スキーマに適用され、Microsoft SharePoint のドキュメントライブラリにのみ影響します。

以下の列が公開されます。

• Path 列 (内部名 FileDirRef) は、本製品 がクエリ結果を正しいフォルダーまたはライブラリのルートにスコープするために使用するため、FolderOption の値にかかわらず常に公開されます。
• Item Type 列 (内部名 FSObjType) は、FolderOption が FilesOnly に設定されている場合にのみ公開されます。このモードでは、ファイル (Item Type = 0) とフォルダーを区別する必要があるためです。

各列がどの名前で表示されるかは、UseDisplayNames プロパティによって決まります。UseDisplayNames が有効な場合 (デフォルト)、表示名の Path および Item Type が使用されます。無効な場合は、内部名の FileDirRef および FSObjType が使用されます。