Action Class

In This Topic

An action performs a task in the system. It is usually called via ribbon items or the CallingActions. \Parameters can be passed to the action in a context class, and return values can be obtained with this parameter. Actions are implemented in an add-in by deriving a class from IEplAction.

Inheritance Hierarchy

System.Object
Eplan.EplApi.ApplicationFramework.Action

Syntax

C#
C++/CLI

public class Action

public ref class Action

Remarks

Actions are registered under a name Name in the system. Using this name, you can find an action and call its execution function Execute. Please mind, that Microsoft.Net framework 3.5 contains a class System.Action. If you include the namespace Eplan.EplApi.ApplicationFramework in your code file by e.g. a using statement without the use of an alias, you might get a compiler error like: "'Action' is an ambiguous reference between 'System.Action' and 'Eplan.EplApi.ApplicationFramework.Action'". Action names with . are not allowed.

Public Constructors

	Name	Description
	Action Constructor	For internal use only.

Top

Public Properties

	Name	Description
	ActionProperties	Descriptive data for this action.
	ModuleName	Name of the module in which this action is implemented.
	Name	Name used to identify this action in the system.

Top

Public Methods

	Name	Description
	Execute	Performs the actual action.
	GetChecked	Returns 'checked' state of an action
	GetEnabled	Returns whether an action is enabled

Top

Reference

Action Members
Eplan.EplApi.ApplicationFramework Namespace

Send Feedback