ICategoryDefinition.SerializeNavigation Method
|
Gets the structure for taxonomy navigation, with a given depth.
Namespace:
Ingeniux.Runtime.Taxonomy
Assembly:
IGXRuntimeAPI (in IGXRuntimeAPI.dll) Version: 10.6.308
SyntaxXElement SerializeNavigation(
int depth,
bool includePages,
ICMSPageEntryExportDefinition[] localExports,
ICMSEnvironment env,
ICMSNavigationBuildingSession navBuildSession,
bool isBackground,
IEnumerable<string> filterSchemaNames = null,
IEnumerable<string> filterAncestorPageIds = null,
bool includeSelf = true,
string originEleID = "",
bool useCheckedOut = false,
Dictionary<string, ICMSPageEntry> builtEntries = null
)
Function SerializeNavigation (
depth As Integer,
includePages As Boolean,
localExports As ICMSPageEntryExportDefinition(),
env As ICMSEnvironment,
navBuildSession As ICMSNavigationBuildingSession,
isBackground As Boolean,
Optional filterSchemaNames As IEnumerable(Of String) = Nothing,
Optional filterAncestorPageIds As IEnumerable(Of String) = Nothing,
Optional includeSelf As Boolean = true,
Optional originEleID As String = "",
Optional useCheckedOut As Boolean = false,
Optional builtEntries As Dictionary(Of String, ICMSPageEntry) = Nothing
) As XElement
XElement^ SerializeNavigation(
int depth,
bool includePages,
array<ICMSPageEntryExportDefinition^>^ localExports,
ICMSEnvironment^ env,
ICMSNavigationBuildingSession^ navBuildSession,
bool isBackground,
IEnumerable<String^>^ filterSchemaNames = nullptr,
IEnumerable<String^>^ filterAncestorPageIds = nullptr,
bool includeSelf = true,
String^ originEleID = L"",
bool useCheckedOut = false,
Dictionary<String^, ICMSPageEntry^>^ builtEntries = nullptr
)
abstract SerializeNavigation :
depth : int *
includePages : bool *
localExports : ICMSPageEntryExportDefinition[] *
env : ICMSEnvironment *
navBuildSession : ICMSNavigationBuildingSession *
isBackground : bool *
?filterSchemaNames : IEnumerable<string> *
?filterAncestorPageIds : IEnumerable<string> *
?includeSelf : bool *
?originEleID : string *
?useCheckedOut : bool *
?builtEntries : Dictionary<string, ICMSPageEntry>
(* Defaults:
let _filterSchemaNames = defaultArg filterSchemaNames null
let _filterAncestorPageIds = defaultArg filterAncestorPageIds null
let _includeSelf = defaultArg includeSelf true
let _originEleID = defaultArg originEleID ""
let _useCheckedOut = defaultArg useCheckedOut false
let _builtEntries = defaultArg builtEntries null
*)
-> XElement
Parameters
- depth
- Type: System.Int32
How deep to list the category's descendants - includePages
- Type: System.Boolean
Whether to include pages in the navigation or not - localExports
- Type:Ingeniux.Runtime.NavigationBuilder.ICMSPageEntryExportDefinition[]
A list of local exports to include for navigation nodes - env
- Type: Ingeniux.Runtime.ICMSEnvironment
The CMS Environment - navBuildSession
- Type: Ingeniux.Runtime.NavigationBuilder.ICMSNavigationBuildingSession
The navigation session on which to build the navigation structure - isBackground
- Type: System.Boolean
Whether this is a background task - filterSchemaNames (Optional)
- Type: System.Collections.Generic.IEnumerable<String>
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.Generic.IEnumerable<String>
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. - includeSelf (Optional)
- Type: System.Boolean
Whether to include the current page in the navigation structure - originEleID (Optional)
- Type: System.String
ID of the current page - useCheckedOut (Optional)
- Type: System.Boolean
Whether or not ot use checked out pages. False by default. - builtEntries (Optional)
- Type: System.Collections.Generic.Dictionary<String, ICMSPageEntry>
A list of prebuild page entries in link node format to use to build this navigation.
If omitted, a call to GetPages will be made.
Return Value
Type:
XElementAn XML navigation structure
See Also