Class TypedParameter
Represents a parameter that has a ModelEntity that is attached to a Model.
Inheritance
Implements
Inherited Members
Namespace: TimeCockpit.Data.DataModel.Actions
Assembly: TimeCockpit.Data.dll
Syntax
public class TypedParameter : ModelActionParameterDefinition, IDynamicMetaObjectProvider, INotifyPropertyChanged
Remarks
In order to create a valid instance of TypedParameter, the ModelEntity property needs to be set. It does not suffice to only set the ModelEntityName property. The latter property is only used for serialization purposes.
Optionally, the name of an EntityView can be provided. If the latter is provided, the form with the name is taken to represent ModelEntity visually. As with ModelEntity, the EntityView must be attached to the Model the ModelAction is attached to.
Constructors
TypedParameter()
Initializes a new instance of the TypedParameter class
Declaration
public TypedParameter()
TypedParameter(IEnumerable<KeyValuePair<Object, Object>>)
Initializes a new instance of the TypedParameter class.
Declaration
public TypedParameter(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 override ModelEntityBase ModelEntity { get; set; }
Property Value
Type | Description |
---|---|
ModelEntityBase |
Overrides
Remarks
During the validation process of a ModelAction, it is checked that the ModelEntityBase represented by this property is attached to the same Model as the ModelAction it belongs to.
ModelEntityForm
Gets or sets a string representing the name of an Form for a TypedParameter
Declaration
public string ModelEntityForm { get; set; }
Property Value
Type | Description |
---|---|
System.String |
ModelEntityName
Gets or sets the name of the ModelEntity of the current TypedParameter.
Declaration
public string ModelEntityName { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
This property should not be set. It is only used for deferred loading (deserialization) of TypedParameters in the data layer.
Methods
Clone()
Creates a deep copy of the model action parameter definition.
Declaration
public override ModelActionParameterDefinition Clone()
Returns
Type | Description |
---|---|
ModelActionParameterDefinition | Returns a deep copy of the model action parameter definition. |
Overrides
GetModelEntity()
Gets the ModelEntityBase that is used as template for a parameter (= an EntityObject) that is passed to a ModelAction.
Declaration
public override ModelEntityBase GetModelEntity()
Returns
Type | Description |
---|---|
ModelEntityBase | An instance of ModelEntityBase |