View Source

Class TemplatesTreeController

Inheritance

System.Object

Microsoft.AspNetCore.Mvc.ControllerBase

UmbracoApiControllerBase

UmbracoApiController

UmbracoAuthorizedApiController

TreeControllerBase

TreeController

Namespace: Umbraco.Cms.Web.BackOffice.Trees

Assembly: Umbraco.Web.BackOffice.dll

Syntax

[Authorize(Policy = "TreeAccessTemplates")]
[PluginController("UmbracoTrees")]
public class TemplatesTreeController : TreeController, IUmbracoFeature, ITree, ISearchableTree, IDiscoverable

Constructors

TemplatesTreeController(UmbracoTreeSearcher, IMenuItemCollectionFactory, ILocalizedTextService, UmbracoApiControllerTypeCollection, IFileService, IEventAggregator)

Declaration

public TemplatesTreeController(UmbracoTreeSearcher treeSearcher, IMenuItemCollectionFactory menuItemCollectionFactory, ILocalizedTextService localizedTextService, UmbracoApiControllerTypeCollection umbracoApiControllerTypeCollection, IFileService fileService, IEventAggregator eventAggregator)

Parameters

Type	Name	Description
UmbracoTreeSearcher	treeSearcher
IMenuItemCollectionFactory	menuItemCollectionFactory
ILocalizedTextService	localizedTextService
UmbracoApiControllerTypeCollection	umbracoApiControllerTypeCollection
IFileService	fileService
IEventAggregator	eventAggregator

Methods

CreateRootNode(FormCollection)

Declaration

protected override ActionResult<TreeNode> CreateRootNode(FormCollection queryStrings)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Http.FormCollection	queryStrings

Returns

Type	Description
Microsoft.AspNetCore.Mvc.ActionResult<TreeNode>

GetMenuForNode(String, FormCollection)

Returns the menu structure for the node

Declaration

protected override ActionResult<MenuItemCollection> GetMenuForNode(string id, FormCollection queryStrings)

Parameters

Type	Name	Description
System.String	id
Microsoft.AspNetCore.Http.FormCollection	queryStrings

Returns

Type	Description
Microsoft.AspNetCore.Mvc.ActionResult<MenuItemCollection>

GetTreeNodes(String, FormCollection)

The method called to render the contents of the tree structure

Declaration

protected override ActionResult<TreeNodeCollection> GetTreeNodes(string id, FormCollection queryStrings)

Parameters

Type	Name	Description
System.String	id
Microsoft.AspNetCore.Http.FormCollection	queryStrings	All of the query string parameters passed from jsTree

Returns

Type	Description
Microsoft.AspNetCore.Mvc.ActionResult<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.

SearchAsync(String, Int32, Int64, String)

Declaration

public async Task<EntitySearchResults> SearchAsync(string query, int pageSize, long pageIndex, string searchFrom = null)

Parameters

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

Returns

Type	Description
Task<EntitySearchResults>