AuthoringStates enumeration
Represents the current state of a page, which is used to determine whether to show a specified ConsoleNode.
This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values.
Namespace: Microsoft.SharePoint.Publishing.WebControls
Assembly: Microsoft.SharePoint.Publishing (in Microsoft.SharePoint.Publishing.dll)
Syntax
'Declaration
<FlagsAttribute> _
Public Enumeration AuthoringStates
'Usage
Dim instance As AuthoringStates
[FlagsAttribute]
public enum AuthoringStates
Members
| Member name | Description | |
|---|---|---|
| EmptyMask | Specifies all bits are set to zero (0). | |
| IsPublishingPageTrue | Specifies to show the action only if the current list item is a publishing page. | |
| IsPublishingPageFalse | Specifies to show the action only if the current list item is not a publishing page. | |
| PageIsExpiredTrue | Specifies to show the action only if the current page has reached its expiration date. | |
| PageIsExpiredFalse | Specifies to show the action only if the current page has not reached its expiration date. | |
| CheckedOutVersionExistsTrue | Specifies a checked-out version of the current SPFile exists. | |
| CheckedOutVersionExistsFalse | Specifies a checked-out version of the current SPFile does not exist. | |
| IsMasterPageGalleryFileTrue | Specifies the current SPFile is in a master page gallery. | |
| IsMasterPageGalleryFileFalse | Specifies the current SPFile is not in a master page gallery. | |
| InEditModeTrue | Specifies the current page is in Edit mode. | |
| InEditModeFalse | Specifies the current page is not in Edit mode. | |
| IsDocLibListItemTrue | Specifies the current SPListItem is a list item in a document library. | |
| IsDocLibListItemFalse | Specifies the current SPListItem is not a list item in a document library. | |
| IsCheckedOutToCurrentUserTrue | Specifies the current SPFile is checked out to the current user. | |
| IsCheckedOutToCurrentUserFalse | Specifies the current SPFile is not checked out to the current user. | |
| IsCheckedOutToOtherUserTrue | Specifies the current SPFile is checked out to another (not the current) user. | |
| IsCheckedOutToOtherUserFalse | Specifies the current SPFile is not checked out to another user. | |
| IsPublishingSiteTrue | Specifies the Publishing feature is enabled in this site (SPWeb). | |
| IsPublishingSiteFalse | Specifies the Publishing feature is not enabled in this site (SPWeb). | |
| InSharedView | Specifies the page is in the shared view. | |
| InPersonalView | Specifies the page is in the personal view. | |
| IsMajorVersionTrue | Specifies to show the action only if the current version is published. | |
| IsMajorVersionFalse | Specifies to show the action only if the current version is not published. | |
| IsMinorVersionTrue | Specifies to show the action only if the current version is a draft. | |
| IsMinorVersionFalse | Specifies to show the action only if the current version is not a draft. | |
| IsScheduledStatusTrue | Specifies the current SPListItem is scheduled. | |
| IsScheduledStatusFalse | Specifies the current SPListItem is not scheduled. | |
| IsPendingApprovalTrue | Specifies the current SPListItem is pending approval. | |
| IsPendingApprovalFalse | Specifies the current SPListItem is not pending approval. | |
| PageHasCustomizableZonesTrue | Specifies the current page has customizable Web Part zones. | |
| PageHasCustomizableZonesFalse | Specifies the current page does not have customizable Web Part zones. | |
| PageHasPersonalizableZonesTrue | Specifies the current page has Web Part zonesWebPartZones that can be personalized. | |
| PageHasPersonalizableZonesFalse | Specifies the current page does not have Web Part zones that can be personalized. | |
| EditingMenuEnabled | Specifies the Editing tab is visible on the page. | |
| EditingMenuDisabled | Specifies the Editing tab is not visible on the page. | |
| IsApprovalWorkflowCancelEnabledTrue | Specifies to show the action only if the current user has permissions to cancel the existing approval workflow. | |
| UserWorkflowTaskExistsTrue | Indicates to show the action only if there are workflow tasks for the current user. | |
| ActiveWorkflowsExistTrue | Specifies that active workflows exist for the current SPListItem. | |
| ActiveWorkflowsExistFalse | Specifies that no active workflows exist for the current SPListItem. | |
| IsItemWaitingForApprovalTrue | Specifies a default approval workflow is set. | |
| IsApprovalWorkflowRunningFalse | Specifies no default approval workflow is set. | |
| IsDefaultPageTrue | Specifies to show the action only if the current page is the default (welcome) page for the Web site. | |
| IsDefaultPageFalse | Specifies to show the action only if the current page is not a default (welcome) page for the Web site. | |
| SaveConflictExistsTrue | Specifies to show the action only if a save was just performed and there was a conflict. | |
| SaveConflictExistsFalse | Specifies to show the action only if a save was not performed, or if the save that was performed did not have a conflict. | |
| CheckedInVersionExistsTrue | Specifies to show the action only if a checked-in version of this file exists in the database. | |
| CheckedInVersionExistsFalse | Specifies to show the action only if a checked-in version of this file does not exist in the database. | |
| InWebPartDesignModeTrue | Specifies to show the action only if the page is currently in Web Part design mode. | |
| InWebPartDesignModeFalse | Specifies to show the action only if the page is not currently in Web Part design mode. | |
| MinorVersionsEnabledTrue | Specifies to show the action only if minor versions are enabled in this list. | |
| MinorVersionsEnabledFalse | Specifies to show the action only if minor versions are not enabled in this list. | |
| CheckOutRequiredTrue | Specifies to show the action only if checking out a document is required for editing. | |
| CheckOutRequiredFalse | Specifies to show the action only if checking out a document is not required for editing. | |
| ContentApprovalEnabledTrue | Specifies to show the action only if content approval is enabled in the current Web site. | |
| ContentApprovalEnabledFalse | Specifies to show the action only if content approval is not enabled in the current Web site. | |
| IsApprovalWorkflowConfiguredTrue | Specifies to show the action only if a default approval workflow is configured on the current list. | |
| IsApprovalWorkflowConfiguredFalse | Specifies to show the action only if a default approval workflow is not configured on the current list. | |
| IsFormPageTrue | Specifies to show the action only if the current page is a form page. | |
| IsFormPageFalse | Specifies to show the action only if the current page is not a form page. | |
| PageHasFieldControlsTrue | Specifies to show the action only if the current page has field controls. | |
| PageHasFieldControlsFalse | Specifies to show the action only if the current page has no field controls. | |
| IsApprovalWorkflowTaskActiveForUserTrue | Specifies to show the action only if an approval workflow task exists for the current user. | |
| IsApprovalWorkflowTaskActiveForUserFalse | Specifies to show the action only if an approval workflow task does not exist for the current user. | |
| IsSchedulingEnabledFalse | Specifies to show the action only if scheduling is enabled on the Pages list. | |
| IsRibbonAlwaysShownTrue | Indicates whether the ribbon is always shown by default. | |
| FullMask | Specifies all bits are set to 1 (including conflicting bits). |
Remarks
Often, a ConsoleNode should be shown to the user only when the current page is in a certain state. For example, it is logical that a Check Out action is disabled if the page is already checked out, or for an "Edit Page" action to be disabled if there are no customizable zones or field controls on the page. Combined as a bit mask, these flags specify the page state that is required for an action to be enabled. Therefore, a mask which looks like CheckedOutVersionExistsFalse | IsDocLibListItemTrue | SaveConflictExistsFalse requires a page that is a list item in a document library and that is not checked out, and an instance where a save conflict has not occurred.