Click or drag to resize
PrefetchPath Class
PrefetchPath class, which specifies a prefetch path to fetch related entities during a fetch. SelfServicing specific.
Inheritance Hierarchy
SystemObject
  System.CollectionsCollectionBase
    SD.LLBLGen.Pro.ORMSupportClassesPrefetchPath

Namespace: SD.LLBLGen.Pro.ORMSupportClasses
Assembly: SD.LLBLGen.Pro.ORMSupportClasses (in SD.LLBLGen.Pro.ORMSupportClasses.dll) Version: 5.0.0.0 (5.0.0)
Syntax
[SerializableAttribute]
public class PrefetchPath : CollectionBase, 
	IPrefetchPath, IPrefetchPathCore, IEnumerable

The PrefetchPath type exposes the following members.

Constructors
  NameDescription
Public methodPrefetchPath(Enum)
CTor
Public methodPrefetchPath(Int32)
CTor
Top
Properties
  NameDescription
Public propertyCapacity
Gets or sets the number of elements that the CollectionBase can contain.
(Inherited from CollectionBase.)
Public propertyCount
Gets the number of elements contained in the CollectionBase instance. This property cannot be overridden.
(Inherited from CollectionBase.)
Protected propertyInnerList
Gets an ArrayList containing the list of elements in the CollectionBase instance.
(Inherited from CollectionBase.)
Public propertyItem
Indexer in the prefetch path
Protected propertyList
Gets an IList containing the list of elements in the CollectionBase instance.
(Inherited from CollectionBase.)
Public propertyRootEntityType
The EntityType enum value for the entity which is the root type of this path.
Top
Methods
  NameDescription
Public methodAdd(IPrefetchPathElement)
Adds the specified element to the path.
Public methodAdd(IPrefetchPathElement, ExcludeIncludeFieldsList)
Adds the specified element to the path.
Public methodAdd(IPrefetchPathElement, Int32)
Adds the specified element to the path.
Public methodAdd(IPrefetchPathElement, Int32, IPredicateExpression)
Adds the specified element to the path.
Public methodAdd(IPrefetchPathElement, Int32, IPredicateExpression, IRelationCollection)
Adds the specified element to the path.
Public methodAdd(IPrefetchPathElement, Int32, IPredicateExpression, IRelationCollection, ISortExpression)
Adds the specified element to the path.
Public methodAdd(IPrefetchPathElement, Int32, IPredicateExpression, IRelationCollection, ISortExpression, ExcludeIncludeFieldsList)
Adds the specified element to the path.
Public methodClear
Removes all objects from the CollectionBase instance. This method cannot be overridden.
(Inherited from CollectionBase.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetEnumerator
Returns an enumerator that iterates through the CollectionBase instance.
(Inherited from CollectionBase.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnClear
Performs additional custom processes when clearing the contents of the CollectionBase instance.
(Inherited from CollectionBase.)
Protected methodOnClearComplete
Performs additional custom processes after clearing the contents of the CollectionBase instance.
(Inherited from CollectionBase.)
Protected methodOnInsert
Performs additional custom processes before inserting a new element into the CollectionBase instance.
(Inherited from CollectionBase.)
Protected methodOnInsertComplete
Performs additional custom processes after inserting a new element into the CollectionBase instance.
(Inherited from CollectionBase.)
Protected methodOnRemove
Performs additional custom processes when removing an element from the CollectionBase instance.
(Inherited from CollectionBase.)
Protected methodOnRemoveComplete
Performs additional custom processes after removing an element from the CollectionBase instance.
(Inherited from CollectionBase.)
Protected methodOnSet
Performs additional custom processes before setting a value in the CollectionBase instance.
(Inherited from CollectionBase.)
Protected methodOnSetComplete
Performs additional custom processes after setting a value in the CollectionBase instance.
(Inherited from CollectionBase.)
Protected methodOnValidate
Performs additional custom processes when validating a value.
(Inherited from CollectionBase.)
Public methodRemoveAt
Removes the element at the specified index of the CollectionBase instance. This method is not overridable.
(Inherited from CollectionBase.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Fields
  NameDescription
Public fieldStatic memberUseRootMaxLimitAndSorterInPrefetchPathSubQueriesDefault
The default value for the 'UseRootMaxLimitAndSorterInPrefetchPathSubQueries' flag. This is also a configurable setting in the config file: add a line to the config file's appSettings section: useRootMaxLimitAndSorterInPrefetchPathSubQueries and specify a value of true or false. Default is false.
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implementationPrivate methodIEnumerableGetEnumerator
Returns an enumerator that iterates through the CollectionBase instance.
Explicit interface implementationPrivate methodIListAdd
Adds an object to the end of the CollectionBase.
(Inherited from CollectionBase.)
Explicit interface implementationPrivate methodIListContains
Determines whether the CollectionBase contains a specific element.
(Inherited from CollectionBase.)
Explicit interface implementationPrivate methodICollectionCopyTo
Copies the entire CollectionBase to a compatible one-dimensional Array, starting at the specified index of the target array.
(Inherited from CollectionBase.)
Explicit interface implementationPrivate methodIListIndexOf
Searches for the specified Object and returns the zero-based index of the first occurrence within the entire CollectionBase.
(Inherited from CollectionBase.)
Explicit interface implementationPrivate methodIListInsert
Inserts an element into the CollectionBase at the specified index.
(Inherited from CollectionBase.)
Explicit interface implementationPrivate propertyIPrefetchPathCoreItem
Indexer in the prefetch path
Explicit interface implementationPrivate propertyIListIsFixedSize
Gets a value indicating whether the CollectionBase has a fixed size.
(Inherited from CollectionBase.)
Explicit interface implementationPrivate propertyIListIsReadOnly
Gets a value indicating whether the CollectionBase is read-only.
(Inherited from CollectionBase.)
Explicit interface implementationPrivate propertyICollectionIsSynchronized
Gets a value indicating whether access to the CollectionBase is synchronized (thread safe).
(Inherited from CollectionBase.)
Explicit interface implementationPrivate propertyIListItem
Gets or sets the element at the specified index.
(Inherited from CollectionBase.)
Explicit interface implementationPrivate methodIListRemove
Removes the first occurrence of a specific object from the CollectionBase.
(Inherited from CollectionBase.)
Explicit interface implementationPrivate propertyICollectionSyncRoot
Gets an object that can be used to synchronize access to the CollectionBase.
(Inherited from CollectionBase.)
Top
See Also