View Source

Class TemplatesTreeController

Inheritance

System.Object

UmbracoApiControllerBase

UmbracoApiController

UmbracoAuthorizedApiController

TreeControllerBase

TreeController

Namespace: Umbraco.Web.Trees

Assembly: Umbraco.Web.dll

Syntax

[Tree("settings", "templates", SortOrder = 6, TreeGroup = "templatingGroup")]
[PluginController("UmbracoTrees")]
public class TemplatesTreeController : TreeController, ISearchableTree, IDiscoverable

Constructors

TemplatesTreeController(UmbracoTreeSearcher, IGlobalSettings, IUmbracoContextAccessor, ISqlContext, ServiceContext, AppCaches, IProfilingLogger, IRuntimeState, UmbracoHelper)

Declaration

public TemplatesTreeController(UmbracoTreeSearcher treeSearcher, IGlobalSettings globalSettings, IUmbracoContextAccessor umbracoContextAccessor, ISqlContext sqlContext, ServiceContext services, AppCaches appCaches, IProfilingLogger logger, IRuntimeState runtimeState, UmbracoHelper umbracoHelper)

Parameters

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

Methods

CreateRootNode(FormDataCollection)

Declaration

protected override TreeNode CreateRootNode(FormDataCollection queryStrings)

Parameters

Type	Name	Description
FormDataCollection	queryStrings

Returns

Type	Description
TreeNode

GetMenuForNode(String, FormDataCollection)

Returns the menu structure for the node

Declaration

protected override MenuItemCollection GetMenuForNode(string id, FormDataCollection queryStrings)

Parameters

Type	Name	Description
System.String	id
FormDataCollection	queryStrings

Returns

Type	Description
MenuItemCollection

GetTreeNodes(String, FormDataCollection)

The method called to render the contents of the tree structure

Declaration

protected override 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 pased 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.

Search(String, Int32, Int64, out Int64, String)

Declaration

public IEnumerable<SearchResultEntity> Search(string query, int pageSize, long pageIndex, out long totalFound, string searchFrom = null)

Parameters

Type	Name	Description
System.String	query
System.Int32	pageSize
System.Int64	pageIndex
System.Int64	totalFound
System.String	searchFrom

Returns

Type	Description
System.Collections.Generic.IEnumerable<SearchResultEntity>