Class SaveAction
Describes the type of action to perform when saving a content item.
Inheritance
Namespace: EPiServer.DataAccess
Assembly: EPiServer.dll
Version: 12.0.3Syntax
public sealed class SaveAction : EnumRemarks
This enumeration contains both primary commands (CheckIn, Publish, Schedule) that defines the main action and option flags (ForceNewVersion, ForceCurrentVersion) that provide additional information about the save operation.
Fields
ActionMask
Mask that can be used to clear option flags from a combined SaveAction value.
Declaration
public const SaveAction ActionMaskField Value
| Type | Description |
|---|---|
| SaveAction |
CheckIn
Save and transition content to CheckedIn state.
Declaration
public const SaveAction CheckInField Value
| Type | Description |
|---|---|
| SaveAction |
CheckOut
Save and transition content to a CheckedOut state, creating a new version if not already checked-out.
Declaration
public const SaveAction CheckOutField Value
| Type | Description |
|---|---|
| SaveAction |
Default
Save content without updating the status.
Declaration
public const SaveAction DefaultField Value
| Type | Description |
|---|---|
| SaveAction |
Remarks
When the saved content is Published or PreviouslyPublished a new version with status CheckedOut will be created.
When combined with ForceNewVersion a new version with status CheckedOut will be created.
DelayedPublish
NOTE: This action has been replaced by the Schedule primary action and will be removed in a future version.
Save and check in content, creating a new version only if necessary and sets the content as delayed publish.
Declaration
public const SaveAction DelayedPublishField Value
| Type | Description |
|---|---|
| SaveAction |
Remarks
This action must always be combined with the CheckIn action when used.
ForceCurrentVersion
Option that will ensure that the any existing version is updated.
Declaration
public const SaveAction ForceCurrentVersionField Value
| Type | Description |
|---|---|
| SaveAction |
Remarks
This option will be ignored if used when saving a new item.
ForceNewVersion
Option that ensures that a new version is created when saving preventing the current content from being overwritten.
Declaration
public const SaveAction ForceNewVersionField Value
| Type | Description |
|---|---|
| SaveAction |
None
Replaced by Default.
Declaration
public const SaveAction NoneField Value
| Type | Description |
|---|---|
| SaveAction |
Patch
Update the current version without changing the status or trigger any validation.
Declaration
public const SaveAction PatchField Value
| Type | Description |
|---|---|
| SaveAction |
Remarks
Use with caution, especially with published content.
Publish
Save and publish content. Content will transition to a Published state.
Declaration
public const SaveAction PublishField Value
| Type | Description |
|---|---|
| SaveAction |
Reject
Save and transition content to the Rejected state.
Declaration
public const SaveAction RejectField Value
| Type | Description |
|---|---|
| SaveAction |
RequestApproval
NOTE: This is a pre-release saveAction that is UNSTABLE and might not satisfy the compatibility requirements as denoted by its associated normal version.
Save and transition content to AwaitingApproval state.
Declaration
public const SaveAction RequestApprovalField Value
| Type | Description |
|---|---|
| SaveAction |
Save
NOTE: This action has some inconsistent behavior and has been deprecated in favour of either Default or CheckOut depending on your needs. This action will be obsoleted and removed in a future version.
Save content, leaving it in a checked out state.
Declaration
public const SaveAction SaveField Value
| Type | Description |
|---|---|
| SaveAction |
Schedule
Save and schedule content to be published. Content will transition to a DelayedPublish state.
Declaration
public const SaveAction ScheduleField Value
| Type | Description |
|---|---|
| SaveAction |
SkipSetCommonDraft
Option to avoid setting the version as the commond draft in cases where the save results in a new version being created.
Declaration
public const SaveAction SkipSetCommonDraftField Value
| Type | Description |
|---|---|
| SaveAction |
SkipValidation
Option that indicates that the content data should not be validated against IValidationService.
Declaration
public const SaveAction SkipValidationField Value
| Type | Description |
|---|---|
| SaveAction |
Remarks
Use with caution, especially when publishing content.
value__
Declaration
public int value__Field Value
| Type | Description |
|---|---|
| System.Int32 |
