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

Returns nodes specified by node alias path, culture and site name, optionally combined with default culture. Result contains coupled data only if classNames are specified.

Namespace: CMS.DocumentEngine
Assembly: CMS.DocumentEngine (in CMS.DocumentEngine.dll) Version: 9.0.0

Syntax

public virtual InfoDataSet<TreeNode> SelectNodes(
	string siteName,
	string aliasPath,
	string cultureCode,
	bool combineWithDefaultCulture,
	string classNames = null,
	string where = null,
	string orderBy = null,
	int maxRelativeLevel = -1,
	bool selectOnlyPublished = true,
	int topN = 0,
	string columns = null
)

Parameters

siteName

Type: System.String
Nodes site name

aliasPath

Type: System.String
Nodes 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 (Optional)

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

where (Optional)

Type: System.String
Where condition for the data selection

orderBy (Optional)

Type: System.String
Order by clause for the data selection

maxRelativeLevel (Optional)

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

selectOnlyPublished (Optional)

Type: System.Boolean
Select only published nodes.

topN (Optional)

Type: System.Int32
Limits the number of returned items.

columns (Optional)

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

Return Value

Type: InfoDataSet<TreeNode>