SiteDirectoryBrokenLinksCheckerAction.IsCurrentlyEnabled method (AuthoringStates)

Determines whether to allow the SwitchToAuthoringModeAction object to specify whether it can be enabled or disabled independently of what is defined in the AuthoringStates enumeration.

Namespace:  Microsoft.SharePoint.Publishing.WebControls.EditingMenuActions
Assembly:  Microsoft.SharePoint.Publishing (in Microsoft.SharePoint.Publishing.dll)

Syntax

'Declaration
Public Overrides Function IsCurrentlyEnabled ( _
    currentState As AuthoringStates _
) As Boolean
'Usage
Dim instance As SiteDirectoryBrokenLinksCheckerAction
Dim currentState As AuthoringStates
Dim returnValue As Boolean

returnValue = instance.IsCurrentlyEnabled(currentState)

public override bool IsCurrentlyEnabled(
    AuthoringStates currentState
)

Parameters

• currentState
  Type: Microsoft.SharePoint.Publishing.WebControls.AuthoringStates

  Bitmask of AuthoringStates class that represents the current state of the page.

Return value

Type: System.Boolean
A Boolean value that represents whether the SiteDirectoryBrokenLinksCheckerAction object should be enabled.
The default return value for this method checks the RequiredStates() property against the current state of the page.

Remarks

In some situations, a bitwise AND of the AuthoringStates class does not adequately define exactly when a CreateSiteVariationAction object should be enabled. When this is the case, use this method to define the return Boolean value in a specific way.

See also

Reference

SiteDirectoryBrokenLinksCheckerAction class

SiteDirectoryBrokenLinksCheckerAction members

IsCurrentlyEnabled overload

Microsoft.SharePoint.Publishing.WebControls.EditingMenuActions namespace