ISiteContentItemsByKeywords(String, String, String, Int32, Boolean, Boolean, Boolean, Boolean, Boolean, Int32, Int32) Method
|
Retrieves a collection of
Content Items by keywords in the Pages' name,
or specified text/xhtml field, with additional filtering of Root Name and field to search on, in a paginated fashion.
Namespace: Ingeniux.CMSAssembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.492
SyntaxIEnumerable<IContentItem> ContentItemsByKeywords(
string keywords,
string schemaRootName,
string fieldName,
out int count,
bool includePages = true,
bool includeAsset = false,
bool fieldIsAttribute = false,
bool useCheckedoutContent = true,
bool includeRecycledPages = false,
int startIndex = -1,
int pageSize = -1
)
Function ContentItemsByKeywords (
keywords As String,
schemaRootName As String,
fieldName As String,
<OutAttribute> ByRef count As Integer,
Optional includePages As Boolean = true,
Optional includeAsset As Boolean = false,
Optional fieldIsAttribute As Boolean = false,
Optional useCheckedoutContent As Boolean = true,
Optional includeRecycledPages As Boolean = false,
Optional startIndex As Integer = -1,
Optional pageSize As Integer = -1
) As IEnumerable(Of IContentItem)
IEnumerable<IContentItem^>^ ContentItemsByKeywords(
String^ keywords,
String^ schemaRootName,
String^ fieldName,
[OutAttribute] int% count,
bool includePages = true,
bool includeAsset = false,
bool fieldIsAttribute = false,
bool useCheckedoutContent = true,
bool includeRecycledPages = false,
int startIndex = -1,
int pageSize = -1
)
abstract ContentItemsByKeywords :
keywords : string *
schemaRootName : string *
fieldName : string *
count : int byref *
?includePages : bool *
?includeAsset : bool *
?fieldIsAttribute : bool *
?useCheckedoutContent : bool *
?includeRecycledPages : bool *
?startIndex : int *
?pageSize : int
(* Defaults:
let _includePages = defaultArg includePages true
let _includeAsset = defaultArg includeAsset false
let _fieldIsAttribute = defaultArg fieldIsAttribute false
let _useCheckedoutContent = defaultArg useCheckedoutContent true
let _includeRecycledPages = defaultArg includeRecycledPages false
let _startIndex = defaultArg startIndex -1
let _pageSize = defaultArg pageSize -1
*)
-> IEnumerable<IContentItem> Parameters
- keywords String
- The keyword to search for
- schemaRootName String
- The Root Name of the Content Item to filter on. Only Content Items with the specified
Root Name are included.
- fieldName String
- The Name of the field to search on. Use "@Name" to search in Content Item Name
- count Int32
- Count of total entries
- includePages Boolean (Optional)
- Whether to include Pages in search results, default to include
- includeAsset Boolean (Optional)
- Whether to include Asset in search results, default to false
- fieldIsAttribute Boolean (Optional)
- Whether the field searching name is Attribute or not.
- useCheckedoutContent Boolean (Optional)
- Whether to use checked out version of the Content Item for
Content Items that are checked out
- includeRecycledPages Boolean (Optional)
- Whether to include Removed Content Items in the collection.
- startIndex Int32 (Optional)
- Starting index of entries. If not provided, starts from the first entry.
- pageSize Int32 (Optional)
- Number of entries to return. If not provided, returns all entries.
Return Value
IEnumerableIContentItemCollection of
Content Items that contains the searching keyword in its name or any text/xhtml fields.
Remarks
The method call pulls results from a Full-Text index created on the Content Store. Due to the full text nature of the index, you will immediately have the results, but it may not
always 100% up-to-date on the latest changes.
See Also