ConsoleAction.IsCurrentlyEnabled method (AuthoringStates)

Determines whether the ConsoleAction is currently enabled.

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

Syntax

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

returnValue = instance.IsCurrentlyEnabled(currentState)

public virtual 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
True if the ConsoleAction is currently enabled; otherwise, False.

Remarks

The default return value for this method checks the RequiredStates property against the current state of the page. In some situations, a bitwise AND of the AuthoringStates class does not adequately define exactly when a ConsoleAction 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

ConsoleAction class

ConsoleAction members

IsCurrentlyEnabled overload

Microsoft.SharePoint.Publishing.WebControls.EditingMenuActions namespace

RequiredStates

UserRights