Interface IDocument

The system entity for a Document, which allows for storing documents against any entities in the system

See https://web.lemonedge.com/help/documents/ for more information

Inherited Members
System.IEquatable<LemonEdge.API.Core.IBaseEntity>.Equals(LemonEdge.API.Core.IBaseEntity)
System.ComponentModel.INotifyPropertyChanged.PropertyChanged
System.ComponentModel.INotifyPropertyChanging.PropertyChanging
Namespace: LemonEdge.API.Entities
Assembly: API.dll
Syntax
[EntityDefinition(EntityID.Document, "dbo.LT_Documents", "Document", IsStandingDataEntity = false, LabelColumn = "Name")]
[DefaultEntityIcon(ImageType.Documents)]
public interface IDocument : IBaseEntityWithPermissions, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties, IHasVersion

Properties

Description

A user friendly description of the document

Declaration
[EntityProperty(SQLType.NVarChar, (short)2000, true)]
[EntityDescription("The document description.")]
string Description { get; set; }
Property Value
Type Description
System.String

EntityID

[Key] The globally unique id of the entity (of type EntityTypeID) that this document is stored agaisnt

Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[Required]
[EntityDescription("The id of the item this document is set against.")]
Guid EntityID { get; set; }
Property Value
Type Description
System.Guid

EntityTypeID

[Key] The type of entity this document is being stored against

Declaration
[EntityProperty(SQLType.UniqueIdentifier, false, IsEntityTypeLink = true)]
[EntityDescription("The item type this document is set against.")]
Guid EntityTypeID { get; set; }
Property Value
Type Description
System.Guid

FileType

The type of file ascertained from the file extension

Declaration
[EntityProperty(SQLType.NVarChar, (short)10, false)]
[EntityDescription("The document file type.")]
string FileType { get; set; }
Property Value
Type Description
System.String

Name

The name of the document ignoring any file extension

Declaration
[EntityProperty(SQLType.NVarChar, (short)500, false)]
[EntityDescription("The document name.")]
string Name { get; set; }
Property Value
Type Description
System.String

Extension Methods

See Also