TreeNodeCollection<NodeType> Class

Generic strongly typed info object collection

Inheritance Hierarchy

System.Object
  CMS.Base.AbstractSimpleDataContainer<AbstractObjectCollection>
    CMS.Base.AbstractDataContainer<AbstractObjectCollection>
      CMS.Base.AbstractHierarchicalObject<AbstractObjectCollection>
        CMS.DataEngine.AbstractObjectCollection
          CMS.DataEngine.ObjectCollection<TreeNode>
            CMS.DocumentEngine.TreeNodeCollection
              CMS.DocumentEngine.TreeNodeCollection<NodeType>

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

Syntax

public class TreeNodeCollection<NodeType> : TreeNodeCollection, 
	IEnumerable<NodeType>, IEnumerable
where NodeType : new(), TreeNode

Type Parameters

NodeType

The TreeNodeCollection<NodeType> type exposes the following members.

Constructors

	Name	Description
Public method	TreeNodeCollection<NodeType>(String)	Constructor.
Public method	TreeNodeCollection<NodeType>(String, DataSet)	Constructor. Creates a static collection populated from DataSet

Methods

	Name	Description
Public method	Add(IEnumerable<TObject>)	Adds new object to the collection. (Inherited from ObjectCollection<TObject>.)
Public method	Add(TObject[])	Adds new object to the collection. (Inherited from ObjectCollection<TObject>.)
Public method	Clear	Clears the current items in the collection. (Inherited from ObjectCollection<TObject>.)
Public method	Clone	Creates the clone of the collection. (Inherited from TreeNodeCollection.)
Public method	CloneCollection	Creates the clone of this collection. (Inherited from ObjectCollection<TObject>.)
Public method	CombineWith	Combines current instance with other properties (modifies current instace!). List properties are merged from all the participating typeinfos, other properties are taken as first non-null value (non-null is determined by nullValues collection). (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	CompareTo	Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. (Inherited from AbstractObjectCollection.)
Public method	ContainsColumn	Returns true if specified column is available in current structure. (Inherited from AbstractDataContainer<ParentObjectType>.)
Public method	CreateChild	Creates the child collection based on the given provider (Inherited from ObjectCollection<TObject>.)
Public method	CreateNewObject	Creates new instance of the encapsulated object. (Inherited from TreeNodeCollection.)
Protected method	CreateQueryProvider	Creates a LINQ query provider for this collection (Inherited from ObjectCollection<TObject>.)
Public method	Disconnect	Disconnects the collection from the database (Inherited from AbstractObjectCollection.)
Protected method	EnsureItems	Ensures the specified number of items in the item list. (Inherited from ObjectCollection<TObject>.)
Public method	GetCompleteWhereCondition	Gets the complete where condition for the collection (Inherited from AbstractObjectCollection.)
Protected method	GetData	Gets the data for the collection. (Inherited from TreeNodeCollection.)
Public method	GetEmptyObject	Gets an empty object for this collection (Inherited from ObjectCollection<TObject>.)
Public method	GetEnumerator	Gets the strongly typed enumerator for the collection
Public method	GetEnumeratorInternal	Gets the enumerator for the collection. (Inherited from ObjectCollection<TObject>.)
Protected method	GetFullData	Gets the data set of the data behind this collection (Inherited from ObjectCollection<TObject>.)
Protected method	GetItem	Gets the item on the specified index. (Inherited from ObjectCollection<TObject>.)
Public method	GetNameWhereCondition	Gets the where condition for the given object name. (Inherited from ObjectCollection<TObject>.)
Protected method	GetObjectByNameInternal	Gets the object by its name, internal representation that gets data from database (Inherited from TreeNodeCollection.)
Protected method	GetObjectEnumerator	Gets the object enumerator for the collection (Inherited from ObjectCollection<TObject>.)
Public method	GetObjectName(Object)	Returns the name of the given object (Inherited from ObjectCollection<TObject>.)
Public method	GetObjectName(TreeNode)	Gets the unique object name from the given object. (Inherited from TreeNodeCollection.)
Public method	GetProperty	Gets the context property. (Inherited from AbstractHierarchicalObject<TObject>.)
Protected method	GetPropertyType	Gets the type of the given property (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	GetValue	Gets the object value. (Inherited from AbstractSimpleDataContainer<TObject>.)
Public method	HasSetter	Returns true if given property has a setter (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	MakeEmpty	Makes the collection empty. (Inherited from AbstractObjectCollection.)
Public method	Reconnect	Reconnects the collection to the database (Inherited from AbstractObjectCollection.)
Protected method	RegisterColumn(String, Func<TObject, Object>)	Registers the given Column to the object (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected method	RegisterColumn(String, Func<TObject, Object>, Func<TObject, Object, Object>)	Registers the given Column to the object (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected method	RegisterColumns	Registers the Columns of this object (Inherited from TreeNodeCollection.)
Protected method	RegisterProperties	Registers the properties of this object (Inherited from TreeNodeCollection.)
Protected method	RegisterProperty(String, Func<TObject, Object>)	Registers the given property to the object (Inherited from AbstractHierarchicalObject<TObject>.)
Protected method	RegisterProperty(String, Object, Func<TObject, Object, Object>)	Registers the given parameterized property to the object. (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	Remove(IEnumerable<TObject>)	Removes the specified object from the collection. (Inherited from ObjectCollection<TObject>.)
Public method	Remove(TObject[])	Removes the specified object from the collection. (Inherited from ObjectCollection<TObject>.)
Public method	SetProperty	Gets the context property. (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	SetValue	Sets the object value. (Inherited from AbstractSimpleDataContainer<TObject>.)
Public method	SubmitChanges	Submits the changes in the collection to the database. (Inherited from TreeNodeCollection.)
Public method	TryGetProperty(String, Object)	Gets the context property. (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	TryGetProperty(String, Object, Boolean)	Returns value of property. (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	TryGetValue	Returns value of column. (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected method	UseData	Initializes the collection with the given source data (Inherited from ObjectCollection<TObject>.)
Protected method	ValidateItem	Validates whether the item can be member of the collection (collection can work with it). Returns true if item is valid. (Inherited from ObjectCollection<TObject>.)

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	Batch<NodeType>	Returns input in batches of batchSize size. (Defined by BaseExtensions.)
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	ToHashSet<NodeType>	Converts the list of objects to a hash set of distinct values (Defined by DataExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToJSON	Returns JSON representation of current instance of IEnumerable. (Defined by DataExtensions.)
Public Extension Method	ToList<NodeType, TTo>	Converts the given collection to a list of values (Defined by BaseExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToXML	Returns XML representation of current instance of IEnumerable. (Defined by DataExtensions.)

Fields

	Name	Description
Public field	AliasPath	Alias path. (Inherited from TreeNodeCollection.)
Public field	ClassNames	Class names to select. (Inherited from TreeNodeCollection.)
Public field	CombineWithDefaultCulture	Combine with default culture. (Inherited from TreeNodeCollection.)
Public field	CultureCode	Culture of the documents. (Inherited from TreeNodeCollection.)
Protected field	mAllowPaging	If true, the paging of the data is allowed (data is loaded in batches). (Inherited from ObjectCollection<TObject>.)
Public field	MaxRelativeLevel	Maximum relative level. (Inherited from TreeNodeCollection.)
Protected field	mColumnNames	Column names (Inherited from ObjectCollection<TObject>.)
Protected field	mCount	Total number of items. (Inherited from AbstractObjectCollection.)
Protected field	mCountDifference	Difference in count of the items from data source and current number of items (Inherited from ObjectCollection<TObject>.)
Protected field	mDeletedItems	Deleted items removed from the collection. (Inherited from ObjectCollection<TObject>.)
Protected field	mDisconnectedCount	Number of disconnected references for this collection (Inherited from AbstractObjectCollection.)
Protected field	mInstanceGuid	Instance GUID (Inherited from AbstractObjectCollection.)
Protected field	mItems	Items collection. (Inherited from ObjectCollection<TObject>.)
Protected field	mLoadBinaryData	Indicates whether to load binary data into the collections. (Inherited from AbstractObjectCollection.)
Protected field	mName	Collection name (Inherited from AbstractObjectCollection.)
Protected field	mNewItems	New items added to the collection. (Inherited from ObjectCollection<TObject>.)
Protected field	mObjectsByName	Objects by name. (Inherited from ObjectCollection<TObject>.)
Protected field	mPageSize	Page size for loading of the items. (Inherited from ObjectCollection<TObject>.)
Protected field	mSourceData	Source data for the collection (Inherited from ObjectCollection<TObject>.)
Protected field	mTreeProvider	Tree provider object to use for the database access. (Inherited from TreeNodeCollection.)
Protected field	mWithAllData	Collection including coupled data (Inherited from TreeNodeCollection.)
Protected field	mWithPermissionsCheck	Collection with filtered documents based on permission check in context of current user (Inherited from TreeNodeCollection.)
Public field	SelectAllData	If true, the coupled data are retrieved in case class names are specified (Inherited from TreeNodeCollection.)
Public field	SelectOnlyPublished	Select only published documents. (Inherited from TreeNodeCollection.)
Public field	SiteName	Site name of the documents. (Inherited from TreeNodeCollection.)

Properties

	Name	Description
Public property	AllowPaging	If true, the paging of the data is allowed (data is loaded in batches). (Inherited from ObjectCollection<TObject>.)
Public property	ColumnNames	Available column names. (Inherited from AbstractDataContainer<ParentObjectType>.)
Public property	Columns	Columns to get. (Inherited from AbstractObjectCollection.)
Public property	Count	Returns the number of items. (Inherited from ObjectCollection<TObject>.)
Public property	DefaultClassName	Default class name for the documents (if ClassName column is not available) (Inherited from TreeNodeCollection.)
Public property	DynamicWhereCondition	Dynamic where condition. (Inherited from AbstractObjectCollection.)
Public property	ElementType	Returns the element type. (Inherited from ObjectCollection<TObject>.)
Public property	EnforceReadOnlyDataAccess	If true, the read only access to the data is enforced within the transaction. (Inherited from AbstractObjectCollection.)
Public property	Expression	Query expression (Inherited from ObjectCollection<TObject>.)
Public property	FirstItem	Returns the first item of the collection (Inherited from ObjectCollection<TObject>.)
Protected property	InternalCount	Internal count of the items (Inherited from ObjectCollection<TObject>.)
Public property	IsCachedObject	If true, the object is cached within the system for later use (Inherited from AbstractObjectCollection.)
Public property	IsDisconnected	Returns true if the collection is disconnected from the data source (Inherited from TreeNodeCollection.)
Public property	IsLastVersion	If true, the document is the last version (retrieved using DocumentHelper.GetDocument). (Inherited from AbstractObjectCollection.)
Public property	IsOffline	Returns true, if the collection is offline (not backed up by the database but by the source data) (Inherited from ObjectCollection<TObject>.)
Public property	Item[Int32]	Gets or sets the object on specific index. (Inherited from ObjectCollection<TObject>.)
Public property	Item[String]	Returns the object registered by the specific name. (Inherited from ObjectCollection<TObject>.)
Protected property	Items	Returns the items collection. (Inherited from ObjectCollection<TObject>.)
Public property	ItemsHaveNames	Returns true if the items in the collection have names (Inherited from ObjectCollection<TObject>.)
Public property	ItemType	Result type (Inherited from ObjectCollection<TObject>.)
Public property	LastItem	Returns the last item of the collection (Inherited from ObjectCollection<TObject>.)
Public property	LoadBinaryData	Gets or sets the value which indicates whether to load binary data into the collections. (Inherited from ObjectCollection<TObject>.)
Public property	Name	Collection name (Inherited from AbstractObjectCollection.)
Public property	NameColumn	Name column name (Inherited from TreeNodeCollection.)
Protected property	ObjectsByName	Objects by name collection. (Inherited from ObjectCollection<TObject>.)
Public property	OrderBy	Order by expression. (Inherited from AbstractObjectCollection.)
Public property	ParentDocument	Parent document. (Inherited from TreeNodeCollection.)
Public property	ParentStorage	Parent storage (Inherited from AbstractObjectCollection.)
Public property	Properties	Properties available through the context. (Inherited from AbstractHierarchicalObject<TObject>.)
Protected property	PropertyList	Used property list (Inherited from AbstractHierarchicalObject<TObject>.)
Public property	Provider	Query provider (Inherited from ObjectCollection<TObject>.)
Protected property	RegisteredColumns	Registered Columns (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected property	RegisteredColumnsObject	Registered Columns object (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected property	RegisteredProperties	Registered properties (Inherited from AbstractHierarchicalObject<TObject>.)
Protected property	RegisteredPropertiesObject	Registered properties object (Inherited from AbstractHierarchicalObject<TObject>.)
Protected property	RemovedObject	Defines the removed object within collection (Inherited from ObjectCollection<TObject>.)
Public property	SortNames	If true, the names in enumeration are sorted (Inherited from ObjectCollection<TObject>.)
Public property	TopN	Select top N objects. (Inherited from AbstractObjectCollection.)
Public property	TreeProvider	Tree provider instance used to access data. If no TreeProvider is assigned, a new TreeProvider instance is created. (Inherited from TreeNodeCollection.)
Protected property	UseLocalColumns	If true, the object uses local columns (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected property	UseLocalProperties	If true, the object uses local properties (Inherited from AbstractHierarchicalObject<TObject>.)
Public property	WhereCondition	Where condition. (Inherited from AbstractObjectCollection.)
Public property	WithAllData	Collection including coupled data (Inherited from TreeNodeCollection.)
Public property	WithPermissionsCheck	Collection with filtered documents based on permission check in context of current user (Inherited from TreeNodeCollection.)