TreeProvider.SelectSingleNode Method (String, String, String, Boolean, String, String, String, Int32, Boolean, String)

TreeProvider SelectSingleNode Method (String, String, String, Boolean, String, String, String, Int32, Boolean, String)

Kentico 8.0 API Reference

Returns single node specified by alias path, culture and site name matching the provided parameters. Result contains coupled data only if classNames are specified.

Namespace: CMS.DocumentEngine
Assembly: CMS.DocumentEngine (in CMS.DocumentEngine.dll) Version: 8.0.0.0 (8.0.5239.26125)

Parameters

siteName: Type: System String
Nodes site name

aliasPath: Type: System String
Node alias path - may contain % and _ as wild card characters for any number of unknown characters or one unknown character respectively (for MS SQL).

cultureCode: Type: System String
Nodes culture code

combineWithDefaultCulture: Type: System Boolean
Indicates whether node in default culture should be returned if node in specified culture was not found.

classNames: Type: System String
List of class names separated by semicolon (e.g.: "cms.article;cms.product")

where: Type: System String
Where condition to use for the data selection

orderBy: Type: System String
Order by clause to use for the data selection

maxRelativeLevel: Type: System Int32
Maximum child level of the selected nodes

selectOnlyPublished: Type: System Boolean
Select only published nodes.

columns (Optional): Type: System String
Columns to be selected. Columns definition must contain mandatory columns (NodeID, NodeLinkedNodeID, DocumentCulture)

Return Value

Type: TreeNode