ConsoleAction.IsCurrentlyEnabled Method

Use this method to allow the ConsoleAction object to specify whether it should be enabled or disabled without being restricted to 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 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 T:Microsoft.SharePoint.Publishing.WebControls.AuthoringStates class that represents the current state of the page.

Return Value

Type: System.Boolean
A Boolean value that represents whether the T:Microsoft.SharePoint.Publishing.WebControls.ConsoleAction 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 T:Microsoft.SharePoint.Publishing.WebControls.AuthoringStates class does not adequately define exactly when a T:Microsoft.SharePoint.Publishing.WebControls.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

Microsoft.SharePoint.Publishing.WebControls.EditingMenuActions Namespace

RequiredStates

UserRights