ISite.CopyPage Method

ISiteCopyPage Method

Ingeniux CMS Content Store API

Copies a Page together with its descendants, to the specified location.

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

Syntax

IPage CopyPage(
	IPage srcPage,
	IPage tgtParentPage,
	EnumCopyActions placing
)

Function CopyPage ( 
	srcPage As IPage,
	tgtParentPage As IPage,
	placing As EnumCopyActions
) As IPage

IPage^ CopyPage(
	IPage^ srcPage, 
	IPage^ tgtParentPage, 
	EnumCopyActions placing
)

abstract CopyPage : 
        srcPage : IPage * 
        tgtParentPage : IPage * 
        placing : EnumCopyActions -> IPage

srcPage: Type: Ingeniux.CMSIPage
The Page to be copied
tgtParentPage: Type: Ingeniux.CMSIPage
The target reference location Page. The copied Page could be placed before, after, or as child of this Page.
placing: Type: Ingeniux.CMS.EnumsEnumCopyActions
The location to place the copied Pages relative to the "targetParentPage"

Type: IPage
The copied Pages

Exceptions

Exception	Condition
ArgumentNullException	When the parameter "srcPage" or "tgtParentPage" is null, or "tgtParentPage" being Root of the Site, and the "placing" is to a sibling position.
ArgumentException	When "srcPage" or "tgtParentPage" doesn't have valid Hierarchy value.
InvalidOperationException	When "srcPagg" is either Root Page or Recycle Folder.
SecurityException	When Operating User doesn't have the necessary node-level permssions. The Operating User must have at least read-only permission on "srcPage", and full access on the actual target parent Page.

Remarks

Two events are fired during execution of this method: BeforePageCopy and AfterPageCopy.