InsertDocumentTreePathInvoke Method (UserControlBase, Boolean, Boolean, String, Boolean, Boolean, String, Int32) Content Studio 5.7 SDK
Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

Invokes the InsertDocumentTreePath component

Namespace: ContentStudio.Site.ActiveScripting.Menu
Assembly: CS_SiteLib (in CS_SiteLib.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax

public static void Invoke(
	UserControlBase userControl,
	bool includeRoot,
	bool includeIfNoChildren,
	string separator,
	bool useRoot,
	bool currentClickable,
	string parentFieldName,
	int parentDocumentId
)

Parameters

userControl
Type: ContentStudio.SiteUserControlBase
A reference to the running user control that invokes this class.
includeRoot
Type: SystemBoolean
A value indicating if the root document should be included in the hierarchy in the output
includeIfNoChildren
Type: SystemBoolean
A value indicating if the top level document should be included if no children documents exist
separator
Type: SystemString
A string containing the characters to act as a separators between different levels (for example " / " to display "parent / child / grandchild")
useRoot
Type: SystemBoolean
A value indicating if the root document should be used as starting point.
currentClickable
Type: SystemBoolean
A value indicating if the current document is clickable or not (clicking on the created link will be the same as reloading the page).
parentFieldName
Type: SystemString
The name of an EPT field that contains the ID of a document to use as the base of the tree. This parameter can be empty or null if not used.

This parameter is available only for presentation templates and should only be used if the current document not is a member of a hierarchy and you want to display another hierarchy instead.

parentDocumentId
Type: SystemInt32
The ID of a document to use as the base of the tree. This parameter is ignored if DefaultParentField is defined. This parameter should be zero to use the current document or its root as base of the tree.

This parameter should only be used if the current document not is a member of a hierarchy and you want to display another hierarchy instead.

See Also

Reference