Class ModelActionParameterDefinition
Provides a parameter definition for a ModelAction. A ModelActionParameterDefinition defines how a parameter for a ModelAction looks like. Parameters of a ModelAction are represented with EntityObjects. That is, a ModelActionParameterDefinition has a property ModelEntity which represents the "blueprint" of the parameter EntityObject.
Inheritance
Implements
Inherited Members
Namespace: TimeCockpit.Data.DataModel.Actions
Assembly: TimeCockpit.Data.dll
Syntax
public abstract class ModelActionParameterDefinition : NamedDynamicObject, IDynamicMetaObjectProvider, INotifyPropertyChanged
Remarks
Up to now, only TypedParameters are supported as ModelActionParameterDefinitions for ModelActions.
Constructors
ModelActionParameterDefinition()
Initializes a new instance of the ModelActionParameterDefinition class
Declaration
public ModelActionParameterDefinition()
ModelActionParameterDefinition(IEnumerable<KeyValuePair<Object, Object>>)
Initializes a new instance of the ModelActionParameterDefinition class.
Declaration
public ModelActionParameterDefinition(IEnumerable<KeyValuePair<object, object>> properties)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.Object, System.Object>> | properties | Collection of properties. |
Properties
ModelEntity
Gets or sets the ModelEntityBase that is the template for the parameter (= an EntityObject) that is handed to a ModelAction
Declaration
public abstract ModelEntityBase ModelEntity { get; set; }
Property Value
Type | Description |
---|---|
ModelEntityBase |
Remarks
This property should not be called to fetch the ModelEntityBase. Use GetModelEntity() instead. This is because classes that inherit from this ModelActionParameterDefinition do not necessarily have a full ModelEntityBase. For an example see the currently unsupported AnonymousParameter.
Methods
Clone()
Creates a deep copy of the model action parameter definition.
Declaration
public abstract ModelActionParameterDefinition Clone()
Returns
Type | Description |
---|---|
ModelActionParameterDefinition | Returns a deep copy of the model action parameter definition. |
GetModelEntity()
Gets the ModelEntityBase that is used as template for a parameter (= an EntityObject) that is passed to a ModelAction.
Declaration
public abstract ModelEntityBase GetModelEntity()
Returns
Type | Description |
---|---|
ModelEntityBase | An instance of ModelEntityBase. |