ISitePagesHistoryByKeywords(String, String, String, Int32, Boolean, Boolean, Int32, Int32) Method
|
Retrieves a collection of
Page Versions 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<IPageVersion> PagesHistoryByKeywords(
string keywords,
string schemaRootName,
string fieldName,
out int count,
bool fieldIsAttribute = false,
bool includeRecycledPages = false,
int startIndex = -1,
int pageSize = -1
)
Function PagesHistoryByKeywords (
keywords As String,
schemaRootName As String,
fieldName As String,
<OutAttribute> ByRef count As Integer,
Optional fieldIsAttribute As Boolean = false,
Optional includeRecycledPages As Boolean = false,
Optional startIndex As Integer = -1,
Optional pageSize As Integer = -1
) As IEnumerable(Of IPageVersion)
IEnumerable<IPageVersion^>^ PagesHistoryByKeywords(
String^ keywords,
String^ schemaRootName,
String^ fieldName,
[OutAttribute] int% count,
bool fieldIsAttribute = false,
bool includeRecycledPages = false,
int startIndex = -1,
int pageSize = -1
)
abstract PagesHistoryByKeywords :
keywords : string *
schemaRootName : string *
fieldName : string *
count : int byref *
?fieldIsAttribute : bool *
?includeRecycledPages : bool *
?startIndex : int *
?pageSize : int
(* Defaults:
let _fieldIsAttribute = defaultArg fieldIsAttribute false
let _includeRecycledPages = defaultArg includeRecycledPages false
let _startIndex = defaultArg startIndex -1
let _pageSize = defaultArg pageSize -1
*)
-> IEnumerable<IPageVersion> Parameters
- keywords String
- The keyword to search for
- schemaRootName String
- The Root Name of the Page to filter on. Only Pages with the specified
Root Name are included.
- fieldName String
- The Name of the field to search on. Use "@Name" to search in Page Name
- count Int32
- Count of total entries
- fieldIsAttribute Boolean (Optional)
- Whether the field searching name is Attribute or not.
- 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
IEnumerableIPageVersionCollection 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