IAssetContentSearchProviderSearch Method (String, String, Int32, Int32, Int32, Boolean, Boolean, Boolean, String, Boolean)
|
Searches for text content in the specified asset.
Namespace:
Ingeniux.CMS.Assets.Search
Assembly:
Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.308
Syntax IEnumerable<IAssetContentSearchResultItem> Search(
string searchText,
string[] ancestorFolderIds,
int totalCount,
int startIndex = 0,
int pageSize = 10,
bool checkedInContentOnly = true,
bool includeRemoved = true,
bool showFrags = false,
string sortField = null,
bool sortDescending = false
)
Function Search (
searchText As String,
ancestorFolderIds As String(),
totalCount As Integer,
Optional startIndex As Integer = 0,
Optional pageSize As Integer = 10,
Optional checkedInContentOnly As Boolean = true,
Optional includeRemoved As Boolean = true,
Optional showFrags As Boolean = false,
Optional sortField As String = Nothing,
Optional sortDescending As Boolean = false
) As IEnumerable(Of IAssetContentSearchResultItem)
IEnumerable<IAssetContentSearchResultItem^>^ Search(
String^ searchText,
array<String^>^ ancestorFolderIds,
int totalCount,
int startIndex = 0,
int pageSize = 10,
bool checkedInContentOnly = true,
bool includeRemoved = true,
bool showFrags = false,
String^ sortField = nullptr,
bool sortDescending = false
)
abstract Search :
searchText : string *
ancestorFolderIds : string[] *
totalCount : int *
?startIndex : int *
?pageSize : int *
?checkedInContentOnly : bool *
?includeRemoved : bool *
?showFrags : bool *
?sortField : string *
?sortDescending : bool
(* Defaults:
let _startIndex = defaultArg startIndex 0
let _pageSize = defaultArg pageSize 10
let _checkedInContentOnly = defaultArg checkedInContentOnly true
let _includeRemoved = defaultArg includeRemoved true
let _showFrags = defaultArg showFrags false
let _sortField = defaultArg sortField null
let _sortDescending = defaultArg sortDescending false
*)
-> IEnumerable<IAssetContentSearchResultItem>
Parameters
- searchText
- Type: SystemString
The search text. - ancestorFolderIds
- Type: SystemString
The ancestor folder ids to limit the range of search results. Only Assets that are descendants
of these folders are returned - totalCount
- Type: SystemInt32
Output of total result items count - startIndex (Optional)
- Type: SystemInt32
Starting index of the result set, default 0 - pageSize (Optional)
- Type: SystemInt32
Page size of the result set, default 10 - checkedInContentOnly (Optional)
- Type: SystemBoolean
Include return search result from checked in content - includeRemoved (Optional)
- Type: SystemBoolean
[Missing <param name="includeRemoved"/> documentation for "M:Ingeniux.CMS.Assets.Search.IAssetContentSearchProvider.Search(System.String,System.String[],System.Int32,System.Int32,System.Int32,System.Boolean,System.Boolean,System.Boolean,System.String,System.Boolean)"]
- showFrags (Optional)
- Type: SystemBoolean
[Missing <param name="showFrags"/> documentation for "M:Ingeniux.CMS.Assets.Search.IAssetContentSearchProvider.Search(System.String,System.String[],System.Int32,System.Int32,System.Int32,System.Boolean,System.Boolean,System.Boolean,System.String,System.Boolean)"]
- sortField (Optional)
- Type: SystemString
The field to sort on, if not or empty, sort descending by sort - sortDescending (Optional)
- Type: SystemBoolean
Whether to sort descending
Return Value
Type:
IEnumerableIAssetContentSearchResultItemThe search result items in the specified range
See Also