Represents the manager object that provides a means to query and manage the Page cross references collection.
The references system provides a different way to relate pages Pages in a nonorganized way.
To relate pages in an organized way, the Taxonomy System is recommended solution.
Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 9.0.565.0 (9.0.565)
Syntax
The IReferencesManager type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | ContentStore |
Gets the Content Store.
(Inherited from ITransactionalEntity.) |
| CurrentUser |
Gets the Operating User for the Session .
(Inherited from ITransactionalEntity.) |
| Session |
Gets the User Session that this manager instance was initiated from.
(Inherited from ITransactionalEntity.) |
Methods
| Name | Description | |
|---|---|---|
 | AddReference |
Adds a new reference between two Pages.
|
| Count |
Gets the count of all Reference Entries stored on all Pages.
|
| DeepCloneT, TManager |
Duplicates an object instance, not including its unique ID.
(Inherited from ITransactionalEntity.) |
| Get |
Retrieves all References of the specified Page.
This method can query recursively on references of referenced pages, with or without crossreferences.
|
| QuickWrite |
Creates a temporary Write Session to quickly write something outside the current Session and transaction.
This is a way to bypass the transaction and quickly put something into the content store.
(Inherited from ITransactionalEntity.) |
| RemoveReference(IPage, IPage) | |
| RemoveReference(IPage, String) | |
| RemoveReferences |
Removes References from and/or to the specified Page.
|
Remarks
Like all manager objects, instances of this manager are retrieved from an IUserSession object, and it only works within that session.
C#
using (IUserSession session = store.OpenReadSession(currentUser))
{
IReferencesManager referencesManager = session.ReferencesManager;
...
}Examples
<?xml version="1.0" encoding="UTF-8"?> <ReferencesMapping LastUpdatedUser="ingeniux\admin1" LastUpdated="20140714T11:24:50"> <Definitions> <Definition Description="The Reference" FullName="Reference" TagName="R" /> <Definition Description="The source page XID" FullName="SourcePage" TagName="S" /> <Definition Description="The target page XID" FullName="TargetPage" TagName="T" /> <Definition Description="Last Updated Date" FullName="LastUpdatedDate" TagName="LUD" /> <Definition Description="Last Update User" FullName="LastUpdateUser" TagName="LUU" /> </Definitions> <References> <R S="x123" T="x345" LUU="ingeniux\admin2" LUD="20140714T10.24:01" /> <R S="x6789" T="1011" LUU="ingeniux\admin3" LUD="20140714T10.41:43" /> </References> </ReferencesMapping>
See Also