TreeNodeRepository.AddCollection Method

Registers the given collection of objects within the repository.

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

Syntax

public virtual TreeNodeCollectionSettings AddCollection(
	string name,
	string className,
	string siteName,
	string aliasPath,
	string cultureCode,
	bool combineWithDefaultCulture,
	string classNames,
	string where,
	string orderBy,
	int maxRelativeLevel,
	bool selectOnlyPublished,
	int topN,
	string columns
)

Parameters

name

Type: System.String
Collection name

className

Type: System.String
Default class name

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
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 top N rows only

columns

Type: System.String
Columns to be selected

Return Value

Type: TreeNodeCollectionSettings