Click or drag to resize
TreeNodeCollectionNodeType Class
Generic strongly typed info object collection
Inheritance Hierarchy
SystemObject
  CMS.BaseAbstractSimpleDataContainerInfoObjectCollectionTreeNode
    CMS.BaseAbstractDataContainerInfoObjectCollectionTreeNode
      CMS.BaseAbstractHierarchicalObjectInfoObjectCollectionTreeNode
        CMS.DataEngineInfoObjectCollectionTreeNode
          CMS.DocumentEngineTreeNodeCollection
            CMS.DocumentEngineTreeNodeCollectionNodeType

Namespace: CMS.DocumentEngine
Assembly: CMS.DocumentEngine (in CMS.DocumentEngine.dll) Version: 12.0.0
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
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.)
Public fieldMaxRelativeLevel
Maximum relative level.
(Inherited from TreeNodeCollection.)
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 fieldObjectInitializer
Provides a way how to initialize the object instance based on given data
(Inherited from InfoObjectCollectionTInfo.)
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 InfoObjectCollectionTInfo.)
Protected propertyAutomaticNameColumn
If true, the automatic name column is used within this collection
(Inherited from InfoObjectCollectionTInfo.)
Public propertyCheckLicense
If true, the collection check license when getting data
(Inherited from InfoObjectCollectionTInfo.)
Public propertyCodeNames
Collection of the object code names
(Inherited from InfoObjectCollectionTInfo.)
Public propertyColumnNames
Available column names.
(Inherited from AbstractDataContainerParentObjectType.)
Public propertyColumns
Columns to get.
(Inherited from InfoObjectCollectionTInfo.)
Public propertyCount
Returns the number of items.
(Inherited from InfoObjectCollectionTInfo.)
Public propertyDefaultClassName
Default class name for the documents (if ClassName column is not available)
(Inherited from TreeNodeCollection.)
Protected propertyDeletedItems
Returns the items collection.
(Inherited from InfoObjectCollectionTInfo.)
Public propertyDisplayNames
Collection of the object display names
(Inherited from InfoObjectCollectionTInfo.)
Public propertyDynamicWhereCondition
Dynamic where condition.
(Inherited from InfoObjectCollectionTInfo.)
Public propertyElementType
Returns the element type.
(Inherited from InfoObjectCollectionTInfo.)
Public propertyEnforceReadOnlyDataAccess
If true, the read only access to the data is enforced within the transaction.
(Inherited from InfoObjectCollectionTInfo.)
Public propertyExpression
Query expression
(Inherited from InfoObjectCollectionTInfo.)
Public propertyFieldsAsObjects
Related objects wrappers
(Inherited from InfoObjectCollectionTInfo.)
Public propertyFirstItem
Returns the first item of the collection
(Inherited from InfoObjectCollectionTInfo.)
Public propertyGUIDs
Collection of the object GUIDs
(Inherited from InfoObjectCollectionTInfo.)
Public propertyIDs
Collection of the object IDs
(Inherited from InfoObjectCollectionTInfo.)
Protected propertyInternalCount
Internal count of the items
(Inherited from InfoObjectCollectionTInfo.)
Public propertyIsCachedObject
If true, the object is cached within the system for later use
(Inherited from InfoObjectCollectionTInfo.)
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 InfoObjectCollectionTInfo.)
Public propertyIsOffline
Returns true, if the collection is offline (not backed up by the database but by the source data)
(Inherited from InfoObjectCollectionTInfo.)
Public propertyItemInt32
Gets or sets the object on specific index.
(Inherited from InfoObjectCollectionTInfo.)
Public propertyItemString
Returns the object registered by the specific name.
(Inherited from InfoObjectCollectionTInfo.)
Protected propertyItems
Returns the items collection.
(Inherited from InfoObjectCollectionTInfo.)
Public propertyItemsAsFields
Fields wrappers
(Inherited from InfoObjectCollectionTInfo.)
Public propertyItemsHaveNames
Returns true if the items in the collection have names
(Inherited from InfoObjectCollectionTInfo.)
Public propertyItemType
Result type
(Inherited from InfoObjectCollectionTInfo.)
Public propertyLastItem
Returns the last item of the collection
(Inherited from InfoObjectCollectionTInfo.)
Public propertyLoadBinaryData
Gets or sets the value which indicates whether to load binary data into the collections.
(Inherited from InfoObjectCollectionTInfo.)
Public propertyName
Collection name. Returns object type if name is not defined
(Inherited from InfoObjectCollectionTInfo.)
Public propertyNameColumn
Name column name
(Inherited from TreeNodeCollection.)
Protected propertyNewItems
Returns the items collection.
(Inherited from InfoObjectCollectionTInfo.)
Public propertyObject
Object instance of the specified type.
(Inherited from InfoObjectCollectionTInfo.)
Protected propertyObjectsByName
Objects by name collection.
(Inherited from InfoObjectCollectionTInfo.)
Public propertyObjectType
Returns the object type of the objects stored within the collection.
(Inherited from InfoObjectCollectionTInfo.)
Public propertyOrderByColumns
Order by expression.
(Inherited from InfoObjectCollectionTInfo.)
Public propertyPageSize
Page size for loading of the items.
(Inherited from InfoObjectCollectionTInfo.)
Public propertyParentDocument
Parent document.
(Inherited from TreeNodeCollection.)
Public propertyParentObject
Parent object. Instance of object which contains this collection as it's inner field.
(Inherited from InfoObjectCollectionTInfo.)
Public propertyParentStorage
Parent storage
(Inherited from InfoObjectCollectionTInfo.)
Public propertyProperties
Properties available through the context.
(Inherited from AbstractHierarchicalObjectTObject.)
Protected propertyPropertyList
Used property list
(Inherited from AbstractHierarchicalObjectTObject.)
Public propertyProvider
Query provider
(Inherited from InfoObjectCollectionTInfo.)
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 InfoObjectCollectionTInfo.)
Public propertySiteID
Site ID to filter the collection to a particular site
(Inherited from InfoObjectCollectionTInfo.)
Public propertySortNames
If true, the names in enumeration are sorted
(Inherited from InfoObjectCollectionTInfo.)
Public propertySourceData
Source data for the collection
(Inherited from InfoObjectCollectionTInfo.)
Public propertyTopN
Select top N objects.
(Inherited from InfoObjectCollectionTInfo.)
Public propertyTreeProvider
Tree provider instance used to access data. If no TreeProvider is assigned, a new TreeProvider instance is created.
(Inherited from TreeNodeCollection.)
Public propertyTypeInfo
Type info for the collection object.
(Inherited from InfoObjectCollectionTInfo.)
Public propertyUseDefaultCacheDependencies
If true, the collection uses default cache dependencies to flush it's content
(Inherited from InfoObjectCollectionTInfo.)
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 propertyUseObjectTypeCondition
If true, the collection uses the type condition to get the data
(Inherited from InfoObjectCollectionTInfo.)
Public propertyWhere
Where condition.
(Inherited from InfoObjectCollectionTInfo.)
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
Methods
  NameDescription
Public methodAdd(BaseInfo)
Adds new object to the collection.
(Inherited from InfoObjectCollectionTInfo.)
Public methodAdd(IEnumerableBaseInfo)
Adds new object to the collection.
(Inherited from InfoObjectCollectionTInfo.)
Public methodAddCacheDependencies
Adds the given list of cache dependencies to the collection
(Inherited from InfoObjectCollectionTInfo.)
Public methodAsTType
Makes a wrapper of the collection with specified type of the items.
(Inherited from InfoObjectCollectionTInfo.)
Protected methodCacheDependenciesChanged
Ensures the actions when the cache dependencies have changed
(Inherited from InfoObjectCollectionTInfo.)
Public methodChangeParent
Changes the parent of the collection
(Inherited from InfoObjectCollectionTInfo.)
Public methodClear
Clears the current items in the collection.
(Inherited from InfoObjectCollectionTInfo.)
Public methodClearCache
Clears the collection cache
(Inherited from InfoObjectCollectionTInfo.)
Public methodClone
Creates the clone of the collection.
(Inherited from TreeNodeCollection.)
Public methodCloneCollection
Creates the clone of this collection.
(Inherited from InfoObjectCollectionTInfo.)
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 InfoObjectCollectionTInfo.)
Public methodContainsColumn
Returns true if specified column is available in current structure.
(Inherited from AbstractDataContainerParentObjectType.)
Protected methodCopyPropertiesTo
Copies the properties of this collection to the other collection
(Inherited from TreeNodeCollection.)
Public methodCreateChild
Creates the child collection based on the given provider
(Inherited from InfoObjectCollectionTInfo.)
Public methodCreateNewObject
Creates new instance of the encapsulated object.
(Inherited from TreeNodeCollection.)
Protected methodCreateQueryProvider
Creates a LINQ query provider for this collection
(Inherited from InfoObjectCollectionTInfo.)
Public methodDisconnect
Disconnects the collection from the database
(Inherited from InfoObjectCollectionTInfo.)
Public methodDispose
Disposes the object
(Inherited from InfoObjectCollectionTInfo.)
Protected methodEnsureItems
Ensures the specified number of items in the item list.
(Inherited from InfoObjectCollectionTInfo.)
Protected methodEnsureObjectValues
Ensures the proper values for the given object
(Inherited from InfoObjectCollectionTInfo.)
Protected methodGetCacheDependencyKeys
Gets the list of cache dependency keys on which this collection depends
(Inherited from InfoObjectCollectionTInfo.)
Public methodGetCompleteWhereCondition
Gets the complete where condition for the collection
(Inherited from InfoObjectCollectionTInfo.)
Protected methodGetData
Gets the data for the collection.
(Inherited from TreeNodeCollection.)
Public methodGetEmptyObject
Gets an empty object for this collection
(Inherited from InfoObjectCollectionTInfo.)
Public methodGetEnumerator
Gets the strongly typed enumerator for the collection
Public methodGetEnumeratorInternal
Gets the enumerator for the collection.
(Inherited from InfoObjectCollectionTInfo.)
Public methodGetFieldsAsObjects(String)
Gets the collection of objects that are referenced by the given property
(Inherited from InfoObjectCollectionTInfo.)
Protected methodGetFieldsAsObjects(String, String)
Gets the collection of objects that are referenced by the given property
(Inherited from InfoObjectCollectionTInfo.)
Protected methodGetFullData
Gets the data set of the data behind this collection
(Inherited from InfoObjectCollectionTInfo.)
Protected methodGetItem
Gets the item on the specified index.
(Inherited from InfoObjectCollectionTInfo.)
Public methodGetItemsAsFields
Returns the updatable collection of fields of collection items
(Inherited from InfoObjectCollectionTInfo.)
Public methodGetNameWhereCondition
Gets the where condition for the given object name.
(Inherited from InfoObjectCollectionTInfo.)
Protected methodGetObjectByNameInternal
Gets the object by its name, internal representation that gets data from database
(Inherited from TreeNodeCollection.)
Public methodGetObjectName(Object)
Gets the unique object name from the given object.
(Inherited from InfoObjectCollectionTInfo.)
Public methodGetObjectName(TreeNode)
Gets the unique object name from the given object.
(Inherited from TreeNodeCollection.)
Public methodGetObjectToCheck
Gets an object for which to perform the permissions check.
(Inherited from InfoObjectCollectionTInfo.)
Public methodGetProperty
Gets the context property.
(Inherited from AbstractHierarchicalObjectTObject.)
Protected methodGetPropertyType
Gets the type of the given property
(Inherited from AbstractHierarchicalObjectTObject.)
Public methodGetSubsetOrderBy
Returns the clone of the collection with specified order by applied
(Inherited from InfoObjectCollectionTInfo.)
Public methodGetSubsetWhere
Returns the clone of the collection with specified where condition applied
(Inherited from InfoObjectCollectionTInfo.)
Public methodGetSubsetWhereNotEmpty
Returns the clone of the collection with specified column not being empty
(Inherited from InfoObjectCollectionTInfo.)
Public methodGetValue
Gets the object value.
(Inherited from AbstractSimpleDataContainerTObject.)
Public methodHasSetter
Returns true if given property has a setter
(Inherited from AbstractHierarchicalObjectTObject.)
Protected methodInit
Initializes the collection to use specific object type
(Inherited from InfoObjectCollectionTInfo.)
Public methodLoad
Clears the data in the collection and loads objects from the given list.
(Inherited from InfoObjectCollectionTInfo.)
Public methodMakeEmpty
Makes the collection empty.
(Inherited from InfoObjectCollectionTInfo.)
Public methodReconnect
Reconnects the collection to the database
(Inherited from InfoObjectCollectionTInfo.)
Protected methodRegisterClearCacheCallback
Registers the callback to clear the collection cache
(Inherited from InfoObjectCollectionTInfo.)
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.)
Public methodRegisterProperties(ListString)
Registers supported properties
(Inherited from InfoObjectCollectionTInfo.)
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(IEnumerableTInfo)
Removes the specified object from the collection.
(Inherited from InfoObjectCollectionTInfo.)
Public methodRemove(TInfo)
Removes the specified object from the collection.
(Inherited from InfoObjectCollectionTInfo.)
Protected methodRemoveClearCacheCallback
Removes the callback to clear the collection cache
(Inherited from InfoObjectCollectionTInfo.)
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 methodToString
Provides a string representation of the collection
(Inherited from InfoObjectCollectionTInfo.)
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 InfoObjectCollectionTInfo.)
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 InfoObjectCollectionTInfo.)
Top
Extension Methods
  NameDescription
Public Extension MethodBatchNodeType
Returns input in batches of batchSize size.
(Defined by BaseExtensions.)
Public Extension MethodToJSON
Returns JSON representation of current instance of IEnumerable.
(Defined by DataExtensions.)
Public Extension MethodToXML
Returns XML representation of current instance of IEnumerable.
(Defined by DataExtensions.)
Top
See Also