IsActionAvailable Method

IsActionAvailable Method (McGraphOverlay)

Description

A read-only boolean value indicating whether a specified action can be performed.

Return Type

A Boolean value.

VARIANT_BOOL ActionIsAvailable

Syntax

object.IsActionAvailable (ActionOfInterest)

The IsActionAvailable Method syntax has these parts:

Part	Description
object	An expression evaluating to an object of type McGraphOverlay.
ActionOfInterest	Required. A mcGraphOverlayActions enumeration, as described in settings. Indicates which action is being inquired about.

Settings

The settings for ActionOfInterest are:

Constant		Value	Description
	mcgoaMoveBackward	1	Check if at least one selected object may be moved
	mcgoaMoveForward	2	Check if at least one selected object may be moved
	mcgoaMoveToBack	3	Check if at least one selected object may be moved
	mcgoaMoveToFront	4	Check if at least one selected object may be moved
	mcgoaEditCut	5	Check if an EditCut is possible. This will be TRUE if any selected objects are deletable.
	mcgoaEditCopy	6	Check if an EditCopy is possible. This will be TRUE if there are any selected objects.
	mcgoaEditClear	7	Check if an EditClear is possible. This will be TRUE if any selected objects are deletable.
	mcgoaEditProperties	8	Check if there is a single Selected McGraphObj and an EditProperties call on it is possible.
	mcgoaBurnIn	9	Check to see if there is anything to burn in (i.e., any visible graph objects).
	mcgoaSelect	10	Check to see if there is anything selectable by the user (i.e., any visible, selectable graph objects).
	mcgoaMoveSelectedObjects	11	Check to see if there are any selected objects with the mcgsAllowmove Style bit set.
	mcgoaMoveHandle	12	Check to see if there are is a single selected object with the mcgsAllowresize Style bit set.

Remarks

This routine is most useful for deciding whether to gray menu items. It is not illegal to perform any of the tested actions even if they do nothing.