DocumentHelper.GetDocuments Method (String, String, String, Boolean, String, String, String, Int32, Boolean, Guid, String, Boolean, TreeProvider)

Returns latest version documents data in a dataset. Result contains coupled data only if classNames are specified.

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,
	Guid relationshipWithNodeGuid,
	string relationshipName,
	bool relatedNodeIsOnTheLeftSide,
	TreeProvider tree
)

Parameters

siteName

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

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

where

Type: System.String
Where condition for the data selection

orderBy

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

maxRelativeLevel

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

selectOnlyPublished

Type: System.Boolean
Select only published nodes

relationshipWithNodeGuid

Type: System.Guid
Select nodes that are related to node with this GUID.

relationshipName

Type: System.String
Relationship name

relatedNodeIsOnTheLeftSide

Type: System.Boolean
Indicates whether the related node is located on the left side of the relationship.

tree

Type: CMS.DocumentEngine.TreeProvider
Tree provider to use

Return Value

Type: TreeNodeDataSet