ActionCallingContext Class

In This Topic

Inheritance Hierarchy
Syntax
Remarks
Public Constructors
Public Methods
See Also

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

C#
C++/CLI

[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.

Public Constructors

	Name	Description
	ActionCallingContext Constructor	Overloaded.

Top

Public Methods

	Name	Description
	AddParameter	Adds a parameter to the Context. (Inherited from Eplan.EplApi.Base.Context)
	Dispose()	Destructor for deterministic finalization of ActionCallingContext object. (Inherited from Eplan.EplApi.Base.Context)
	GetAfActionCallingContext	For internal use only.
	GetContextParameter	Overridden. Get the Block of Context Parameters of this Context.
	GetEContext	For internal use only. (Inherited from Eplan.EplApi.Base.Context)
	GetException	Get Exception
	GetParameter	Gets a parameter from the Context. (Inherited from Eplan.EplApi.Base.Context)
	GetParameterCount	Gets the count of the Parameters in this context (Inherited from Eplan.EplApi.Base.Context)
	GetParameters	Gets array filled with parameters names from the context. (Inherited from Eplan.EplApi.Base.Context)
	GetStrings	Gets the array filled with strings from the context. (Additional to the parameters) (Inherited from Eplan.EplApi.Base.Context)
	SetAfActionCallingContext	For internal use only.
	SetContextParameter	Overridden. Sets a block of context parameters (as ContextParameterBlock object).
	SetEContext	For internal use only. (Inherited from Eplan.EplApi.Base.Context)
	SetStrings	Sets the array filled with strings from the context. (Additional to the parameters) (Inherited from Eplan.EplApi.Base.Context)

Top

Reference

ActionCallingContext Members
Eplan.EplApi.ApplicationFramework Namespace

Send Feedback