DocumentRepository Class

Repository of the documents without workflow support.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.ObjectRepository<TreeNodeCollection, TreeNode, TreeNodeCollectionSettings>
    CMS.DocumentEngine.DocumentRepository

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

Syntax

public class DocumentRepository : ObjectRepository<TreeNodeCollection, TreeNode, TreeNodeCollectionSettings>, 
	ICMSStorage

The DocumentRepository type exposes the following members.

Constructors

	Name	Description
Public method	DocumentRepository()	Constructor.
Public method	DocumentRepository(String)	Constructor.
Public method	DocumentRepository(TreeNode)	Constructor.

Methods

	Name	Description
Public method	AddCollection	Registers the given collection of objects within the repository.
Public method	Disconnect	Disconnects the collections from the database (Inherited from ObjectRepository<TCollection, TObject, TSettings>.)
Protected method	GetCollection	Returns the collection of objects indexed by object type, e.g. "cms.user". (Inherited from ObjectRepository<TCollection, TObject, TSettings>.)
Public method	GetEnumerator	Gets the enumerator for the collection. (Inherited from ObjectRepository<TCollection, TObject, TSettings>.)
Public method	GetNicePropertyName	Gets the property name for the original name of the collection (Inherited from ObjectRepository<TCollection, TObject, TSettings>.)
Public method	GetObjectName	Returns the name of the given object (Inherited from ObjectRepository<TCollection, TObject, TSettings>.)
Public method	GetProperty	Gets the property value. (Inherited from ObjectRepository<TCollection, TObject, TSettings>.)
Protected method	GetRootDocument	Gets the root document from the database.
Protected method	LoadCollection	Loads the given collection. (Overrides ObjectRepository<TCollection, TObject, TSettings>.LoadCollection(TSettings).)
Public method	NewCollection	Creates new collection for the data. (Overrides ObjectRepository<TCollection, TObject, TSettings>.NewCollection(String).)
Public method	NewCombinedCollection	Creates new combined collection for the data. (Overrides ObjectRepository<TCollection, TObject, TSettings>.NewCombinedCollection().)
Public method	Reconnect	Reconnects the collection to the database (Inherited from ObjectRepository<TCollection, TObject, TSettings>.)
Protected method	RegisterNiceName	Registers the nice name of the collection (Inherited from ObjectRepository<TCollection, TObject, TSettings>.)
Public method	TryGetProperty	Returns value of property. (Inherited from ObjectRepository<TCollection, TObject, TSettings>.)

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

	Name	Description
Protected field	mAll	Collection of all underlying objects. (Inherited from ObjectRepository<TCollection, TObject, TSettings>.)
Protected field	mCollections	Table of collections [name -> CollectionType] (Inherited from ObjectRepository<TCollection, TObject, TSettings>.)
Protected field	mCollectionSettings	Table of collection settings [name -> InfoCollectionSettings] (Inherited from ObjectRepository<TCollection, TObject, TSettings>.)
Protected field	mCollectionSettingsByIndex	Table of collection settings by index [index -> InfoCollectionSettings] (Inherited from ObjectRepository<TCollection, TObject, TSettings>.)
Protected field	mCollectionsList	List of all collections (sorted by the order in which the collections were added). (Inherited from ObjectRepository<TCollection, TObject, TSettings>.)
Protected field	mCount	Number of the inner collections. (Inherited from ObjectRepository<TCollection, TObject, TSettings>.)
Protected field	mDisconnectedCount	Number of disconnected references for this collection (Inherited from ObjectRepository<TCollection, TObject, TSettings>.)
Protected field	mDynamicNames	List of dynamic names of the collections (Inherited from ObjectRepository<TCollection, TObject, TSettings>.)
Protected field	mIsLastVersion	If true, the document is the last version (retrieved using DocumentHelper.GetDocument).
Protected field	mLoadBinaryData	Indicates whether to load binary data into the collections of the repository. (Inherited from ObjectRepository<TCollection, TObject, TSettings>.)
Protected field	mNiceNames	Translation of collection nice names to a normal names [niceName -> name] (Inherited from ObjectRepository<TCollection, TObject, TSettings>.)
Protected field	mProperties	Properties of the object available through GetProperty. (Inherited from ObjectRepository<TCollection, TObject, TSettings>.)
Protected field	mRootDocument	Root document.
Protected field	mSiteName	Site name.
Protected field	mTreeProvider	Tree provider object to use for the database access.

Properties

	Name	Description
Public property	All	All items from all underlying collections. (Inherited from ObjectRepository<TCollection, TObject, TSettings>.)
Public property	AllowNiceNames	If true, the repository allows nice names of the collections, e.g. for "CMS.User" uses "Users" (Inherited from ObjectRepository<TCollection, TObject, TSettings>.)
Public property	CollectionNames	Returns list of collection names in the repository. (Inherited from ObjectRepository<TCollection, TObject, TSettings>.)
Public property	Count	Returns the number of items. (Inherited from ObjectRepository<TCollection, TObject, TSettings>.)
Public property	DynamicNames	List of the dynamic names of the collections (Inherited from ObjectRepository<TCollection, TObject, TSettings>.)
Public property	GetDynamicNames	Function that provides the dynamic names of collections to the repository (Inherited from ObjectRepository<TCollection, TObject, TSettings>.)
Public property	IsCachedObject	If true, the object is cached within the system for later use (Inherited from ObjectRepository<TCollection, TObject, TSettings>.)
Public property	IsDisconnected	Returns true if the repository is disconnected from the data source (Overrides ObjectRepository<TCollection, TObject, TSettings>.IsDisconnected.)
Public property	IsLastVersion	If true, the document is the last version (retrieved using DocumentHelper.GetDocument).
Public property	Item[Int32]	Returns the collection of objects. (Inherited from ObjectRepository<TCollection, TObject, TSettings>.)
Public property	Item[String]	Returns the collection of objects indexed by object type, e.g. "cms.user". (Inherited from ObjectRepository<TCollection, TObject, TSettings>.)
Public property	ItemsHaveNames	Returns true if the items in the collection have names (Inherited from ObjectRepository<TCollection, TObject, TSettings>.)
Public property	LoadBinaryData	Gets or sets the value which indicates whether to load binary data into the collections. (Inherited from ObjectRepository<TCollection, TObject, TSettings>.)
Public property	ParentDocument	Parent document.
Public property	ParentStorage	Parent storage (Inherited from ObjectRepository<TCollection, TObject, TSettings>.)
Public property	Properties	Properties of the object available through GetProperty. (Inherited from ObjectRepository<TCollection, TObject, TSettings>.)
Public property	RootDocument	Root document.
Public property	SiteName	Site name.
Public property	SortNames	If true, the names in enumeration are sorted (Inherited from ObjectRepository<TCollection, TObject, TSettings>.)
Public property	TreeProvider	Tree provider instance used to access data. If no TreeProvider is assigned, a new TreeProvider instance is created.

Events

	Name	Description
Public event	OnLoadCollection	Fires when the collection with specified name is requested. (Inherited from ObjectRepository<TCollection, TObject, TSettings>.)