ICategoryDefinitionSerializeNavigation Method
|
Gets the navigation structure for taxonomy navigation, with given depth
Namespace:
Ingeniux.Runtime.Taxonomy
Assembly:
IGXRuntimeAPI (in IGXRuntimeAPI.dll) Version: 10.3.169
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
)
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: SystemInt32
How deep to list categorie's descedants - includePages
- Type: SystemBoolean
Include pages in the navigation or not - localExports
- Type: Ingeniux.Runtime.NavigationBuilderICMSPageEntryExportDefinition
Local exports to include for navigation nodes - env
- Type: Ingeniux.RuntimeICMSEnvironment
CMS Environment - navBuildSession
- Type: Ingeniux.Runtime.NavigationBuilderICMSNavigationBuildingSession
- isBackground
- Type: SystemBoolean
- filterSchemaNames (Optional)
- Type: System.Collections.GenericIEnumerableString
Page must be using one of
the given schemas to be listed - filterAncestorPageIds (Optional)
- Type: System.Collections.GenericIEnumerableString
Page must be under one
of the ancestor pages to be listed - includeSelf (Optional)
- Type: SystemBoolean
- originEleID (Optional)
- Type: SystemString
- useCheckedOut (Optional)
- Type: SystemBoolean
- builtEntries (Optional)
- Type: System.Collections.GenericDictionaryString, ICMSPageEntry
Return Value
Type:
XElementSee Also