Click or drag to resize

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
Syntax
XElement 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
)

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: XElement
An XML navigation structure
See Also