Click or drag to resize
TreeNodeCollectionNodeType Class
Generic strongly typed info object collection
Inheritance Hierarchy
SystemObject
  CMS.BaseAbstractSimpleDataContainerAbstractObjectCollection
    CMS.BaseAbstractDataContainerAbstractObjectCollection
      CMS.BaseAbstractHierarchicalObjectAbstractObjectCollection
        CMS.DataEngineAbstractObjectCollection
          CMS.DataEngineObjectCollectionTreeNode
            CMS.DocumentEngineTreeNodeCollection
              CMS.DocumentEngineTreeNodeCollectionNodeType

Namespace: CMS.DocumentEngine
Assembly: CMS.DocumentEngine (in CMS.DocumentEngine.dll) Version: 8.2.23
Syntax
C#
public class TreeNodeCollection<NodeType> : TreeNodeCollection, 
	IEnumerable<NodeType>, IEnumerable
where NodeType : new(), TreeNode

Type Parameters

NodeType

The TreeNodeCollectionNodeType type exposes the following members.

Constructors
Methods
  NameDescription
Public methodAdd(IEnumerableTObject)
Adds new object to the collection.
(Inherited from ObjectCollectionTObject.)
Public methodAdd(TObject)
Adds new object to the collection.
(Inherited from ObjectCollectionTObject.)
Public methodClear
Clears the current items in the collection.
(Inherited from ObjectCollectionTObject.)
Public methodClone
Creates the clone of the collection.
(Inherited from TreeNodeCollection.)
Public methodCloneCollection
Creates the clone of this collection.
(Inherited from ObjectCollectionTObject.)
Public methodCombineWith
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 AbstractHierarchicalObjectTObject.)
Public methodCompareTo
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 methodContainsColumn
Returns true if specified column is available in current structure.
(Inherited from AbstractDataContainerParentObjectType.)
Public methodCreateChild
Creates the child collection based on the given provider
(Inherited from ObjectCollectionTObject.)
Public methodCreateNewObject
Creates new instance of the encapsulated object.
(Inherited from TreeNodeCollection.)
Protected methodCreateQueryProvider
Creates a LINQ query provider for this collection
(Inherited from ObjectCollectionTObject.)
Public methodDisconnect
Disconnects the collection from the database
(Inherited from AbstractObjectCollection.)
Protected methodEnsureItems
Ensures the specified number of items in the item list.
(Inherited from ObjectCollectionTObject.)
Public methodGetCompleteWhereCondition
Gets the complete where condition for the collection
(Inherited from AbstractObjectCollection.)
Protected methodGetData
Gets the data for the collection.
(Inherited from TreeNodeCollection.)
Public methodGetEmptyObject
Gets an empty object for this collection
(Inherited from ObjectCollectionTObject.)
Public methodGetEnumerator
Gets the strongly typed enumerator for the collection
Public methodGetEnumeratorInternal
Gets the enumerator for the collection.
(Inherited from ObjectCollectionTObject.)
Protected methodGetFullData
Gets the data set of the data behind this collection
(Inherited from ObjectCollectionTObject.)
Protected methodGetItem
Gets the item on the specified index.
(Inherited from ObjectCollectionTObject.)
Public methodGetNameWhereCondition
Gets the where condition for the given object name.
(Inherited from ObjectCollectionTObject.)
Protected methodGetObjectByNameInternal
Gets the object by its name, internal representation that gets data from database
(Inherited from TreeNodeCollection.)
Protected methodGetObjectEnumerator
Gets the object enumerator for the collection
(Inherited from ObjectCollectionTObject.)
Public methodGetObjectName(Object)
Returns the name of the given object
(Inherited from ObjectCollectionTObject.)
Public methodGetObjectName(TreeNode)
Gets the unique object name from the given object.
(Inherited from TreeNodeCollection.)
Public methodGetProperty
Gets the context property.
(Inherited from AbstractHierarchicalObjectTObject.)
Protected methodGetPropertyType
Gets the type of the given property
(Inherited from AbstractHierarchicalObjectTObject.)
Public methodGetValue
Gets the object value.
(Inherited from AbstractSimpleDataContainerTObject.)
Public methodHasSetter
Returns true if given property has a setter
(Inherited from AbstractHierarchicalObjectTObject.)
Public methodMakeEmpty
Makes the collection empty.
(Inherited from AbstractObjectCollection.)
Public methodReconnect
Reconnects the collection to the database
(Inherited from AbstractObjectCollection.)
Protected methodRegisterColumn(String, FuncTObject, Object)
Registers the given Column to the object
(Inherited from AbstractSimpleDataContainerTObject.)
Protected methodRegisterColumn(String, FuncTObject, Object, FuncTObject, Object, Object)
Registers the given Column to the object
(Inherited from AbstractSimpleDataContainerTObject.)
Protected methodRegisterColumns
Registers the Columns of this object
(Inherited from TreeNodeCollection.)
Protected methodRegisterProperties
Registers the properties of this object
(Inherited from TreeNodeCollection.)
Protected methodRegisterProperty(String, FuncTObject, Object)
Registers the given property to the object
(Inherited from AbstractHierarchicalObjectTObject.)
Protected methodRegisterProperty(String, Object, FuncTObject, Object, Object)
Registers the given parameterized property to the object.
(Inherited from AbstractHierarchicalObjectTObject.)
Public methodRemove(IEnumerableTObject)
Removes the specified object from the collection.
(Inherited from ObjectCollectionTObject.)
Public methodRemove(TObject)
Removes the specified object from the collection.
(Inherited from ObjectCollectionTObject.)
Public methodSetProperty
Gets the context property.
(Inherited from AbstractHierarchicalObjectTObject.)
Public methodSetValue
Sets the object value.
(Inherited from AbstractSimpleDataContainerTObject.)
Public methodSubmitChanges
Submits the changes in the collection to the database.
(Inherited from TreeNodeCollection.)
Public methodTryGetProperty(String, Object)
Gets the context property.
(Inherited from AbstractHierarchicalObjectTObject.)
Public methodTryGetProperty(String, Object, Boolean)
Returns value of property.
(Inherited from AbstractHierarchicalObjectTObject.)
Public methodTryGetValue
Returns value of column.
(Inherited from AbstractSimpleDataContainerTObject.)
Protected methodUseData
Initializes the collection with the given source data
(Inherited from ObjectCollectionTObject.)
Protected methodValidateItem
Validates whether the item can be member of the collection (collection can work with it). Returns true if item is valid.
(Inherited from ObjectCollectionTObject.)
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 MethodBatchNodeType
Returns input in batches of batchSize size.
(Defined by BaseExtensions.)
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 MethodToHashSetNodeType
Converts the list of objects to a hash set of distinct values
(Defined by DataExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToJSON
Returns JSON representation of current instance of IEnumerable.
(Defined by DataExtensions.)
Public Extension MethodToListNodeType, TTo
Converts the given collection to a list of values
(Defined by BaseExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToXML
Returns XML representation of current instance of IEnumerable.
(Defined by DataExtensions.)
Top
Fields
  NameDescription
Public fieldAliasPath
Alias path.
(Inherited from TreeNodeCollection.)
Public fieldClassNames
Class names to select.
(Inherited from TreeNodeCollection.)
Public fieldCombineWithDefaultCulture
Combine with default culture.
(Inherited from TreeNodeCollection.)
Public fieldCultureCode
Culture of the documents.
(Inherited from TreeNodeCollection.)
Protected fieldmAllowPaging
If true, the paging of the data is allowed (data is loaded in batches).
(Inherited from ObjectCollectionTObject.)
Public fieldMaxRelativeLevel
Maximum relative level.
(Inherited from TreeNodeCollection.)
Protected fieldmColumnNames
Column names
(Inherited from ObjectCollectionTObject.)
Protected fieldmCount
Total number of items.
(Inherited from AbstractObjectCollection.)
Protected fieldmCountDifference
Difference in count of the items from data source and current number of items
(Inherited from ObjectCollectionTObject.)
Protected fieldmDeletedItems
Deleted items removed from the collection.
(Inherited from ObjectCollectionTObject.)
Protected fieldmDisconnectedCount
Number of disconnected references for this collection
(Inherited from AbstractObjectCollection.)
Protected fieldmInstanceGuid
Instance GUID
(Inherited from AbstractObjectCollection.)
Protected fieldmItems
Items collection.
(Inherited from ObjectCollectionTObject.)
Protected fieldmLoadBinaryData
Indicates whether to load binary data into the collections.
(Inherited from AbstractObjectCollection.)
Protected fieldmName
Collection name
(Inherited from AbstractObjectCollection.)
Protected fieldmNewItems
New items added to the collection.
(Inherited from ObjectCollectionTObject.)
Protected fieldmObjectsByName
Objects by name.
(Inherited from ObjectCollectionTObject.)
Protected fieldmPageSize
Page size for loading of the items.
(Inherited from ObjectCollectionTObject.)
Protected fieldmSourceData
Source data for the collection
(Inherited from ObjectCollectionTObject.)
Protected fieldmTreeProvider
Tree provider object to use for the database access.
(Inherited from TreeNodeCollection.)
Protected fieldmWithAllData
Collection including coupled data
(Inherited from TreeNodeCollection.)
Protected fieldmWithPermissionsCheck
Collection with filtered documents based on permission check in context of current user
(Inherited from TreeNodeCollection.)
Public fieldSelectAllData
If true, the coupled data are retrieved in case class names are specified
(Inherited from TreeNodeCollection.)
Public fieldSelectOnlyPublished
Select only published documents.
(Inherited from TreeNodeCollection.)
Public fieldSiteName
Site name of the documents.
(Inherited from TreeNodeCollection.)
Top
Properties
  NameDescription
Public propertyAllowPaging
If true, the paging of the data is allowed (data is loaded in batches).
(Inherited from ObjectCollectionTObject.)
Public propertyColumnNames
Available column names.
(Inherited from AbstractDataContainerParentObjectType.)
Public propertyColumns
Columns to get.
(Inherited from AbstractObjectCollection.)
Public propertyCount
Returns the number of items.
(Inherited from ObjectCollectionTObject.)
Public propertyDefaultClassName
Default class name for the documents (if ClassName column is not available)
(Inherited from TreeNodeCollection.)
Public propertyDynamicWhereCondition
Dynamic where condition.
(Inherited from AbstractObjectCollection.)
Public propertyElementType
Returns the element type.
(Inherited from ObjectCollectionTObject.)
Public propertyEnforceReadOnlyDataAccess
If true, the read only access to the data is enforced within the transaction.
(Inherited from AbstractObjectCollection.)
Public propertyExpression
Query expression
(Inherited from ObjectCollectionTObject.)
Public propertyFirstItem
Returns the first item of the collection
(Inherited from ObjectCollectionTObject.)
Protected propertyInternalCount
Internal count of the items
(Inherited from ObjectCollectionTObject.)
Public propertyIsCachedObject
If true, the object is cached within the system for later use
(Inherited from AbstractObjectCollection.)
Public propertyIsDisconnected
Returns true if the collection is disconnected from the data source
(Inherited from TreeNodeCollection.)
Public propertyIsLastVersion
If true, the document is the last version (retrieved using DocumentHelper.GetDocument).
(Inherited from AbstractObjectCollection.)
Public propertyIsOffline
Returns true, if the collection is offline (not backed up by the database but by the source data)
(Inherited from ObjectCollectionTObject.)
Public propertyItemInt32
Gets or sets the object on specific index.
(Inherited from ObjectCollectionTObject.)
Public propertyItemString
Returns the object registered by the specific name.
(Inherited from ObjectCollectionTObject.)
Protected propertyItems
Returns the items collection.
(Inherited from ObjectCollectionTObject.)
Public propertyItemsHaveNames
Returns true if the items in the collection have names
(Inherited from ObjectCollectionTObject.)
Public propertyItemType
Result type
(Inherited from ObjectCollectionTObject.)
Public propertyLastItem
Returns the last item of the collection
(Inherited from ObjectCollectionTObject.)
Public propertyLoadBinaryData
Gets or sets the value which indicates whether to load binary data into the collections.
(Inherited from ObjectCollectionTObject.)
Public propertyName
Collection name
(Inherited from AbstractObjectCollection.)
Public propertyNameColumn
Name column name
(Inherited from TreeNodeCollection.)
Protected propertyObjectsByName
Objects by name collection.
(Inherited from ObjectCollectionTObject.)
Public propertyOrderBy
Order by expression.
(Inherited from AbstractObjectCollection.)
Public propertyParentDocument
Parent document.
(Inherited from TreeNodeCollection.)
Public propertyParentStorage
Parent storage
(Inherited from AbstractObjectCollection.)
Public propertyProperties
Properties available through the context.
(Inherited from AbstractHierarchicalObjectTObject.)
Protected propertyPropertyList
Used property list
(Inherited from AbstractHierarchicalObjectTObject.)
Public propertyProvider
Query provider
(Inherited from ObjectCollectionTObject.)
Protected propertyRegisteredColumns
Registered Columns
(Inherited from AbstractSimpleDataContainerTObject.)
Protected propertyRegisteredColumnsObject
Registered Columns object
(Inherited from AbstractSimpleDataContainerTObject.)
Protected propertyRegisteredProperties
Registered properties
(Inherited from AbstractHierarchicalObjectTObject.)
Protected propertyRegisteredPropertiesObject
Registered properties object
(Inherited from AbstractHierarchicalObjectTObject.)
Protected propertyRemovedObject
Defines the removed object within collection
(Inherited from ObjectCollectionTObject.)
Public propertySortNames
If true, the names in enumeration are sorted
(Inherited from ObjectCollectionTObject.)
Public propertyTopN
Select top N objects.
(Inherited from AbstractObjectCollection.)
Public propertyTreeProvider
Tree provider instance used to access data. If no TreeProvider is assigned, a new TreeProvider instance is created.
(Inherited from TreeNodeCollection.)
Protected propertyUseLocalColumns
If true, the object uses local columns
(Inherited from AbstractSimpleDataContainerTObject.)
Protected propertyUseLocalProperties
If true, the object uses local properties
(Inherited from AbstractHierarchicalObjectTObject.)
Public propertyWhereCondition
Where condition.
(Inherited from AbstractObjectCollection.)
Public propertyWithAllData
Collection including coupled data
(Inherited from TreeNodeCollection.)
Public propertyWithPermissionsCheck
Collection with filtered documents based on permission check in context of current user
(Inherited from TreeNodeCollection.)
Top
See Also