Interface ISavePage
Interface for the save handler used to save a page.
Namespace: EPiServer.Web.PageExtensions
Assembly: EPiServer.dll
Version: 8.11.0Syntax
[Obsolete("Save handler is no longer support, use regular IContentRepository API's to save content")]
public interface ISavePageProperties
GoToViewPageAfterSave
Gets or sets a value indicating whether to go to view page after save.
Declaration
bool GoToViewPageAfterSave { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
|
IgnoreModifiedOnSave
Allows a page to be saved without modifying any content.
Declaration
bool IgnoreModifiedOnSave { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsNewPage
Check if the query string parameters indicate that this is a request to create a new page.
Declaration
bool IsNewPage { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Remarks
Note: that this property will only return true at the initial "Request edit page to create new page".
NewPageParent
The newly created page will be placed below this page.
Declaration
PageReference NewPageParent { get; }Property Value
| Type | Description |
|---|---|
| PageReference | A PageReference to an existing page. |
Remarks
You must have at least Create access to the parent page. Note that the NewPageParent value is read from the query string parameter "parent" and cannot be set from code.
NewPageType
Page type fo the newly created page.
Declaration
int NewPageType { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 | An System.Int32 that corresponds to the page type ID. |
Remarks
Note: The NewPageType value is read from the query string parameter "type" and cannot be set from code.
RequestedSaveAction
Gets or sets the requested save action.
Declaration
SaveAction RequestedSaveAction { get; set; }Property Value
| Type | Description |
|---|---|
| SaveAction | The requested save action. |
Methods
AllowCheckInVersion()
Determines if the current user is allowed to check in the version currently being edited.
Declaration
bool AllowCheckInVersion()Returns
| Type | Description |
|---|---|
| System.Boolean | true if allowed to check in the version. |
Remarks
Basically the version must have status VersionStatus.CheckedOut to be considered for check in.
AllowCheckInVersion(VersionStatus)
Determines if the current user is allowed to check in a version.
Declaration
bool AllowCheckInVersion(VersionStatus versionStatus)Parameters
| Type | Name | Description |
|---|---|---|
| VersionStatus | versionStatus | The version status that we check against. |
Returns
| Type | Description |
|---|---|
| System.Boolean | true if allowed to check in the version. |
Remarks
You should use the parameter-less version of this method. This version is for internal use.
AllowDeleteVersion()
Determines if the user is allowed to delete the currently selected version.
Declaration
bool AllowDeleteVersion()Returns
| Type | Description |
|---|---|
| System.Boolean | true if allowed to delete. |
Remarks
Note: The published version can never be deleted.
AllowDeleteVersion(VersionStatus)
Determines if the user is allowed to delete a version of the current page.
Declaration
bool AllowDeleteVersion(VersionStatus versionStatus)Parameters
| Type | Name | Description |
|---|---|---|
| VersionStatus | versionStatus | The status of the version to check. |
Returns
| Type | Description |
|---|---|
| System.Boolean | true if allowed to delete. |
Remarks
You should use the parameter-less version of this method. This version is for internal use.
AllowPublishVersion()
Determines if the user is allowed to publish the currently selected version of the page.
Declaration
bool AllowPublishVersion()Returns
| Type | Description |
|---|---|
| System.Boolean | true if allowed to publish. |
Remarks
With the appropriate permissions, a user should be able to publish any version except for the published version.
AllowPublishVersion(VersionStatus)
Determines if the user is allowed to publish a version of the page.
Declaration
bool AllowPublishVersion(VersionStatus versionStatus)Parameters
| Type | Name | Description |
|---|---|---|
| VersionStatus | versionStatus | Status of the version to check. |
Returns
| Type | Description |
|---|---|
| System.Boolean | true if allowed to publish. |
Remarks
You should use the parameter-less version of this method. This version is for internal use.
AllowRejectVersion()
Determines if the user is allowed to reject the selected version of the current page.
Declaration
bool AllowRejectVersion()Returns
| Type | Description |
|---|---|
| System.Boolean | true if allowed to reject. |
Remarks
An editor with publish rights can usually reject versions.
AllowRejectVersion(VersionStatus)
Determines if the user is allowed to reject a version of the current page.
Declaration
bool AllowRejectVersion(VersionStatus versionStatus)Parameters
| Type | Name | Description |
|---|---|---|
| VersionStatus | versionStatus | Status of the version to check. |
Returns
| Type | Description |
|---|---|
| System.Boolean | You should use the parameter-less version of this method. This version is for internal use. |
SavePage()
Saves the page data posted in this request.
Declaration
void SavePage()Remarks
You should not normally need to explicitly call this method since it will be called for you if the correct parameters have been posted. See NewPageParent and NewPageType.
