Click or drag to resize

IFileEntityTEntityMember, TValue Interface

File Entity

Namespace:  EBP.Api.Interfaces.Entity
Assembly:  EBP.Api.Common (in EBP.Api.Common.dll) Version: 1.0.2835.45 (1.0.2835.45)
Syntax
public interface IFileEntity<TEntityMember, TValue> : IFileEntityBase, 
	IEntity, IApiEntity, IDisposable, IEquatable<IProxy>
where TEntityMember : Object, IReadOnlyEntityMember<TValue>

Type Parameters

TEntityMember
Entity member type
TValue
entity member value's type

The IFileEntityTEntityMember, TValue type exposes the following members.

Properties
  NameDescription
Public propertyContent
Gets or sets the Content member value
(Inherited from IFileEntityBase.)
Public propertyContentMember
File content
(Inherited from IFileEntityBase.)
Public propertyCreatedDate
Gets the Created Date
(Inherited from IEntity.)
Public propertyCreatedUser
Gets the Created User
(Inherited from IEntity.)
Public propertyDocumentType
Gets or sets the DocumentType member value (Type de document)
(Inherited from IFileEntityBase.)
Public propertyDocumentTypeMember
Document Type
(Inherited from IFileEntityBase.)
Public propertyEntityCaption
Gets the caption of the current entity, using the content
(Inherited from IEntity.)
Public propertyEntityLabel
Gets the entity Label
(Inherited from IEntity.)
Public propertyErrors
Gets the collection of errors
(Inherited from IEntity.)
Public propertyId
Gets or sets the Id member value (Code)
(Inherited from IFileEntityBase.)
Public propertyIdMember
File id
(Inherited from IFileEntityBase.)
Public propertyIsDeleted
Gets if the mode matches a deleted mode
(Inherited from IEntity.)
Public propertyIsEmptyLine
Indicates if the entity is an empty line of an entity collection (created in auto following the entityCollection options)
(Inherited from IEntity.)
Public propertyMembers
List of the members. It allows to acces to members with the name
(Inherited from IEntity.)
Public propertyMode
Gets the entity mode
(Inherited from IEntity.)
Public propertyModifiedDate
Gets the Modified Date
(Inherited from IEntity.)
Public propertyModifiedUser
Gets the Modified User
(Inherited from IEntity.)
Public propertyName
Gets or sets the Name member value
(Inherited from IFileEntityBase.)
Public propertyNameMember
File name
(Inherited from IFileEntityBase.)
Public propertyOwnerEntity
Gets the main entity that own all this items/collection
(Inherited from IEntity.)
Public propertyParent
Gets the parent entity collection, that own this item
(Inherited from IEntity.)
Public propertyParentId
Gets or sets the ParentId member value
Public propertyParentIdMember
File id
Public propertyReadOnly
Gets/Sets if the entity is in read only mode, to preserve from data changing
(Inherited from IEntity.)
Public propertySilent
Get/Sets if the entity is in silent mode
(Inherited from IEntity.)
Public propertyStates
Gets the entity states
(Inherited from IEntity.)
Top
Methods
  NameDescription
Public methodAppend
Method for add a new entity to the media. Update the entity to its default value.
(Inherited from IEntity.)
Public methodCancel
Cancel the edit mode without saving, and reload the entity
(Inherited from IEntity.)
Public methodCancelEdit
Cancel the edit mode without saving, without reload the entity
(Inherited from IEntity.)
Public methodCheckData
Check the data of the entity
(Inherited from IEntity.)
Public methodClear
Clear the entity content and reinitialize it to the default value
(Inherited from IEntity.)
Public methodClone
Clone an entity
(Inherited from IEntity.)
Public methodCopyTo(IEntity)
Copy the entity content to another entity
(Inherited from IEntity.)
Public methodCopyTo(IEntity, Boolean)
Copy the entity content to another entity
(Inherited from IEntity.)
Public methodDelete
Method for delete a existing entity from the media
(Inherited from IEntity.)
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable.)
Public methodEdit
Method to pass in edit mode a existing entity in the media (for exemple, add a lock for database)
(Inherited from IEntity.)
Public methodGetExtension
Gets the extension.
(Inherited from IApiEntity.)
Public methodLoad
Method for loading the entity
(Inherited from IEntity.)
Public methodSave
Method for saving the entity to the media
(Inherited from IEntity.)
Public methodSetComplexMemberReadOnly
Set the read only property to a member
(Inherited from IEntity.)
Public methodShowMessage
Method to display a message. The message is displayed if the UI has connected to the ShowMessage event
(Inherited from IApiEntity.)
Top
Events
  NameDescription
Public eventModeChanged
Event raised on mode changed
(Inherited from IEntity.)
Top
See Also