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

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: 12.0.0

Syntax

public virtual TreeNode SelectSingleNode(
	string siteName,
	string aliasPath,
	string cultureCode,
	bool combineWithDefaultCulture,
	string classNames,
	string where,
	string orderBy,
	int maxRelativeLevel,
	bool selectOnlyPublished,
	string columns = null
)

Parameters

siteName

Type: System.String
Node site name.

aliasPath

Type: System.String
Node alias path.

cultureCode

Type: System.String
Node 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