DocumentRepository MembersKentico 8.1 API Reference
The DocumentRepository type exposes the following members.
Constructors

  NameDescription
Public methodDocumentRepository 
Constructor.
Public methodDocumentRepository(String)
Constructor.
Public methodDocumentRepository(TreeNode)
Constructor.
Back to Top
Methods

  NameDescription
Public methodAddCollection
Registers the given collection of objects within the repository.
Public methodDisconnect
Disconnects the collections from the database
(Inherited from ObjectRepository TCollection, TObject, TSettings .)
Public methodOnlineEquals
Determines whether the specified OnlineObject is equal to the current OnlineObject.
(Inherited from OnlineObject.)
Protected methodOnlineFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from OnlineObject.)
Protected methodGetCollection
Returns the collection of objects indexed by object type, e.g. "cms.user".
(Inherited from ObjectRepository TCollection, TObject, TSettings .)
Public methodGetEnumerator
Gets the enumerator for the collection.
(Inherited from ObjectRepository TCollection, TObject, TSettings .)
Public methodOnlineGetHashCode
Serves as a hash function for a particular type.
(Inherited from OnlineObject.)
Public methodGetNicePropertyName
Gets the property name for the original name of the collection
(Inherited from ObjectRepository TCollection, TObject, TSettings .)
Public methodGetObjectName
Returns the name of the given object
(Inherited from ObjectRepository TCollection, TObject, TSettings .)
Public methodGetProperty
Gets the property value.
(Inherited from ObjectRepository TCollection, TObject, TSettings .)
Protected methodGetRootDocument
Gets the root document from the database.
Public methodOnlineGetType
Gets the OnlineType of the current instance.
(Inherited from OnlineObject.)
Protected methodLoadCollection
Loads the given collection.
(Overrides ObjectRepository TCollection, TObject, TSettings  LoadCollection(TSettings).)
Protected methodOnlineMemberwiseClone
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
Public methodNewCollection
Creates new collection for the data.
(Overrides ObjectRepository TCollection, TObject, TSettings  NewCollection(String).)
Public methodNewCombinedCollection
Creates new combined collection for the data.
(Overrides ObjectRepository TCollection, TObject, TSettings  NewCombinedCollection .)
Public methodReconnect
Reconnects the collection to the database
(Inherited from ObjectRepository TCollection, TObject, TSettings .)
Protected methodRegisterNiceName
Registers the nice name of the collection
(Inherited from ObjectRepository TCollection, TObject, TSettings .)
Public methodOnlineToString
Returns a string that represents the current object.
(Inherited from OnlineObject.)
Public methodTryGetProperty
Returns value of property.
(Inherited from ObjectRepository TCollection, TObject, TSettings .)
Back to 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 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 MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Back to Top
Fields

  NameDescription
Protected fieldmAll
Collection of all underlying objects.
(Inherited from ObjectRepository TCollection, TObject, TSettings .)
Protected fieldmCollections
Table of collections [name -> CollectionType]
(Inherited from ObjectRepository TCollection, TObject, TSettings .)
Protected fieldmCollectionSettings
Table of collection settings [name -> InfoCollectionSettings]
(Inherited from ObjectRepository TCollection, TObject, TSettings .)
Protected fieldmCollectionSettingsByIndex
Table of collection settings by index [index -> InfoCollectionSettings]
(Inherited from ObjectRepository TCollection, TObject, TSettings .)
Protected fieldmCollectionsList
List of all collections (sorted by the order in which the collections were added).
(Inherited from ObjectRepository TCollection, TObject, TSettings .)
Protected fieldmCount
Number of the inner collections.
(Inherited from ObjectRepository TCollection, TObject, TSettings .)
Protected fieldmDisconnectedCount
Number of disconnected references for this collection
(Inherited from ObjectRepository TCollection, TObject, TSettings .)
Protected fieldmDynamicNames
List of dynamic names of the collections
(Inherited from ObjectRepository TCollection, TObject, TSettings .)
Protected fieldmIsLastVersion
If true, the document is the last version (retrieved using DocumentHelper.GetDocument).
Protected fieldmLoadBinaryData
Indicates whether to load binary data into the collections of the repository.
(Inherited from ObjectRepository TCollection, TObject, TSettings .)
Protected fieldmNiceNames
Translation of collection nice names to a normal names [niceName -> name]
(Inherited from ObjectRepository TCollection, TObject, TSettings .)
Protected fieldmProperties
Properties of the object available through GetProperty.
(Inherited from ObjectRepository TCollection, TObject, TSettings .)
Protected fieldmRootDocument
Root document.
Protected fieldmSiteName
Site name.
Protected fieldmTreeProvider
Tree provider object to use for the database access.
Back to Top
Properties

  NameDescription
Public propertyAll
All items from all underlying collections.
(Inherited from ObjectRepository TCollection, TObject, TSettings .)
Public propertyAllowNiceNames
If true, the repository allows nice names of the collections, e.g. for "CMS.User" uses "Users"
(Inherited from ObjectRepository TCollection, TObject, TSettings .)
Public propertyCollectionNames
Returns list of collection names in the repository.
(Inherited from ObjectRepository TCollection, TObject, TSettings .)
Public propertyCount
Returns the number of items.
(Inherited from ObjectRepository TCollection, TObject, TSettings .)
Public propertyDynamicNames
List of the dynamic names of the collections
(Inherited from ObjectRepository TCollection, TObject, TSettings .)
Public propertyGetDynamicNames
Function that provides the dynamic names of collections to the repository
(Inherited from ObjectRepository TCollection, TObject, TSettings .)
Public propertyIsCachedObject
If true, the object is cached within the system for later use
(Inherited from ObjectRepository TCollection, TObject, TSettings .)
Public propertyIsDisconnected
Returns true if the repository is disconnected from the data source
(Overrides ObjectRepository TCollection, TObject, TSettings  IsDisconnected.)
Public propertyIsLastVersion
If true, the document is the last version (retrieved using DocumentHelper.GetDocument).
Public propertyItem Int32 
Returns the collection of objects.
(Inherited from ObjectRepository TCollection, TObject, TSettings .)
Public propertyItem String 
Returns the collection of objects indexed by object type, e.g. "cms.user".
(Inherited from ObjectRepository TCollection, TObject, TSettings .)
Public propertyItemsHaveNames
Returns true if the items in the collection have names
(Inherited from ObjectRepository TCollection, TObject, TSettings .)
Public propertyLoadBinaryData
Gets or sets the value which indicates whether to load binary data into the collections.
(Inherited from ObjectRepository TCollection, TObject, TSettings .)
Public propertyParentDocument
Parent document.
Public propertyParentStorage
Parent storage
(Inherited from ObjectRepository TCollection, TObject, TSettings .)
Public propertyProperties
Properties of the object available through GetProperty.
(Inherited from ObjectRepository TCollection, TObject, TSettings .)
Public propertyRootDocument
Root document.
Public propertySiteName
Site name.
Public propertySortNames
If true, the names in enumeration are sorted
(Inherited from ObjectRepository TCollection, TObject, TSettings .)
Public propertyTreeProvider
Tree provider instance used to access data. If no TreeProvider is assigned, a new TreeProvider instance is created.
Back to Top
Events

  NameDescription
Public eventOnLoadCollection
Fires when the collection with specified name is requested.
(Inherited from ObjectRepository TCollection, TObject, TSettings .)
Back to Top
See Also