Click or drag to resize
TreeHelperGetDocuments 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: 8.2.23
Syntax
C#
Copy
public static TreeNodeDataSet 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: SystemString
Site name
aliasPath
Type: SystemString
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: SystemString
Culture code of the documents
combineWithDefaultCulture
Type: SystemBoolean
Specifies if return the default culture document when specified culture not found
classNames
Type: SystemString
List of classNames to select separated by semicolon (e.g.: "cms.article;cms.product")
where
Type: SystemString
Where condition to use for the data selection
orderBy
Type: SystemString
Order by clause to use for the data selection
maxRelativeLevel
Type: SystemInt32
Maximal child level of the selected nodes
selectOnlyPublished
Type: SystemBoolean
Select only published nodes
relationshipWithNodeGuid
Type: SystemGuid
Select nodes that are related to the Node GUID
relationshipName
Type: SystemString
Relationship name
relatedNodeIsOnTheLeftSide
Type: SystemBoolean
Specify if the related node is located on the left side of the relationship
topN
Type: SystemInt32
Select only top N documents
columns
Type: SystemString
Columns to be selected. Columns definition must contain mandatory columns (NodeID, NodeLinkedNodeID, DocumentCulture)

Return Value

Type: TreeNodeDataSet
See Also