TreeHelper.GetDocuments Method (String, String, String, Boolean, String, String, String, Int32, Boolean, Int32, String)

Selects tree nodes according to provided parameters, current view mode and returns them as dataset.

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

Syntax

public static TreeNodeDataSet GetDocuments(
	string siteName,
	string aliasPath,
	string cultureCode,
	bool combineWithDefaultCulture,
	string classNames,
	string where,
	string orderBy,
	int maxRelativeLevel,
	bool selectOnlyPublished,
	int topN,
	string columns = null
)

Parameters

siteName

Type: System.String
Site name

aliasPath

Type: System.String
Path. It 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
Culture code of the documents

combineWithDefaultCulture

Type: System.Boolean
Specifies if return the default culture document when specified culture not found

classNames

Type: System.String
List of classNames to select 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
Maximal child level of the selected nodes

selectOnlyPublished

Type: System.Boolean
Select only published nodes

topN

Type: System.Int32
Select only top N documents

columns (Optional)

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

Return Value

Type: TreeNodeDataSet