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

In This Topic
    ActionCallingContext Class
    In This Topic
    This is the ActionCallingContext class used to pass \parameters to an action and to receive return values of the action. This is the ActionCallingContext class used to pass \parameters to an action and to receive return values of the action.
    Inheritance Hierarchy

    System.Object
       Eplan.EplApi.Base.Context
          Eplan.EplApi.ApplicationFramework.ActionCallingContext
             Eplan.EplApi.DataModel.StorableObjectContext

    Syntax
    [Guid("B44C4085-E6B8-3622-A1EF-50DF81A26485")]
    public class ActionCallingContext : Eplan.EplApi.Base.Context, IActionCallingContext, Eplan.EplApi.Base.IContext  
    [Guid("B44C4085-E6B8-3622-A1EF-50DF81A26485")]
    public ref class ActionCallingContext : public Eplan.EplApi.Base.Context, IActionCallingContext, Eplan.EplApi.Base.IContext  
    Remarks
    Using AddParameter(...) you can add explicitly named \parameters to ActionCallingContext. The action must use this explicit name to reference these parameters. Likewise, values returned by the action can be added. Please mind, that an Action may modify the ActionCallingContext dureing its execution. Sometimes e.g. project Ids are added to the context and are passed to an inner action. Re-using the same ActionCallingContext for a further Action call may lead to unexpected results. So in most cases, it is advisable to create a new ActionCallingContext for a new Action call. Using AddParameter(...) you can add explicitly named \parameters to ActionCallingContext. The action must use this explicit name to reference these parameters. Likewise, values returned by the action can be added. Please mind, that an Action may modify the ActionCallingContext dureing its execution. Sometimes e.g. project Ids are added to the context and are passed to an inner action. Re-using the same ActionCallingContext for a further Action call may lead to unexpected results. So in most cases, it is advisable to create a new ActionCallingContext for a new Action call.
    Public Constructors
     NameDescription
    Public ConstructorOverloaded.   
    Top
    Public Properties
     NameDescription
    Public PropertyGets system messages Gets system messages  
    Top
    Public Methods
     NameDescription
    Public MethodAdds a parameter to the Context. (Inherited from Eplan.EplApi.Base.Context)
    Public MethodDestructor for deterministic finalization of ActionCallingContext object. Destructor for deterministic finalization of ActionCallingContext object. (Inherited from Eplan.EplApi.Base.Context)
    Public MethodFor internal use only. For internal use only.  
    Public MethodOverridden. Get the Block of Context Parameters of this Context.  
    Public MethodFor internal use only. (Inherited from Eplan.EplApi.Base.Context)
    Public MethodGet Exception Get Exception  
    Public MethodGets a parameter from the Context. (Inherited from Eplan.EplApi.Base.Context)
    Public MethodGets the count of the Parameters in this context (Inherited from Eplan.EplApi.Base.Context)
    Public MethodGets array filled with parameters names from the context. (Inherited from Eplan.EplApi.Base.Context)
    Public MethodGets the array filled with strings from the context. (Additional to the parameters) (Inherited from Eplan.EplApi.Base.Context)
    Public MethodFor internal use only. For internal use only.  
    Public MethodOverridden. Sets a block of context parameters (as ContextParameterBlock object).  
    Public MethodFor internal use only. (Inherited from Eplan.EplApi.Base.Context)
    Public MethodSets the array filled with strings from the context. (Additional to the parameters) (Inherited from Eplan.EplApi.Base.Context)
    Top
    See Also