NodeSelectionParameters Class

Structure to define the selection parameters for a document nodes selection

Inheritance Hierarchy

System.Object
  CMS.DocumentEngine.NodeSelectionParameters

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

Syntax

public class NodeSelectionParameters

The NodeSelectionParameters type exposes the following members.

Constructors

	Name	Description
Public method	NodeSelectionParameters	Constructor

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

	Name	Description
Protected field	mCombineWithDefaultCulture	Combine with default culture

Properties

	Name	Description
Public property	AliasPath	Path. It may contain % and _ as wild card characters for any number of unknown characters or one unknown character respectively (for MS SQL)
Public property	ClassNames	List of classNames to select separated by semicolon (e.g.: "cms.article;cms.product")
Public property	Columns	Columns to be selected. Columns definition must contain mandatory columns (NodeID, NodeLinkedNodeID, DocumentCulture)
Public property	CombineWithDefaultCulture	Specifies if return the default culture document when specified culture not found
Public property	CultureCode	Nodes culture code
Public property	CheckLicense	If true, the selection checks license conditions
Public property	MaxRelativeLevel	Maximal child level of the selected nodes
Public property	OrderBy	Order by clause to use for the data selection
Public property	SelectAllData	If true, the coupled data are retrieved in case class names are specified
Public property	SelectOnlyPublished	Select only published nodes
Public property	SelectSingleNode	If true, single node selection takes place (escapes query like patterns)
Public property	SiteName	Nodes site name
Public property	TopN	Select top N rows only
Public property	Where	Where condition to use for the data selection