Eplan Platform API
Eplan.EplApi.ApplicationFramework Namespace / Action Class
Members

In This Topic
    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
    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
     NameDescription
    Public ConstructorAction ConstructorFor internal use only.  
    Top
    Public Properties
     NameDescription
    Public PropertyActionPropertiesDescriptive data for this action.  
    Public PropertyModuleNameName of the module in which this action is implemented.  
    Public PropertyNameName used to identify this action in the system.  
    Top
    Public Methods
     NameDescription
    Public MethodExecutePerforms the actual action.  
    Public MethodGetCheckedReturns 'checked' state of an action  
    Public MethodGetEnabledReturns whether an action is enabled  
    Top
    See Also

    Reference

    Action Members
    Eplan.EplApi.ApplicationFramework Namespace

     

     

    EPLAN API , 16.11.2024, © by EPLAN GmbH & Co. KG. All rights reserved.

    Use the Eplan Global Support Portal for feedback and support