Click or drag to resize

IPageCreationRulesManager Interface
Represents the manager object that provides the means to query and manage Page Creation Rules.

Namespace:  Ingeniux.CMS
Assembly:  Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.3.169
Syntax
Copy
public interface IPageCreationRulesManager : ITransactionalEntity, 
	IDisposable

The IPageCreationRulesManager type exposes the following members.

Properties
  NameDescription
Public propertyContentStore
Gets the Content Store.
(Inherited from ITransactionalEntity.)
Public propertyCurrentUser
Gets the Operating User for the Session .
(Inherited from ITransactionalEntity.)
Public propertySession
Gets the User Session that this manager instance was initiated from.
(Inherited from ITransactionalEntity.)
Top
Methods
  NameDescription
Public methodAddPageCreationRule
Creates a new PageCreationRule.
Public methodCount
Gets the count of all Page Creation Rules
Public methodDeepCloneT, TManager
Duplicates an object instance, not including its unique ID.
(Inherited from ITransactionalEntity.)
Public methodPageCreationRule
Retrieves a Page Creation Rule by its unique ID.
Public methodPageCreationRules(String)
Retrieves a collection of Page Creation Rules by their unique IDs.
Public methodPageCreationRules(Int32, Int32, Int32)
Retrieves the collection of all Page Creation Rules.
Public methodPageCreationRules(Int32, ISchema, Int32, Int32)
Retrieves the collection of Page Creation Rules that are based on the specified Schema.
Public methodPageCreationRules(Int32, IUser, Int32, Int32)
Retrieves the collection of Page Creation Rules that can be used by the specified User.
Public methodPageCreationRules(Int32, IUserGroup, Int32, Int32)
Retrieves the collection of Page Creation Rules that can be used by the the specified Group.
Public methodQuickWrite
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.)
Public methodRemovePageCreationRule
Permenantly removes a Page Creation Rule from the collection.
Top
Remarks

Like all manager objects, instances of this manager are retrieved from an IUserSession object and only work within that session.

C#
Copy
using (IUserSession session = store.OpenReadSession(currentUser))
{
       IPageCreationRulesManager pcrManager = session.PageCreationRulesManager;
       ...
}
Examples

Serialization of the Page Creation Rules Manager matches the serialization of pagecreationrules.xml in previous-generation CMS content:

XML
Copy
<?xml version="1.0" encoding="utf-16" standalone="no"?>
<PageCreationRules NextID="10">
  <PageCreationRule Name="Create an Image" ID="6" Icon="PageCreationRules/211" IsDefault="false" Schema="Image" StyleSheetFileName="" wfid="">
    <Users/>
    <Groups>
      <Group ID="UserGroups/54"/>
      <Group ID="UserGroups/1"/>
    </Groups>
  </PageCreationRule>
  <PageCreationRule Name="Create an Event" ID="PageCreationRules/232" Icon="16" IsDefault="false" Schema="Event Detail" StyleSheetFileName="default.xsl" wfid="">
    <Users>
      <User ID="ingeniux\admin1"/>
      <User ID="ingeniux\author2"/>
    </Users>
    <Groups>
      <Group ID="UserGroups/234"/>
      <Group ID="UserGroups/42"/>
      <Group ID="UserGroups/1"/>
    </Groups>
  </PageCreationRule>
</PageCreationRules>
See Also