Tag: entity

Definition of a custom component data entity.

Tree

Mandatory Attributes

Name Description Type Allowed Values
datatype Data type representing the schematic-exposed type for which this data entity represents. String
name Name of the object. String
version Version of the object. Int32

Optional Attributes

Name Description Type Default Value Allowed Values
BeginGroup Indicates whether the load object will have a separator before it when shown in the context menu. Boolean False True, False
caption Caption of the object. String
class Class name of the controller of the object. String
ContextGroup Indicates which group the load will be shown in the context menu. String
icon Icon for the object. String
LazyActivateSelectProperties Determines when onActivate callback is called for the properties. Boolean False True, False
localize Indicates whether the caption and value string need to be localized by the application. Boolean False True, False

Callbacks

Name Description
CanAdd(IDataModelObject, String) Callback that is invoked to determine whether the object can be added.
CanCreate Callback that is invoked to determine whether the object can be created via the Object Creation API.
OnAdd(IUserObject) Callback that is invoked when the object is newly added.
OnInit(IUserObject) Callback that is invoked when the object is initialized.
OnMigrate(IUserObject, IUserObject) Callback that is invoked when the object version has been changed.