TreeHelper.GetDocuments Method (String, String, String, Boolean, String, String, String, Int32, Boolean, Guid, String, 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: 9.0.0

Syntax

public static InfoDataSet<TreeNode> GetDocuments(
	string siteName,
	string aliasPath,
	string cultureCode,
	bool combineWithDefaultCulture,
	string classNames,
	string where,
	string orderBy,
	int maxRelativeLevel,
	bool selectOnlyPublished,
	Guid relationshipWithNodeGuid,
	string relationshipName,
	bool relatedNodeIsOnTheLeftSide,
	int topN,
	string columns
)

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

relationshipWithNodeGuid

Type: System.Guid
Select nodes that are related to the Node GUID

relationshipName

Type: System.String
Relationship name

relatedNodeIsOnTheLeftSide

Type: System.Boolean
Specify if the related node is located on the left side of the relationship

topN

Type: System.Int32
Select only top N documents

columns

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

Return Value

Type: InfoDataSet<TreeNode>