Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All
Expand Minimize

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)

[FlagsAttribute]
public enum AuthoringStates

Member nameDescription
EmptyMaskSpecifies all bits are set to zero (0).
IsPublishingPageTrueSpecifies to show the action only if the current list item is a publishing page.
IsPublishingPageFalseSpecifies to show the action only if the current list item is not a publishing page.
PageIsExpiredTrueSpecifies to show the action only if the current page has reached its expiration date.
PageIsExpiredFalseSpecifies to show the action only if the current page has not reached its expiration date.
CheckedOutVersionExistsTrueSpecifies a checked-out version of the current SPFile exists.
CheckedOutVersionExistsFalseSpecifies a checked-out version of the current SPFile does not exist.
IsMasterPageGalleryFileTrueSpecifies the current SPFile is in a master page gallery.
IsMasterPageGalleryFileFalseSpecifies the current SPFile is not in a master page gallery.
InEditModeTrueSpecifies the current page is in Edit mode.
InEditModeFalseSpecifies the current page is not in Edit mode.
IsDocLibListItemTrueSpecifies the current SPListItem is a list item in a document library.
IsDocLibListItemFalseSpecifies the current SPListItem is not a list item in a document library.
IsCheckedOutToCurrentUserTrueSpecifies the current SPFile is checked out to the current user.
IsCheckedOutToCurrentUserFalseSpecifies the current SPFile is not checked out to the current user.
IsCheckedOutToOtherUserTrueSpecifies the current SPFile is checked out to another (not the current) user.
IsCheckedOutToOtherUserFalseSpecifies the current SPFile is not checked out to another user.
IsPublishingSiteTrueSpecifies the Publishing feature is enabled in this site (SPWeb).
IsPublishingSiteFalseSpecifies the Publishing feature is not enabled in this site (SPWeb).
InSharedViewSpecifies the page is in the shared view.
InPersonalViewSpecifies the page is in the personal view.
IsMajorVersionTrueSpecifies to show the action only if the current version is published.
IsMajorVersionFalseSpecifies to show the action only if the current version is not published.
IsMinorVersionTrueSpecifies to show the action only if the current version is a draft.
IsMinorVersionFalseSpecifies to show the action only if the current version is not a draft.
IsScheduledStatusTrueSpecifies the current SPListItem is scheduled.
IsScheduledStatusFalseSpecifies the current SPListItem is not scheduled.
IsPendingApprovalTrueSpecifies the current SPListItem is pending approval.
IsPendingApprovalFalseSpecifies the current SPListItem is not pending approval.
PageHasCustomizableZonesTrueSpecifies the current page has customizable Web Part zones.
PageHasCustomizableZonesFalseSpecifies the current page does not have customizable Web Part zones.
PageHasPersonalizableZonesTrueSpecifies the current page has Web Part zonesWebPartZones that can be personalized.
PageHasPersonalizableZonesFalseSpecifies the current page does not have Web Part zones that can be personalized.
EditingMenuEnabledSpecifies the Editing tab is visible on the page.
EditingMenuDisabledSpecifies the Editing tab is not visible on the page.
IsApprovalWorkflowCancelEnabledTrueSpecifies to show the action only if the current user has permissions to cancel the existing approval workflow.
UserWorkflowTaskExistsTrueIndicates to show the action only if there are workflow tasks for the current user.
ActiveWorkflowsExistTrueSpecifies that active workflows exist for the current SPListItem.
ActiveWorkflowsExistFalseSpecifies that no active workflows exist for the current SPListItem.
IsItemWaitingForApprovalTrueSpecifies a default approval workflow is set.
IsApprovalWorkflowRunningFalseSpecifies no default approval workflow is set.
IsDefaultPageTrueSpecifies to show the action only if the current page is the default (welcome) page for the Web site.
IsDefaultPageFalseSpecifies to show the action only if the current page is not a default (welcome) page for the Web site.
SaveConflictExistsTrueSpecifies to show the action only if a save was just performed and there was a conflict.
SaveConflictExistsFalseSpecifies to show the action only if a save was not performed, or if the save that was performed did not have a conflict.
CheckedInVersionExistsTrueSpecifies to show the action only if a checked-in version of this file exists in the database.
CheckedInVersionExistsFalseSpecifies to show the action only if a checked-in version of this file does not exist in the database.
InWebPartDesignModeTrueSpecifies to show the action only if the page is currently in Web Part design mode.
InWebPartDesignModeFalseSpecifies to show the action only if the page is not currently in Web Part design mode.
MinorVersionsEnabledTrueSpecifies to show the action only if minor versions are enabled in this list.
MinorVersionsEnabledFalseSpecifies to show the action only if minor versions are not enabled in this list.
CheckOutRequiredTrueSpecifies to show the action only if checking out a document is required for editing.
CheckOutRequiredFalseSpecifies to show the action only if checking out a document is not required for editing.
ContentApprovalEnabledTrueSpecifies to show the action only if content approval is enabled in the current Web site.
ContentApprovalEnabledFalseSpecifies to show the action only if content approval is not enabled in the current Web site.
IsApprovalWorkflowConfiguredTrueSpecifies to show the action only if a default approval workflow is configured on the current list.
IsApprovalWorkflowConfiguredFalseSpecifies to show the action only if a default approval workflow is not configured on the current list.
IsFormPageTrueSpecifies to show the action only if the current page is a form page.
IsFormPageFalseSpecifies to show the action only if the current page is not a form page.
PageHasFieldControlsTrueSpecifies to show the action only if the current page has field controls.
PageHasFieldControlsFalseSpecifies to show the action only if the current page has no field controls.
IsApprovalWorkflowTaskActiveForUserTrueSpecifies to show the action only if an approval workflow task exists for the current user.
IsApprovalWorkflowTaskActiveForUserFalseSpecifies to show the action only if an approval workflow task does not exist for the current user.
IsSchedulingEnabledFalseSpecifies to show the action only if scheduling is enabled on the Pages list.
IsRibbonAlwaysShownTrueIndicates whether the ribbon is always shown by default.
FullMaskSpecifies all bits are set to 1 (including conflicting bits).

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.

Show:
© 2015 Microsoft