View Source

Class TreeControllerBase

A base controller reference for non-attributed trees (un-registered).

Inheritance

System.Object

UmbracoApiControllerBase

UmbracoApiController

UmbracoAuthorizedApiController

Namespace: Umbraco.Web.Trees

Assembly: Umbraco.Web.dll

Syntax

public abstract class TreeControllerBase : UmbracoAuthorizedApiController, IDiscoverable

Remarks

Developers should generally inherit from TreeController.

Constructors

TreeControllerBase()

Declaration

protected TreeControllerBase()

TreeControllerBase(IGlobalSettings, IUmbracoContextAccessor, ISqlContext, ServiceContext, AppCaches, IProfilingLogger, IRuntimeState, UmbracoHelper)

Declaration

protected TreeControllerBase(IGlobalSettings globalSettings, IUmbracoContextAccessor umbracoContextAccessor, ISqlContext sqlContext, ServiceContext services, AppCaches appCaches, IProfilingLogger logger, IRuntimeState runtimeState, UmbracoHelper umbracoHelper)

Parameters

Type	Name	Description
IGlobalSettings	globalSettings
IUmbracoContextAccessor	umbracoContextAccessor
ISqlContext	sqlContext
ServiceContext	services
AppCaches	appCaches
IProfilingLogger	logger
IRuntimeState	runtimeState
UmbracoHelper	umbracoHelper

Properties

IsSingleNodeTree

Declaration

public abstract bool IsSingleNodeTree { get; }

Property Value

Type	Description
System.Boolean

RootNodeDisplayName

The name to display on the root node

Declaration

public abstract string RootNodeDisplayName { get; }

Property Value

Type	Description
System.String

SectionAlias

Declaration

public abstract string SectionAlias { get; }

Property Value

Type	Description
System.String

SortOrder

Declaration

public abstract int SortOrder { get; }

Property Value

Type	Description
System.Int32

TreeAlias

Declaration

public abstract string TreeAlias { get; }

Property Value

Type	Description
System.String

TreeGroup

Declaration

public abstract string TreeGroup { get; }

Property Value

Type	Description
System.String

TreeTitle

Declaration

public abstract string TreeTitle { get; }

Property Value

Type	Description
System.String

TreeUse

Declaration

public abstract TreeUse TreeUse { get; }

Property Value

Type	Description
TreeUse

Methods

AddQueryStringsToAdditionalData(TreeNode, FormDataCollection)

The AdditionalData of a node is always populated with the query string data, this method performs this operation and ensures that special values are not inserted or that duplicate keys are not added.

Declaration

protected void AddQueryStringsToAdditionalData(TreeNode node, FormDataCollection queryStrings)

Parameters

Type	Name	Description
TreeNode	node
FormDataCollection	queryStrings

CreateRootNode(FormDataCollection)

Helper method to create a root model for a tree

Declaration

protected virtual TreeNode CreateRootNode(FormDataCollection queryStrings)

Parameters

Type	Name	Description
FormDataCollection	queryStrings

Returns

Type	Description
TreeNode

CreateTreeNode(String, String, FormDataCollection, String)

Helper method to create tree nodes

Declaration

public TreeNode CreateTreeNode(string id, string parentId, FormDataCollection queryStrings, string title)

Parameters

Type	Name	Description
System.String	id
System.String	parentId
FormDataCollection	queryStrings
System.String	title

Returns

Type	Description
TreeNode

CreateTreeNode(String, String, FormDataCollection, String, String)

Helper method to create tree nodes

Declaration

public TreeNode CreateTreeNode(string id, string parentId, FormDataCollection queryStrings, string title, string icon)

Parameters

Type	Name	Description
System.String	id
System.String	parentId
FormDataCollection	queryStrings
System.String	title
System.String	icon

Returns

Type	Description
TreeNode

CreateTreeNode(String, String, FormDataCollection, String, String, Boolean)

Helper method to create tree nodes and automatically generate the json URL

Declaration

public TreeNode CreateTreeNode(string id, string parentId, FormDataCollection queryStrings, string title, string icon, bool hasChildren)

Parameters

Type	Name	Description
System.String	id
System.String	parentId
FormDataCollection	queryStrings
System.String	title
System.String	icon
System.Boolean	hasChildren

Returns

Type	Description
TreeNode

CreateTreeNode(String, String, FormDataCollection, String, String, Boolean, String)

Helper method to create tree nodes and automatically generate the json URL

Declaration

public TreeNode CreateTreeNode(string id, string parentId, FormDataCollection queryStrings, string title, string icon, bool hasChildren, string routePath)

Parameters

Type	Name	Description
System.String	id
System.String	parentId
FormDataCollection	queryStrings
System.String	title
System.String	icon
System.Boolean	hasChildren
System.String	routePath

Returns

Type	Description
TreeNode

CreateTreeNode(String, String, FormDataCollection, String, String, Boolean, String, Udi)

Helper method to create tree nodes and automatically generate the json URL + UDI

Declaration

public TreeNode CreateTreeNode(string id, string parentId, FormDataCollection queryStrings, string title, string icon, bool hasChildren, string routePath, Udi udi)

Parameters

Type	Name	Description
System.String	id
System.String	parentId
FormDataCollection	queryStrings
System.String	title
System.String	icon
System.Boolean	hasChildren
System.String	routePath
Udi	udi

Returns

Type	Description
TreeNode

CreateTreeNode(String, String, FormDataCollection, String, String, String)

Helper method to create tree nodes

Declaration

public TreeNode CreateTreeNode(string id, string parentId, FormDataCollection queryStrings, string title, string icon, string routePath)

Parameters

Type	Name	Description
System.String	id
System.String	parentId
FormDataCollection	queryStrings
System.String	title
System.String	icon
System.String	routePath

Returns

Type	Description
TreeNode

CreateTreeNode(IEntitySlim, Guid, String, FormDataCollection, Boolean)

Helper method to create tree nodes and automatically generate the json URL + UDI

Declaration

public TreeNode CreateTreeNode(IEntitySlim entity, Guid entityObjectType, string parentId, FormDataCollection queryStrings, bool hasChildren)

Parameters

Type	Name	Description
IEntitySlim	entity
System.Guid	entityObjectType
System.String	parentId
FormDataCollection	queryStrings
System.Boolean	hasChildren

Returns

Type	Description
TreeNode

CreateTreeNode(IUmbracoEntity, Guid, String, FormDataCollection, String, Boolean)

Helper method to create tree nodes and automatically generate the json URL + UDI

Declaration

public TreeNode CreateTreeNode(IUmbracoEntity entity, Guid entityObjectType, string parentId, FormDataCollection queryStrings, string icon, bool hasChildren)

Parameters

Type	Name	Description
IUmbracoEntity	entity
System.Guid	entityObjectType
System.String	parentId
FormDataCollection	queryStrings
System.String	icon
System.Boolean	hasChildren

Returns

Type	Description
TreeNode

GetMenu(String, FormDataCollection)

The action called to render the menu for a tree node

Declaration

public MenuItemCollection GetMenu(string id, FormDataCollection queryStrings)

Parameters

Type	Name	Description
System.String	id
FormDataCollection	queryStrings

Returns

Type	Description
MenuItemCollection

GetMenuForNode(String, FormDataCollection)

Returns the menu structure for the node

Declaration

protected abstract MenuItemCollection GetMenuForNode(string id, FormDataCollection queryStrings)

Parameters

Type	Name	Description
System.String	id
FormDataCollection	queryStrings

Returns

Type	Description
MenuItemCollection

GetNodes(String, FormDataCollection)

The action called to render the contents of the tree structure

Declaration

public TreeNodeCollection GetNodes(string id, FormDataCollection queryStrings)

Parameters

Type	Name	Description
System.String	id
FormDataCollection	queryStrings	All of the query string parameters passed from jsTree

Returns

Type	Description
TreeNodeCollection	JSON markup for jsTree

Remarks

We are allowing an arbitrary number of query strings to be passed in so that developers are able to persist custom data from the front-end to the back end to be used in the query for model data.

GetRootNode(FormDataCollection)

Returns the root node for the tree

Declaration

public TreeNode GetRootNode(FormDataCollection queryStrings)

Parameters

Type	Name	Description
FormDataCollection	queryStrings

Returns

Type	Description
TreeNode

GetTreeNodes(String, FormDataCollection)

The method called to render the contents of the tree structure

Declaration

protected abstract TreeNodeCollection GetTreeNodes(string id, FormDataCollection queryStrings)

Parameters

Type	Name	Description
System.String	id
FormDataCollection	queryStrings	All of the query string parameters passed from jsTree

Returns

Type	Description
TreeNodeCollection

Remarks

We are allowing an arbitrary number of query strings to be passed in so that developers are able to persist custom data from the front-end to the back end to be used in the query for model data.

IsDialog(FormDataCollection)

If the request is for a dialog mode tree

Declaration

protected bool IsDialog(FormDataCollection queryStrings)

Parameters

Type	Name	Description
FormDataCollection	queryStrings

Returns

Type	Description
System.Boolean

Events

MenuRendering

An event that allows developers to modify the menu that is being rendered

Declaration

public static event TypedEventHandler<TreeControllerBase, MenuRenderingEventArgs> MenuRendering

Event Type

Type	Description
TypedEventHandler<TreeControllerBase, MenuRenderingEventArgs>

Remarks

Developers can add/remove/replace/insert/update/etc... any of the tree items in the collection.

RootNodeRendering

An event that allows developer to modify the root tree node that is being rendered

Declaration

public static event TypedEventHandler<TreeControllerBase, TreeNodeRenderingEventArgs> RootNodeRendering

Event Type

Type	Description
TypedEventHandler<TreeControllerBase, TreeNodeRenderingEventArgs>

TreeNodesRendering

An event that allows developers to modify the tree node collection that is being rendered

Declaration

public static event TypedEventHandler<TreeControllerBase, TreeNodesRenderingEventArgs> TreeNodesRendering

Event Type

Type	Description
TypedEventHandler<TreeControllerBase, TreeNodesRenderingEventArgs>

Remarks

Developers can add/remove/replace/insert/update/etc... any of the tree items in the collection.