Click or drag to resize

ISiteContentItemsByKeywords(String, Int32, Boolean, Boolean, Boolean, Boolean, Int32, Int32) Method


Retrieves a collection of Content Items by keywords in the Pages' name, and any text/xhtml field values, in a paginated fashion.

Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.492
Syntax
IEnumerable<IContentItem> ContentItemsByKeywords(
	string keywords,
	out int count,
	bool includePages = true,
	bool includeAsset = false,
	bool useCheckedoutContent = true,
	bool includeRecycledPages = false,
	int startIndex = -1,
	int pageSize = -1
)

Parameters

keywords  String
The keyword to search for
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
useCheckedoutContent  Boolean  (Optional)
Whether to use checked out Version of the Page for Pages that are checked out
includeRecycledPages  Boolean  (Optional)
Whether to include Removed Pages 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

IEnumerableIContentItem
Collection 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