Retrieves a collection of Pages 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.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 9.0.565.0 (9.0.565)
Syntax
IEnumerable<IPage> PagesByKeywords( string keywords, string schemaRootName, string fieldName, out int count, bool fieldIsAttribute = false, bool useCheckedoutContent = true, bool includeRecycledPages = false, int startIndex = -1, int pageSize = -1 )
Parameters
- keywords
- Type: SystemString
The keyword to search for - schemaRootName
- Type: SystemString
The Root Name of the Page to filter on. Only Pages with the specified Root Name are included. - fieldName
- Type: SystemString
The Name of the field to search on. Use "@Name" to search in Page Name - count
- Type: SystemInt32
Count of total entries - fieldIsAttribute (Optional)
- Type: SystemBoolean
Whether the field searching name is Attribute or not. - useCheckedoutContent (Optional)
- Type: SystemBoolean
Whether to use checked out Version of the Page for Pages that are checked out - includeRecycledPages (Optional)
- Type: SystemBoolean
Whether to include Removed Pages in the collection. - startIndex (Optional)
- Type: SystemInt32
Starting index of entries. If not provided, starts from the first entry. - pageSize (Optional)
- Type: SystemInt32
Number of entries to return. If not provided, returns all entries.
Return Value
Type: IEnumerableIPageCollection of Pages 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