 | IEntity Interface |
the entity (non typed business object) manage a information, and can have one or more detail
Namespace: EBP.Api.Interfaces.Entity
Assembly: EBP.Api.Common (in EBP.Api.Common.dll) Version: 1.0.2835.45 (1.0.2835.45)
SyntaxThe IEntity type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | CreatedDate |
Gets the Created Date
|
| CreatedUser |
Gets the Created User
|
| EntityCaption |
Gets the caption of the current entity, using the content
|
| EntityLabel |
Gets the entity Label
|
| Errors |
Gets the collection of errors
|
| IsDeleted |
Gets if the mode matches a deleted mode
|
| IsEmptyLine |
Indicates if the entity is an empty line of an entity collection (created in auto
following the entityCollection options)
|
| Members |
List of the members. It allows to acces to members with the name
|
| Mode |
Gets the entity mode
|
| ModifiedDate |
Gets the Modified Date
|
| ModifiedUser |
Gets the Modified User
|
| OwnerEntity |
Gets the main entity that own all this items/collection
|
| Parent |
Gets the parent entity collection, that own this item
|
| ReadOnly |
Gets/Sets if the entity is in read only mode, to preserve from data changing
|
| Silent |
Get/Sets if the entity is in silent mode
|
| States |
Gets the entity states
|
Methods| Name | Description | |
|---|---|---|
 | Append |
Method for add a new entity to the media. Update the entity
to its default value.
|
| Cancel |
Cancel the edit mode without saving, and reload the entity
|
| CancelEdit |
Cancel the edit mode without saving, without reload the entity
|
| CheckData |
Check the data of the entity
|
| Clear |
Clear the entity content and reinitialize it to the default value
|
| Clone |
Clone an entity
|
| CopyTo(IEntity) |
Copy the entity content to another entity
|
| CopyTo(IEntity, Boolean) |
Copy the entity content to another entity
|
| Delete |
Method for delete a existing entity from the media
|
| Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.) |
| Edit |
Method to pass in edit mode a existing entity in the media
(for exemple, add a lock for database)
|
| GetExtension |
Gets the extension.
(Inherited from IApiEntity.) |
| Load |
Method for loading the entity
|
| Save |
Method for saving the entity to the media
|
| SetComplexMemberReadOnly |
Set the read only property to a member
|
| ShowMessage |
Method to display a message. The message is displayed if the UI has connected to the
ShowMessage event
(Inherited from IApiEntity.) |
Events| Name | Description | |
|---|---|---|
 | ModeChanged |
Event raised on mode changed
|
See Also