AuthoringStates Enumeration (Microsoft.SharePoint.Publishing.WebControls)

AuthoringStates Enumeration

Community Content

In this section

Statistics Annotations (0)

Click here to expand

Collapse All

Language Filter

This page is specific to

The 2007 product release

Other versions are also available for the following:

The 2010 product release

AuthoringStates Enumeration (Microsoft.SharePoint.Publishing.WebControls)

The current state of a page, used to determine whether or not a given ConsoleNode should be shown.

Namespace: Microsoft.SharePoint.Publishing.WebControls
Assembly: Microsoft.SharePoint.Publishing (in microsoft.sharepoint.publishing.dll)

Syntax

Visual Basic (Declaration)

<FlagsAttribute> _
Public Enumeration AuthoringStates As Long

Visual Basic (Usage)

Dim instance As AuthoringStates

[FlagsAttribute] 
public enum AuthoringStates : long

Members

	Member name	Description
	ActiveWorkflowsExistFalse	No active workflows exist for the current SPListItem.
	ActiveWorkflowsExistTrue	Active workflows exist for the current SPListItem.
	CheckedInVersionExistsFalse	Show the action only if a checked in version of this file does not exist in the database.
	CheckedInVersionExistsTrue	Show the action only if a checked in version of this file exists in the database.
	CheckedOutVersionExistsFalse	A checked out version of the current SPFile does not exist.
	CheckedOutVersionExistsTrue	A checked out version of the current SPFile exists.
	CheckOutRequiredFalse	Show the action only if checking out a document is not required for editing.
	CheckOutRequiredTrue	Show the action only if checking out a document is required for editing.
	ContentApprovalEnabledFalse	Show the action only if content approval is not enabled in the current Web site.
	ContentApprovalEnabledTrue	Show the action only if content approval is enabled in the current Web site.
	EditingMenuDisabled	The Editing Menu is not visible on the page.
	EditingMenuEnabled	The Editing Menu is visible on the page.
	EmptyMask	All bits are set to 0.
	FullMask	All bits are set to 1 (including conflicting ones).
	InEditModeFalse	The current page is not in Edit mode.
	InEditModeTrue	The current page is in Edit mode.
	InPersonalView	The page is in the Personal View.
	InSharedView	The page is in the Shared View.
	InWebPartDesignModeFalse	Show the action only if the page is not currently in Web Part design mode.
	InWebPartDesignModeTrue	Show the action only if the page is currently in Web Part design mode.
	IsApprovalWorkflowCancelEnabledTrue	Show the action only if the current user has permissions to cancel the existing approval workflow.
	IsApprovalWorkflowConfiguredFalse	Show the action only if a default approval workflow is not configured on the current list.
	IsApprovalWorkflowConfiguredTrue	Show the action only if a default approval workflow has been configured on the current list.
	IsApprovalWorkflowRunningFalse	No default approval workflow has been set.
	IsApprovalWorkflowTaskActiveForUserFalse	Show the action only if an approval workflow task does not exist for the current user.
	IsApprovalWorkflowTaskActiveForUserTrue	Show the action only if an approval workflow task exists for the current user.
	IsCheckedOutToCurrentUserFalse	The current SPFile is not checked out to the current user.
	IsCheckedOutToCurrentUserTrue	The current SPFile is checked out to the current user.
	IsCheckedOutToOtherUserFalse	The current SPFile is not checked out to another user.
	IsCheckedOutToOtherUserTrue	The current SPFile is checked out to another (not the current) user.
	IsDefaultPageFalse	Show the action only if the current page is not a default (welcome) page for the Web site.
	IsDefaultPageTrue	Show the action only if the current page is the default (welcome) page for the Web site.
	IsDocLibListItemFalse	The current SPListItem is not a list item in a document library.
	IsDocLibListItemTrue	The current SPListItem is a list item in a document library.
	IsFormPageFalse	Show the action only if the current page is not a form page.
	IsFormPageTrue	Show the action only if the current page is a form page.
	IsItemWaitingForApprovalTrue	A default approval workflow has been set.
	IsMajorVersionFalse	Show the action only if the current version is not published.
	IsMajorVersionTrue	Show the action only if the current version is published.
	IsMasterPageGalleryFileFalse	The current SPFile is not in a master page gallery.
	IsMasterPageGalleryFileTrue	The current SPFile is in a master page gallery.
	IsMinorVersionFalse	Show the action only if the current version is not a draft.
	IsMinorVersionTrue	Show the action only if the current version is a draft.
	IsPendingApprovalFalse	The current SPListItem is not pending approval.
	IsPendingApprovalTrue	The current SPListItem is pending approval.
	IsPublishingPageFalse	Show the action only if the current list item is not a PublishingPage instance.
	IsPublishingPageTrue	Show the action only if the current list item is a PublishingPage instance.
	IsPublishingSiteFalse	The Publishing feature is not enabled in this site (SPWeb).
	IsPublishingSiteTrue	The Publishing feature is enabled in this site (SPWeb).
	IsScheduledStatusFalse	The current SPListItem is not scheduled.
	IsScheduledStatusTrue	The current SPListItem is scheduled.
	IsSchedulingEnabledFalse	Show the action only if scheduling is enabled on the Pages list.
	MinorVersionsEnabledFalse	Show the action only if minor versions are not enabled in this list.
	MinorVersionsEnabledTrue	Show the action only if minor versions are enabled in this list.
	NonApprovalWorkflowTaskExistsTrue	There are multiple workflow tasks for the current user (other than an approval task).
	PageHasCustomizableZonesFalse	The current page does not have customizable WebPartZones.
	PageHasCustomizableZonesTrue	The current page has customizable WebPartZones.
	PageHasFieldControlsFalse	Show the action only if the current page has no field controls.
	PageHasFieldControlsTrue	Show the action only if the current page has field controls.
	PageHasPersonalizableZonesFalse	The current page does not have WebPartZones that can be personalized.
	PageHasPersonalizableZonesTrue	The current page has WebPartZones that can be personalized.
	PageIsExpiredFalse	Show the action only if the current page has not reached its expiration date.
	PageIsExpiredTrue	Show the action only if the current page has reached its expiration date.
	SaveConflictExistsFalse	Show the action only if a save was not performed, or if the save that was performed did not have a conflict.
	SaveConflictExistsTrue	Show the action only if a save was just performed and there was a conflict.

Remarks

Often, a ConsoleNode should only be shown to the user 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 this: 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 just occurred.

Reference

Microsoft.SharePoint.Publishing.WebControls Namespace