Click or drag to resize
NodeSelectionParameters Class
Structure to define the selection parameters for a document nodes selection
Inheritance Hierarchy
SystemObject
  CMS.DocumentEngineNodeSelectionParameters

Namespace: CMS.DocumentEngine
Assembly: CMS.DocumentEngine (in CMS.DocumentEngine.dll) Version: 8.2.23
Syntax
C#
public class NodeSelectionParameters

The NodeSelectionParameters type exposes the following members.

Constructors
  NameDescription
Public methodNodeSelectionParameters
Constructor
Top
Extension Methods
  NameDescription
Public Extension MethodAsValue
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.)
Public Extension MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Top
Fields
  NameDescription
Protected fieldmCombineWithDefaultCulture
Combine with default culture
Top
Properties
  NameDescription
Public propertyAliasPath
Path. It may contain % and _ as wild card characters for any number of unknown characters or one unknown character respectively (for MS SQL)
Public propertyClassNames
List of classNames to select separated by semicolon (e.g.: "cms.article;cms.product")
Public propertyColumns
Columns to be selected. Columns definition must contain mandatory columns (NodeID, NodeLinkedNodeID, DocumentCulture)
Public propertyCombineWithDefaultCulture
Specifies if return the default culture document when specified culture not found
Public propertyCultureCode
Nodes culture code
Public propertyCheckLicense
If true, the selection checks license conditions
Public propertyMaxRelativeLevel
Maximal child level of the selected nodes
Public propertyOrderBy
Order by clause to use for the data selection
Public propertySelectAllData
If true, the coupled data are retrieved in case class names are specified
Public propertySelectOnlyPublished
Select only published nodes
Public propertySelectSingleNode
If true, single node selection takes place (escapes query like patterns)
Public propertySiteName
Nodes site name
Public propertyTopN
Select top N rows only
Public propertyWhere
Where condition to use for the data selection
Top
See Also