ICategoryDefinitionGetPages Method
|
Gets pages associated with this category, in the form of navigation representatives.
Namespace:
Ingeniux.Runtime.Taxonomy
Assembly:
IGXRuntimeAPI (in IGXRuntimeAPI.dll) Version: 10.6.308
Syntax IEnumerable<ICMSPageEntry> GetPages(
ICMSNavigationBuildingSession navBuildSession,
bool isBackground,
IEnumerable<string> filterSchemaNames = null,
IEnumerable<string> filterAncestorPageIds = null,
bool useCheckedOut = false
)
Function GetPages (
navBuildSession As ICMSNavigationBuildingSession,
isBackground As Boolean,
Optional filterSchemaNames As IEnumerable(Of String) = Nothing,
Optional filterAncestorPageIds As IEnumerable(Of String) = Nothing,
Optional useCheckedOut As Boolean = false
) As IEnumerable(Of ICMSPageEntry)
IEnumerable<ICMSPageEntry^>^ GetPages(
ICMSNavigationBuildingSession^ navBuildSession,
bool isBackground,
IEnumerable<String^>^ filterSchemaNames = nullptr,
IEnumerable<String^>^ filterAncestorPageIds = nullptr,
bool useCheckedOut = false
)
abstract GetPages :
navBuildSession : ICMSNavigationBuildingSession *
isBackground : bool *
?filterSchemaNames : IEnumerable<string> *
?filterAncestorPageIds : IEnumerable<string> *
?useCheckedOut : bool
(* Defaults:
let _filterSchemaNames = defaultArg filterSchemaNames null
let _filterAncestorPageIds = defaultArg filterAncestorPageIds null
let _useCheckedOut = defaultArg useCheckedOut false
*)
-> IEnumerable<ICMSPageEntry>
Parameters
- navBuildSession
- Type: Ingeniux.Runtime.NavigationBuilderICMSNavigationBuildingSession
The navigation session on which build the navigation representative list - isBackground
- Type: SystemBoolean
Whether this is a background task - filterSchemaNames (Optional)
- Type: System.Collections.GenericIEnumerableString
The optional list of schema names to filter the resulting page list by.
If provided, only pages based on one of these schemas will be returned. - filterAncestorPageIds (Optional)
- Type: System.Collections.GenericIEnumerableString
The optional list of ancestor page IDs to filter the resulting page list by.
If provided, only pages under one of these ancestor pages will be returned. - useCheckedOut (Optional)
- Type: SystemBoolean
Whether or not to use checked out pages. False by default.
Return Value
Type:
IEnumerableICMSPageEntryA list of pages in link node format
See Also