Interface IApplicationTreeService
Namespace:System.Dynamic.ExpandoObject
Assembly:Umbraco.Core.dll
Syntax
public interface IApplicationTreeService
Methods
DeleteTree(ApplicationTree)
Deletes this instance.
Declaration
void DeleteTree(ApplicationTree tree)
Parameters
Type | Name | Description |
---|---|---|
ApplicationTree | tree |
GetAll()
Gets all applicationTrees registered in umbraco from the umbracoAppTree table..
Declaration
IEnumerable<ApplicationTree> GetAll()
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<ApplicationTree> | Returns a ApplicationTree Array |
GetApplicationTrees(String)
Gets the application tree for the applcation with the specified alias
Declaration
IEnumerable<ApplicationTree> GetApplicationTrees(string applicationAlias)
Parameters
Type | Name | Description |
---|---|---|
System.String | applicationAlias | The application alias. |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<ApplicationTree> | Returns a ApplicationTree Array |
GetApplicationTrees(String, Boolean)
Gets the application tree for the applcation with the specified alias
Declaration
IEnumerable<ApplicationTree> GetApplicationTrees(string applicationAlias, bool onlyInitialized)
Parameters
Type | Name | Description |
---|---|---|
System.String | applicationAlias | The application alias. |
System.Boolean | onlyInitialized |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<ApplicationTree> | Returns a ApplicationTree Array |
GetByAlias(String)
Gets an ApplicationTree by it's tree alias.
Declaration
ApplicationTree GetByAlias(string treeAlias)
Parameters
Type | Name | Description |
---|---|---|
System.String | treeAlias | The tree alias. |
Returns
Type | Description |
---|---|
ApplicationTree | An ApplicationTree instance |
Intitialize(IEnumerable<ApplicationTree>)
Initializes the service with any trees found in plugins
Declaration
void Intitialize(IEnumerable<ApplicationTree> allAvailableTrees)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<ApplicationTree> | allAvailableTrees | A collection of all available tree found in assemblies in the application |
Remarks
This will update the trees.config with the found tree plugins that are not currently listed in the file when the first access is made to resolve the tree collection
MakeNew(Boolean, Byte, String, String, String, String, String, String)
Creates a new application tree.
Declaration
void MakeNew(bool initialize, byte sortOrder, string applicationAlias, string alias, string title, string iconClosed, string iconOpened, string type)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | initialize | if set to |
System.Byte | sortOrder | The sort order. |
System.String | applicationAlias | The application alias. |
System.String | alias | The alias. |
System.String | title | The title. |
System.String | iconClosed | The icon closed. |
System.String | iconOpened | The icon opened. |
System.String | type | The type. |
SaveTree(ApplicationTree)
Saves this instance.
Declaration
void SaveTree(ApplicationTree tree)
Parameters
Type | Name | Description |
---|---|---|
ApplicationTree | tree |