ISiteRemovePage Method Ingeniux CMS Content Store API

Removes a single Page.

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

bool RemovePage(
	ref IPage page
)

Parameters

page
Type: Ingeniux.CMSIPage
The page to remove/purge

Return Value

Type: Boolean
True if Page exists, false otherwise.
Exceptions

ExceptionCondition
InvalidOperationExceptionWhen trrying to remove Site Root or Recycle Folder; or trying to remove a Page assigned to another User, but doesn't have the right to Assign other's Pages.
SecurityExceptionWhen Operating User doesn't have the right to Delete Pages, or doens't have full access to the Page to be removed.
Remarks

if "page" is null, returns false.

If the Page is not under Recycle Folder, it will be moved to Recycle Folder. If it is already under Recycle Folder, it will be permenantly purged.

Two events are fired during execution of this method: BeforePageDelete and AfterPageDelete.

See Also

Reference