IPageCreationRule Interface

Defines the criteria for creating a new Page, including Schema, location, and limitations on Groups and Users.

Page creation rules provide a controlled way to create pages; their main purpose is to enforce restrictions on page creation for nonadministrative users.

Because they provide ways to limit page creation locations, they can also be a used as shortcuts for creating pages quickly.

In addition, page creation rules can add newly created pages directly into workflows.

Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.308

Syntax

C++

Copy

public interface IPageCreationRule : IEntity<IPageCreationRulesManager>, 
	IEntity, IEntityEvents

Public Interface IPageCreationRule
	Inherits IEntity(Of IPageCreationRulesManager), IEntity, IEntityEvents

public interface class IPageCreationRule : IEntity<IPageCreationRulesManager^>, 
	IEntity, IEntityEvents

type IPageCreationRule =  
    interface
        interface IEntity<IPageCreationRulesManager>
        interface IEntity
        interface IEntityEvents
    end

The IPageCreationRule type exposes the following members.

Properties

	Name	Description
	Archived	Gets/sets the archived value of this entity (Inherited from IEntity.)
	AutoSelectParent	Gets and sets whether this page creation rule allows the currently selected Page to be used as a parent page for page creation. This property doesn't serve any purpose on the API level. It provides a suggestive value in the user interface layer.
	Created	Gets the entity's creation date. (Inherited from IEntity.)
	CreationUser	Gets the ID of the User who created this entity. (Inherited from IEntity.)
	Description	Gets and sets the description of the PCR
	IsDefault	Gets and sets whether this page creation rule is the default rule when more than one PCR is allowed for a given Group.
	LastModified	Gets the date when the entity was most recently modified. (Inherited from IEntity.)
	LastModifiedUser	Gets the ID of the User who lasted edited the entity. (Inherited from IEntity.)
	Manager	Gets the manager that retrieved this entity instance. (Inherited from IEntityTManager.)
	Schema	Gets and sets the Schema that used to create Pages.
	Session	Gets the session that retrieved this entity. An entity is always session-specific. (Inherited from IEntity.)
	SessionId	Gets the unique ID of the session that retrieved this entity. (Inherited from IEntity.)
	StyleSheet	Gets and sets the overriding XSLT style sheet for this page creation rule.
	WorkFlowDefinition	Gets and sets the Workflow Definition to which this page creation rule is connected. Pages created via this page creation rule are automatically added to the specified Workflow.

Top

Methods

	Name	Description
	AddGroup	Adds a new Group to the allowed groups that can use this page creation rule.
	AddUser	Adds a new User to the list of users explicitly allowed to use this page creation rule.
	AllowPageCreation	Checks whether the specified User is allowed to use this page creation rulee to create Pages.
	ClearUsersAndGroups	Removes all users and groups that are allowed to use this page creation rule to create pages. This renders the page creation rule unusable.
	FirstAccessibleParentPage	Retrieves the first parent Page under which this page creation rule can be used to create pages and to which the current User has Full Access.
	GetParentAccess	Returns whether the page contains a user or group that has FULL_ACCESS to a parent page/>
	Groups	Retrieves the collection of Groups that are allowed to use this page creation rule to create Pages.
	GroupsCount	Gets the count of allowed Groups.
	IsGroupAllowed(String)	Returns if the passed in group ID is allowed to use the current
	IsGroupAllowed(IUserGroup)	Returns if the passed in IUserGroup is allowed to use the current
	IsUserAllowed(String)	Returns if the passed in user ID is allowed to use the current
	IsUserAllowed(IUser)	Returns if the passed in IUser is allowed to use the current
	ParentPages	Retrieves the collection of parent Pages under which the page creation rule is allowed to create pages.
	ParentPagesCount	Gets the count of parent page entries for this page creation rule.
	RemoveGroup	Removes a Group from the list of group explicitly allowed to use this page creation rule.
	RemoveParentPage	Removes a parent Page from the parent pages collection
	RemoveUser	Removes a User from the list of users explicitly allowed to use this page creation rule.
	SetParentPage	Sets a Page as parent page of this page creation rule.
	Touch	Updated the entity's LastModified value to the current time. (Inherited from IEntity.)
	UnassociateWorkflowDefinition	Removes the Workflow Definition from this page creation rule.
	Users	Retrieves the collection of explicitly defined Users that can use this page creation rule to create Pages.
	UsersCount	Gets the count of explicitly allowed Users.
	ValidateData	Validates this entity's data. Implemented by concrete inheriting types. (Inherited from IEntity.)
	ValidateUserPermission	Validates the user permission on the current entity. Implemented by concrete inheriting types. It is called automatically upon saving an entity. (Inherited from IEntity.)

Top

Events

	Name	Description
	AfterEntitySave	This event is fired after a Entity object is saved. (Inherited from IEntityEvents.)
	BeforeEntitySave	This event is fired before any Entity object is about to be saved. (Inherited from IEntityEvents.)

Top

Remarks

Page creation rule instances are managed by PageCreationRulesManager.

Examples

Example of serialization output:

XML

Copy

<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>

Reference

Ingeniux.CMS Namespace

Ingeniux.CMSIPageCreationRulesManager