ITaxonomyGetCategoryPages Method
|
Get all the pages associated with a given
category.
Namespace:
Ingeniux.Runtime.Taxonomy
Assembly:
IGXRuntimeAPI (in IGXRuntimeAPI.dll) Version: 10.6.308
Syntax IEnumerable<ICMSPageEntry> GetCategoryPages(
ICategoryDefinition category,
ICMSNavigationBuildingSession navigationBuildSession,
bool isBackground,
IEnumerable<string> filterSchemaNames = null,
IEnumerable<string> filterAncestorPageIds = null,
bool useCheckedOut = false
)
Function GetCategoryPages (
category As ICategoryDefinition,
navigationBuildSession 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^>^ GetCategoryPages(
ICategoryDefinition^ category,
ICMSNavigationBuildingSession^ navigationBuildSession,
bool isBackground,
IEnumerable<String^>^ filterSchemaNames = nullptr,
IEnumerable<String^>^ filterAncestorPageIds = nullptr,
bool useCheckedOut = false
)
abstract GetCategoryPages :
category : ICategoryDefinition *
navigationBuildSession : 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
- category
- Type: Ingeniux.Runtime.TaxonomyICategoryDefinition
Category to get associated pages for - navigationBuildSession
- Type: Ingeniux.Runtime.NavigationBuilderICMSNavigationBuildingSession
The navigation session to build the page list on - isBackground
- Type: SystemBoolean
Whether this is a background task - filterSchemaNames (Optional)
- Type: System.Collections.GenericIEnumerableString
The optional list of schema names to filter included pages by.
If provided, only pages based on one of these schemas will be included in the resulting navigation structure. - filterAncestorPageIds (Optional)
- Type: System.Collections.GenericIEnumerableString
The optional list of ancestor page IDs to filter included pages by.
If provided, only pages under one of these ancestor pages will be included in the resulting navigation structure. - useCheckedOut (Optional)
- Type: SystemBoolean
Whether to use checked out pages. Default is false.
Return Value
Type:
IEnumerableICMSPageEntryThe collection of navigation representatives assigned to the specified
categoryRemarks See Also