AuthoringStates Enum

Definition

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.

public enum class AuthoringStates
[System.Flags]
public enum AuthoringStates
type AuthoringStates = 
Public Enum AuthoringStates
Inheritance
AuthoringStates
Attributes

Fields

ActiveWorkflowsExistFalse 137438953472

Specifies that no active workflows exist for the current SPListItem.

ActiveWorkflowsExistTrue 68719476736

Specifies that active workflows exist for the current SPListItem.

CheckedInVersionExistsFalse 35184372088832

Specifies to show the action only if a checked-in version of this file does not exist in the database.

CheckedInVersionExistsTrue 17592186044416

Specifies to show the action only if a checked-in version of this file exists in the database.

CheckedOutVersionExistsFalse 32

Specifies a checked-out version of the current SPFile does not exist.

CheckedOutVersionExistsTrue 16

Specifies a checked-out version of the current SPFile exists.

CheckOutRequiredFalse 2251799813685248

Specifies to show the action only if checking out a document is not required for editing.

CheckOutRequiredTrue 1125899906842624

Specifies to show the action only if checking out a document is required for editing.

ContentApprovalEnabledFalse 9007199254740992

Specifies to show the action only if content approval is not enabled in the current Web site.

ContentApprovalEnabledTrue 4503599627370496

Specifies to show the action only if content approval is enabled in the current Web site.

EditingMenuDisabled 8589934592

Specifies the Editing tab is not visible on the page.

EditingMenuEnabled 4294967296

Specifies the Editing tab is visible on the page.

EmptyMask 0

Specifies all bits are set to zero (0).

FullMask 18446744073709551615

Specifies all bits are set to 1 (including conflicting bits).

InEditModeFalse 512

Specifies the current page is not in Edit mode.

InEditModeTrue 256

Specifies the current page is in Edit mode.

InPersonalView 524288

Specifies the page is in the personal view.

InSharedView 262144

Specifies the page is in the shared view.

InWebPartDesignModeFalse 140737488355328

Specifies to show the action only if the page is not currently in Web Part design mode.

InWebPartDesignModeTrue 70368744177664

Specifies to show the action only if the page is currently in Web Part design mode.

IsApprovalWorkflowCancelEnabledTrue 17179869184

Specifies to show the action only if the current user has permissions to cancel the existing approval workflow.

IsApprovalWorkflowConfiguredFalse 36028797018963968

Specifies to show the action only if a default approval workflow is not configured on the current list.

IsApprovalWorkflowConfiguredTrue 18014398509481984

Specifies to show the action only if a default approval workflow is configured on the current list.

IsApprovalWorkflowRunningFalse 549755813888

Specifies no default approval workflow is set.

IsApprovalWorkflowTaskActiveForUserFalse 2305843009213693952

Specifies to show the action only if an approval workflow task does not exist for the current user.

IsApprovalWorkflowTaskActiveForUserTrue 1152921504606846976

Specifies to show the action only if an approval workflow task exists for the current user.

IsCheckedOutToCurrentUserFalse 8192

Specifies the current SPFile is not checked out to the current user.

IsCheckedOutToCurrentUserTrue 4096

Specifies the current SPFile is checked out to the current user.

IsCheckedOutToOtherUserFalse 32768

Specifies the current SPFile is not checked out to another user.

IsCheckedOutToOtherUserTrue 16384

Specifies the current SPFile is checked out to another (not the current) user.

IsDefaultPageFalse 2199023255552

Specifies to show the action only if the current page is not a default (welcome) page for the Web site.

IsDefaultPageTrue 1099511627776

Specifies to show the action only if the current page is the default (welcome) page for the Web site.

IsDocLibListItemFalse 2048

Specifies the current SPListItem is not a list item in a document library.

IsDocLibListItemTrue 1024

Specifies the current SPListItem is a list item in a document library.

IsFormPageFalse 144115188075855872

Specifies to show the action only if the current page is not a form page.

IsFormPageTrue 72057594037927936

Specifies to show the action only if the current page is a form page.

IsItemWaitingForApprovalTrue 274877906944

Specifies a default approval workflow is set.

IsMajorVersionFalse 2097152

Specifies to show the action only if the current version is not published.

IsMajorVersionTrue 1048576

Specifies to show the action only if the current version is published.

IsMasterPageGalleryFileFalse 128

Specifies the current SPFile is not in a master page gallery.

IsMasterPageGalleryFileTrue 64

Specifies the current SPFile is in a master page gallery.

IsMinorVersionFalse 8388608

Specifies to show the action only if the current version is not a draft.

IsMinorVersionTrue 4194304

Specifies to show the action only if the current version is a draft.

IsPendingApprovalFalse 134217728

Specifies the current SPListItem is not pending approval.

IsPendingApprovalTrue 67108864

Specifies the current SPListItem is pending approval.

IsPublishingPageFalse 2

Specifies to show the action only if the current list item is not a publishing page.

IsPublishingPageTrue 1

Specifies to show the action only if the current list item is a publishing page.

IsPublishingSiteFalse 131072

Specifies the Publishing feature is not enabled in this site (SPWeb).

IsPublishingSiteTrue 65536

Specifies the Publishing feature is enabled in this site (SPWeb).

IsRibbonAlwaysShownTrue 9223372036854775808

Indicates whether the ribbon is always shown by default.

IsScheduledStatusFalse 33554432

Specifies the current SPListItem is not scheduled.

IsScheduledStatusTrue 16777216

Specifies the current SPListItem is scheduled.

IsSchedulingEnabledFalse 4611686018427387904

Specifies to show the action only if scheduling is enabled on the Pages list.

MinorVersionsEnabledFalse 562949953421312

Specifies to show the action only if minor versions are not enabled in this list.

MinorVersionsEnabledTrue 281474976710656

Specifies to show the action only if minor versions are enabled in this list.

PageHasCustomizableZonesFalse 536870912

Specifies the current page does not have customizable Web Part zones.

PageHasCustomizableZonesTrue 268435456

Specifies the current page has customizable Web Part zones.

PageHasFieldControlsFalse 576460752303423488

Specifies to show the action only if the current page has no field controls.

PageHasFieldControlsTrue 288230376151711744

Specifies to show the action only if the current page has field controls.

PageHasPersonalizableZonesFalse 2147483648

Specifies the current page does not have Web Part zones that can be personalized.

PageHasPersonalizableZonesTrue 1073741824

Specifies the current page has Web Part zonesWebPartZones that can be personalized.

PageIsExpiredFalse 8

Specifies to show the action only if the current page has not reached its expiration date.

PageIsExpiredTrue 4

Specifies to show the action only if the current page has reached its expiration date.

SaveConflictExistsFalse 8796093022208

Specifies to show the action only if a save was not performed, or if the save that was performed did not have a conflict.

SaveConflictExistsTrue 4398046511104

Specifies to show the action only if a save was just performed and there was a conflict.

UserWorkflowTaskExistsTrue 34359738368

Indicates to show the action only if there are workflow tasks for the current user.

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.

Applies to