ISite.CrossLocaleCopyPage Method

ISiteCrossLocaleCopyPage Method

Ingeniux CMS Content Store API

Copies a Page with language settings, together with its descendants, to another location of a Page with language settings, when there is a Lingual Map established between the Region Roots of both Pages .

This method will create a collection of Lingual Maps from the source Page and its descendants, to their corresponding clone Pages.

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

Syntax

C++

Copy

IEnumerable<ILingualPageMap> CrossLocaleCopyPage(
	IPage page,
	IPage parent,
	EnumCopyActions placing,
	bool ignoreExistingMaps = false
)

Function CrossLocaleCopyPage ( 
	page As IPage,
	parent As IPage,
	placing As EnumCopyActions,
	Optional ignoreExistingMaps As Boolean = false
) As IEnumerable(Of ILingualPageMap)

IEnumerable<ILingualPageMap^>^ CrossLocaleCopyPage(
	IPage^ page, 
	IPage^ parent, 
	EnumCopyActions placing, 
	bool ignoreExistingMaps = false
)

abstract CrossLocaleCopyPage : 
        page : IPage * 
        parent : IPage * 
        placing : EnumCopyActions * 
        ?ignoreExistingMaps : bool 
(* Defaults:
        let _ignoreExistingMaps = defaultArg ignoreExistingMaps false
*)
-> IEnumerable<ILingualPageMap>

Parameters

page: Type: Ingeniux.CMSIPage
The Page to be copied
parent: Type: Ingeniux.CMSIPage
The target location
placing: Type: Ingeniux.CMS.EnumsEnumCopyActions
The location to place the copied Pages relative to the "parent"
ignoreExistingMaps (Optional): Type: SystemBoolean
Whether to ignore any existing Lingual Map of the source Page that was already mapped to to the "parent"'s Locale. If true, system will remove the existing map silently before creating a new one. If not, a error will be thrown.

Return Value

Type: IEnumerableILingualPageMap
The new Lingual Map between the source Page and its copied Page at target location

Exceptions

Exception	Condition
ArgumentNullException	When the parameter "page" or "parentPage" is null, or "parentPage" being Root of the Site, and the "placing" is to a sibling position.
ArgumentException	When "page" or "parentPage" doesn't have valid Hierarchy value.
InvalidOperationException	When "page" is either Root Page or Recycle Folder; Or when the Region Roots of "page" and "parentPage" don't have established Lingual Map yet.
SecurityException	When Operating User doesn't have the necessary node-level permssions. The Operating User must have at least read-only permission on "page", and full access on the actual target parent Page.

Remarks

This method is for strictly copying Pages between lingual sections that already have their Region Roots mapped. Failure to meet this condition will generate errors.

When "ignoreExistingMaps" is true, system to silently remove any Lingual Map that source Page has at target Locale.

When "ignoreExistingMaps" is false, error will be thrown.

Four events are fired in the following order: BeforeCrossLocaleCopy, BeforePageCopy, AfterPageCopy, and AfterCrossLocaleCopy.

Reference

ISite Interface

Ingeniux.CMS Namespace

ISiteCopyRegionRootPage(IPage, IPage, EnumCopyActions, ILocale)

ISiteCopyPage(IPage, IPage, EnumCopyActions)