DocumentHelperGetDocuments Method (String, String, String, Boolean, String, String, String, Int32, Boolean, Int32, String, TreeProvider) |
Returns latest version documents data in a dataset. Result contains coupled data only if classNames are specified.
Namespace: CMS.DocumentEngineAssembly: 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,
int topN,
string columns,
TreeProvider tree
)
Parameters
- siteName
- Type: SystemString
Nodes 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
Nodes culture code - combineWithDefaultCulture
- Type: SystemBoolean
Indicates whether node in default culture should be returned if node in specified culture was not found. - classNames
- Type: SystemString
List of class names separated by semicolon (e.g.: "cms.article;cms.product") - where
- Type: SystemString
Where condition for the data selection - orderBy
- Type: SystemString
Order by clause for the data selection - maxRelativeLevel
- Type: SystemInt32
Maximum child level of the selected nodes - selectOnlyPublished
- Type: SystemBoolean
Select only published nodes - topN
- Type: SystemInt32
Limits the number of returned items. - columns
- Type: SystemString
Columns to be selected. Must contain mandatory columns (NodeID, NodeLinkedNodeID, DocumentCulture). - tree
- Type: CMS.DocumentEngineTreeProvider
Tree provider to use
Return Value
Type:
InfoDataSetTreeNodeSee Also