API Help
EPLAN API / User Guide / API Framework / Add-ins / Actions
In This Topic
    Actions
    In This Topic

    What is called an action in EPLAN? 

    An action is a procedure or function, which can be dynamically registered in EPLAN. The action is identified by its name and its overload priority. An action can have any number of parameters, which are passed to an d from the action via a so-called ActionCallingContext. Each menu point in EPLAN is associated with an actions, which is called up, when the menu point is clicked. 

     

    An add-in can add new actions to EPLAN. Actions can be called by the command line and they can be assigned to a new menu point. A new action can override an existing action with the same name. 

     

    An action is implemented by a class, which inherits the interface IEplAction. You need to add an implementation of all the functions of the interface. An add-in can contain an arbitrary number of actions. 

    public class CSharpAction: Eplan.EplApi.ApplicationFramework.IEplAction
    {
        ///<summary>
        ///This function is called when executing the action.
        ///</summary>
        ///<returns>true, if the action performed successfully</returns>
        public bool Execute(Eplan.EplApi.ApplicationFramework.ActionCallingContext ctx )
        {
             new Decider().Decide(EnumDecisionType.eOkDecision, "CSharpAction was called!", "Eplan.EplAddIn.Demo1", EnumDecisionReturn.eOK, EnumDecisionReturn.eOK);
             // TODO: Add your Code here
    
             return true;
        }
        ///<summary>
        ///This function is called by the application framework, when registering the add-in.
        ///</summary>
        ///<param name="Name">The action is registered in EPLAN under this name</param>
        ///<param name="Ordinal">The action is registered with this overload priority</param>
        ///<returns>true, if OnRegister succeeds</returns>
        public bool OnRegister(ref string Name, ref int Ordinal)
        {
             Name  = "CSharpAction";
             Ordinal    = 20;
             return true;
        }
        ///<summary>
        /// Documentation function for the action, which is called by EPLAN on demand
        /// returns the descriptive text for the action itself and if the action takes string parameters
        /// (command line), it also provides the name and description of each parameter
        ///</summary>
        ///<param name="actionProperties"> This object needs to be filled with information about the action
        ///</param>
        public void GetActionProperties(ref Eplan.EplApi.ApplicationFramework.ActionProperties actionProperties)
        {
            actionProperties.Description= "Action test with parameters.";
            // description of first parameter
            Eplan.EplApi.ApplicationFramework.ActionParameterProperties firstParam= new ActionParameterProperties();
            firstParam.Set("Param1", "first test parameter");
            actionProperties.AddParameter(firstParam);
            // description of second parameter
            // Eplan.EplApi.ApplicationFramework.ActionParameterProperties secondParam= new ActionParameterProperties();
            // secondParam.Set("Param2", "Second parameter for test");
            // actionProperties.AddParameter(secondParam);
        }
    }
    
    Public Class VBAction
       Implements Eplan.EplApi.ApplicationFramework.IEplAction
    
       '''<summary>
       '''This function is called when executing the action.
       '''</summary>
       '''<returns>true, if the action performed successfully</returns>
       Public Function Execute(ctx As Eplan.EplApi.ApplicationFramework.ActionCallingContext) As Boolean _
         Implements Eplan.EplApi.ApplicationFramework.IEplAction.Execute
          new Decider().Decide(EnumDecisionType.eOkDecision, "VBAction was called!", "Eplan.EplAddIn.VBDemo1", EnumDecisionReturn.eOK, EnumDecisionReturn.eOK)
          ' TODO: Add your Code here
          Return True
       End Function 'Execute
    
       '''<summary>
       '''This function is called by the application framework, when registering the add-in.
       '''</summary>
       '''<param name="Name">The action is registered in EPLAN under this name</param>
       '''<param name="Ordinal">The action is registered with this overload priority</param>
       '''<returns>true, if OnRegister succeeds</returns>
       Public Function OnRegister(ByRef Name As String, ByRef Ordinal As Integer) As Boolean _
        Implements Eplan.EplApi.ApplicationFramework.IEplAction.OnRegister
          Name = "CSharpAction"
          Ordinal = 20
          Return True
       End Function 'OnRegister
    
       '''<summary>
       ''' Documentation function for the action, which is called by EPLAN on demand
       ''' returns the descriptive text for the action itself and if the action takes string parameters
       ''' (command line), it also provides the name and description of each parameter
       '''</summary>
       '''<param name="actionProperties"> This object needs to be filled with information about the action
       '''</param>
       Public Sub GetActionProperties(ByRef actionProperties As Eplan.EplApi.ApplicationFramework.ActionProperties) _
        Implements Eplan.EplApi.ApplicationFramework.IEplAction.GetActionProperties
          actionProperties.Description = "Action test with parameters."
          ' description of first parameter
          Dim firstParam As New Eplan.EplApi.ApplicationFramework.ActionParameterProperties()
          firstParam.Set("Param1", "first test parameter")
          actionProperties.AddParameter(firstParam)
       End Sub 'getActionProperties
    End Class 'VBAction ' description of second parameter
    
    [C#]
    

       

    By the parameter of type ActionCallingContext parameters can be passed to the action. For extracting the parameter values and for setting parameters (as return parameters!) the class ActionCallingContext provides a set of functions: 

     

    public bool Execute(Eplan.EplApi.ApplicationFramework.ActionCallingContext ctx )
    {
       String strParamValue=null;
       ctx.GetParameter("Param1", ref strParamValue);
       // use string parameter ...
       // fill parameter "ReturnParam" with value "return value".
       // the caller of this action can extract the parameter by ctx.getParameter("ReturnParam", ...)
       String strReturnValue= "return value";
       ctx.AddParameter("ReturnParam", strReturnValue);
       return true;
    }
    
    Public Function Execute(ctx As Eplan.EplApi.ApplicationFramework.ActionCallingContext) As Boolean _
          Implements Eplan.EplApi.ApplicationFramework.IEplAction.Execute
       Dim strParamValue As String = String.Empty
       ctx.GetParameter("Param1", strParamValue)
       ' use string parameter ...
       ' fill parameter "ReturnParam" with value "return value".
       ' the caller of this action can extract the parameter by ctx.getParameter("ReturnParam", ...)
       Dim strReturnValue As String = "return value"
       ctx.AddParameter("ReturnParam", strReturnValue)
       Return True
    End Function 'Execute
    

     

    If an action is assigned to a menu item or a tool bar button, these items are only enabled if the action is registered and enabled. You can enable/disable a registered action via the IEplActionEnable interface. 

    public class TestAction : Eplan.EplApi.ApplicationFramework.IEplAction, Eplan.EplApi.ApplicationFramework.IEplActionEnable
        {
            //IEplAction Members
            #region IEplActionEnable Members
            public bool Enabled(string strActionName, Eplan.EplApi.ApplicationFramework.ActionCallingContext actionContext)
            {
                if (strActionName == "TESTACTION")
                {
                    return false;
                }
                else
                {
                    return true;
                }
            }
            #endregion
        }
    
    Public Class TestAction
       Implements Eplan.EplApi.ApplicationFramework.IEplAction
       Implements Eplan.EplApi.ApplicationFramework.IEplActionEnable
       'IEplAction Members ...
       Public Function Enabled(strActionName As String, actionContext As Eplan.EplApi.ApplicationFramework.ActionCallingContext) As Boolean _
    Implements Eplan.EplApi.ApplicationFramework.IEplActionEnable.Enabled
          If strActionName = "TESTACTION" Then
             Return False
          Else
             Return True
          End If
       End Function 'Enabled
    End Class 'TestAction
    
       
    See Also

    API Actions

    Reference