[This is preliminary documentation and is subject to change.]

Indicates whether or not the component is eligible to be used

Namespace: Clarion.Framework.Core
Assembly: ClarionLibrary (in ClarionLibrary.dll) Version: 6.1.1.0 (6.1.1.0)

Syntax

C#
public virtual bool IsEligible(
	ActivationCollection currentInput
)

Parameters

currentInput
Type: Clarion.Framework..::..ActivationCollection
(optional) The current activation collection used for checking a component's eligibility

Return Value

True if the component is eligible, otherwise False

Remarks

This method is called internally by the system before attempting to use a component. By default, this method simply returns value of the ELIGIBILITY parameter.

Users can specify their own, customized, method for checking the eligibility of a Clarion component by either of the following methods:

  1. By overriding the method in a subclass. This is the better option when implementing a new, fully-defined, custom component
  2. By specifying an EligibilityChecker delegate during the initialization of a component. This option should be used when a user wishes to alter the eligibility checking method of an already existing component

If a user defined EligibilityChecker delegate is specified, this method will use that delegate to determine if the component is eligible.
Note
The eligibility checking delegate MUST return True if a component is eligible or False if it is not

See Also