Retrieves the collection of all
Component Pages, in a paginated fashion.
Components don't have their own view/template. They are shared among
Pages as reusable content.
Namespace:
Ingeniux.CMS
Assembly:
Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.308
Syntax IEnumerable<IPage> Components(
out int count,
int pageSize = -1,
int startIndex = -1
)
Function Components (
<OutAttribute> ByRef count As Integer,
Optional pageSize As Integer = -1,
Optional startIndex As Integer = -1
) As IEnumerable(Of IPage)
IEnumerable<IPage^>^ Components(
[OutAttribute] int% count,
int pageSize = -1,
int startIndex = -1
)
abstract Components :
count : int byref *
?pageSize : int *
?startIndex : int
(* Defaults:
let _pageSize = defaultArg pageSize -1
let _startIndex = defaultArg startIndex -1
*)
-> IEnumerable<IPage>
Parameters
- count
- Type: SystemInt32
Outputs total count of entries - pageSize (Optional)
- Type: SystemInt32
Number of entries to return. If not provided, returns all entries. - startIndex (Optional)
- Type: SystemInt32
Starting index of entries. If not provided, starts from the first entry.
Return Value
Type:
IEnumerableIPageCollection of
Component PagesRemarks Pages are returned in the order they were created. This doesn't necessarily mean it will always start
with smallest XID, especially for content migrated from Version 8.
See Also