TreeNodeCollection<NodeType> Class

Generic strongly typed info object collection

Inheritance Hierarchy

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

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

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

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.)
Public field	MaxRelativeLevel	Maximum relative level. (Inherited from TreeNodeCollection.)
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	ObjectInitializer	Provides a way how to initialize the object instance based on given data (Inherited from InfoObjectCollection<TInfo>.)
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 InfoObjectCollection<TInfo>.)
Protected property	AutomaticNameColumn	If true, the automatic name column is used within this collection (Inherited from InfoObjectCollection<TInfo>.)
Public property	CheckLicense	If true, the collection check license when getting data (Inherited from InfoObjectCollection<TInfo>.)
Public property	CodeNames	Collection of the object code names (Inherited from InfoObjectCollection<TInfo>.)
Public property	ColumnNames	Available column names. (Inherited from AbstractDataContainer<ParentObjectType>.)
Public property	Columns	Columns to get. (Inherited from InfoObjectCollection<TInfo>.)
Public property	Count	Returns the number of items. (Inherited from InfoObjectCollection<TInfo>.)
Public property	DefaultClassName	Default class name for the documents (if ClassName column is not available) (Inherited from TreeNodeCollection.)
Protected property	DeletedItems	Returns the items collection. (Inherited from InfoObjectCollection<TInfo>.)
Public property	DisplayNames	Collection of the object display names (Inherited from InfoObjectCollection<TInfo>.)
Public property	DynamicWhereCondition	Dynamic where condition. (Inherited from InfoObjectCollection<TInfo>.)
Public property	ElementType	Returns the element type. (Inherited from InfoObjectCollection<TInfo>.)
Public property	EnforceReadOnlyDataAccess	If true, the read only access to the data is enforced within the transaction. (Inherited from InfoObjectCollection<TInfo>.)
Public property	Expression	Query expression (Inherited from InfoObjectCollection<TInfo>.)
Public property	FieldsAsObjects	Related objects wrappers (Inherited from InfoObjectCollection<TInfo>.)
Public property	FirstItem	Returns the first item of the collection (Inherited from InfoObjectCollection<TInfo>.)
Public property	GUIDs	Collection of the object GUIDs (Inherited from InfoObjectCollection<TInfo>.)
Public property	IDs	Collection of the object IDs (Inherited from InfoObjectCollection<TInfo>.)
Protected property	InternalCount	Internal count of the items (Inherited from InfoObjectCollection<TInfo>.)
Public property	IsCachedObject	If true, the object is cached within the system for later use (Inherited from InfoObjectCollection<TInfo>.)
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 InfoObjectCollection<TInfo>.)
Public property	IsOffline	Returns true, if the collection is offline (not backed up by the database but by the source data) (Inherited from InfoObjectCollection<TInfo>.)
Public property	Item[Int32]	Gets or sets the object on specific index. (Inherited from InfoObjectCollection<TInfo>.)
Public property	Item[String]	Returns the object registered by the specific name. (Inherited from InfoObjectCollection<TInfo>.)
Protected property	Items	Returns the items collection. (Inherited from InfoObjectCollection<TInfo>.)
Public property	ItemsAsFields	Fields wrappers (Inherited from InfoObjectCollection<TInfo>.)
Public property	ItemsHaveNames	Returns true if the items in the collection have names (Inherited from InfoObjectCollection<TInfo>.)
Public property	ItemType	Result type (Inherited from InfoObjectCollection<TInfo>.)
Public property	LastItem	Returns the last item of the collection (Inherited from InfoObjectCollection<TInfo>.)
Public property	LoadBinaryData	Gets or sets the value which indicates whether to load binary data into the collections. (Inherited from InfoObjectCollection<TInfo>.)
Public property	Name	Collection name. Returns object type if name is not defined (Inherited from InfoObjectCollection<TInfo>.)
Public property	NameColumn	Name column name (Inherited from TreeNodeCollection.)
Protected property	NewItems	Returns the items collection. (Inherited from InfoObjectCollection<TInfo>.)
Public property	Object	Object instance of the specified type. (Inherited from InfoObjectCollection<TInfo>.)
Protected property	ObjectsByName	Objects by name collection. (Inherited from InfoObjectCollection<TInfo>.)
Public property	ObjectType	Returns the object type of the objects stored within the collection. (Inherited from InfoObjectCollection<TInfo>.)
Public property	OrderByColumns	Order by expression. (Inherited from InfoObjectCollection<TInfo>.)
Public property	PageSize	Page size for loading of the items. (Inherited from InfoObjectCollection<TInfo>.)
Public property	ParentDocument	Parent document. (Inherited from TreeNodeCollection.)
Public property	ParentObject	Parent object. Instance of object which contains this collection as it's inner field. (Inherited from InfoObjectCollection<TInfo>.)
Public property	ParentStorage	Parent storage (Inherited from InfoObjectCollection<TInfo>.)
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 InfoObjectCollection<TInfo>.)
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 InfoObjectCollection<TInfo>.)
Public property	SiteID	Site ID to filter the collection to a particular site (Inherited from InfoObjectCollection<TInfo>.)
Public property	SortNames	If true, the names in enumeration are sorted (Inherited from InfoObjectCollection<TInfo>.)
Public property	SourceData	Source data for the collection (Inherited from InfoObjectCollection<TInfo>.)
Public property	TopN	Select top N objects. (Inherited from InfoObjectCollection<TInfo>.)
Public property	TreeProvider	Tree provider instance used to access data. If no TreeProvider is assigned, a new TreeProvider instance is created. (Inherited from TreeNodeCollection.)
Public property	TypeInfo	Type info for the collection object. (Inherited from InfoObjectCollection<TInfo>.)
Public property	UseDefaultCacheDependencies	If true, the collection uses default cache dependencies to flush it's content (Inherited from InfoObjectCollection<TInfo>.)
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	UseObjectTypeCondition	If true, the collection uses the type condition to get the data (Inherited from InfoObjectCollection<TInfo>.)
Public property	Where	Where condition. (Inherited from InfoObjectCollection<TInfo>.)
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.)

Methods

	Name	Description
Public method	Add(BaseInfo[])	Adds new object to the collection. (Inherited from InfoObjectCollection<TInfo>.)
Public method	Add(IEnumerable<BaseInfo>)	Adds new object to the collection. (Inherited from InfoObjectCollection<TInfo>.)
Public method	AddCacheDependencies	Adds the given list of cache dependencies to the collection (Inherited from InfoObjectCollection<TInfo>.)
Public method	As<TType>	Makes a wrapper of the collection with specified type of the items. (Inherited from InfoObjectCollection<TInfo>.)
Protected method	CacheDependenciesChanged	Ensures the actions when the cache dependencies have changed (Inherited from InfoObjectCollection<TInfo>.)
Public method	ChangeParent	Changes the parent of the collection (Inherited from InfoObjectCollection<TInfo>.)
Public method	Clear	Clears the current items in the collection. (Inherited from InfoObjectCollection<TInfo>.)
Public method	ClearCache	Clears the collection cache (Inherited from InfoObjectCollection<TInfo>.)
Public method	Clone	Creates the clone of the collection. (Inherited from TreeNodeCollection.)
Public method	CloneCollection	Creates the clone of this collection. (Inherited from InfoObjectCollection<TInfo>.)
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 InfoObjectCollection<TInfo>.)
Public method	ContainsColumn	Returns true if specified column is available in current structure. (Inherited from AbstractDataContainer<ParentObjectType>.)
Protected method	CopyPropertiesTo	Copies the properties of this collection to the other collection (Inherited from TreeNodeCollection.)
Public method	CreateChild	Creates the child collection based on the given provider (Inherited from InfoObjectCollection<TInfo>.)
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 InfoObjectCollection<TInfo>.)
Public method	Disconnect	Disconnects the collection from the database (Inherited from InfoObjectCollection<TInfo>.)
Public method	Dispose	Disposes the object (Inherited from InfoObjectCollection<TInfo>.)
Protected method	EnsureItems	Ensures the specified number of items in the item list. (Inherited from InfoObjectCollection<TInfo>.)
Protected method	EnsureObjectValues	Ensures the proper values for the given object (Inherited from InfoObjectCollection<TInfo>.)
Protected method	GetCacheDependencyKeys	Gets the list of cache dependency keys on which this collection depends (Inherited from InfoObjectCollection<TInfo>.)
Public method	GetCompleteWhereCondition	Gets the complete where condition for the collection (Inherited from InfoObjectCollection<TInfo>.)
Protected method	GetData	Gets the data for the collection. (Inherited from TreeNodeCollection.)
Public method	GetEmptyObject	Gets an empty object for this collection (Inherited from InfoObjectCollection<TInfo>.)
Public method	GetEnumerator	Gets the strongly typed enumerator for the collection
Public method	GetEnumeratorInternal	Gets the enumerator for the collection. (Inherited from InfoObjectCollection<TInfo>.)
Public method	GetFieldsAsObjects(String)	Gets the collection of objects that are referenced by the given property (Inherited from InfoObjectCollection<TInfo>.)
Protected method	GetFieldsAsObjects(String, String)	Gets the collection of objects that are referenced by the given property (Inherited from InfoObjectCollection<TInfo>.)
Protected method	GetFullData	Gets the data set of the data behind this collection (Inherited from InfoObjectCollection<TInfo>.)
Protected method	GetItem	Gets the item on the specified index. (Inherited from InfoObjectCollection<TInfo>.)
Public method	GetItemsAsFields	Returns the updatable collection of fields of collection items (Inherited from InfoObjectCollection<TInfo>.)
Public method	GetNameWhereCondition	Gets the where condition for the given object name. (Inherited from InfoObjectCollection<TInfo>.)
Protected method	GetObjectByNameInternal	Gets the object by its name, internal representation that gets data from database (Inherited from TreeNodeCollection.)
Public method	GetObjectName(Object)	Gets the unique object name from the given object. (Inherited from InfoObjectCollection<TInfo>.)
Public method	GetObjectName(TreeNode)	Gets the unique object name from the given object. (Inherited from TreeNodeCollection.)
Public method	GetObjectToCheck	Gets an object for which to perform the permissions check. (Inherited from InfoObjectCollection<TInfo>.)
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	GetSubsetOrderBy	Returns the clone of the collection with specified order by applied (Inherited from InfoObjectCollection<TInfo>.)
Public method	GetSubsetWhere	Returns the clone of the collection with specified where condition applied (Inherited from InfoObjectCollection<TInfo>.)
Public method	GetSubsetWhereNotEmpty	Returns the clone of the collection with specified column not being empty (Inherited from InfoObjectCollection<TInfo>.)
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>.)
Protected method	Init	Initializes the collection to use specific object type (Inherited from InfoObjectCollection<TInfo>.)
Public method	Load	Clears the data in the collection and loads objects from the given list. (Inherited from InfoObjectCollection<TInfo>.)
Public method	MakeEmpty	Makes the collection empty. (Inherited from InfoObjectCollection<TInfo>.)
Public method	Reconnect	Reconnects the collection to the database (Inherited from InfoObjectCollection<TInfo>.)
Protected method	RegisterClearCacheCallback	Registers the callback to clear the collection cache (Inherited from InfoObjectCollection<TInfo>.)
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.)
Public method	RegisterProperties(List<String>)	Registers supported properties (Inherited from InfoObjectCollection<TInfo>.)
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<TInfo>)	Removes the specified object from the collection. (Inherited from InfoObjectCollection<TInfo>.)
Public method	Remove(TInfo[])	Removes the specified object from the collection. (Inherited from InfoObjectCollection<TInfo>.)
Protected method	RemoveClearCacheCallback	Removes the callback to clear the collection cache (Inherited from InfoObjectCollection<TInfo>.)
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	ToString	Provides a string representation of the collection (Inherited from InfoObjectCollection<TInfo>.)
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 InfoObjectCollection<TInfo>.)
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 InfoObjectCollection<TInfo>.)

Extension Methods

	Name	Description
Public Extension Method	Batch<NodeType>	Returns input in batches of batchSize size. (Defined by BaseExtensions.)
Public Extension Method	ToJSON	Returns JSON representation of current instance of IEnumerable. (Defined by DataExtensions.)
Public Extension Method	ToXML	Returns XML representation of current instance of IEnumerable. (Defined by DataExtensions.)