Interface IDataTemplate
The system entity for data templates which can be used when exporting data into excel
See https://web.lemonedge.com/help/excel-templates/ 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.DataTemplate, "dbo.LT_DataTemplates", "DataTemplate", IsStandingDataEntity = true, HelpURL = "excel-templates", LabelColumn = "Name")]
[DefaultEntityIcon(ImageType.ExcelTemplate)]
[EntityLinkToAnyParentRelationshipModifier(EntityID.SQLWrapper, "OwnerEntityID", "ID", ExcludeFromRelationship = true)]
public interface IDataTemplate : IBaseEntityWithPermissions, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties, ISetCopier, IUserSpecific, IHasVersion
Properties
Description
The user friendly description for this template
Declaration
[EntityProperty(SQLType.NVarChar, (short)2500, true)]
[EntityDescription("The user friendly description for this template.")]
string Description { get; set; }
Property Value
Type | Description |
---|---|
System.String |
EntityTypeID
Indicates this is a template for data exported straight from this specified entity type.
Declaration
[EntityProperty(SQLType.UniqueIdentifier, true, IsEntityTypeLink = true)]
[EntityDescription("Indicates this is a template for data exported straight from this specified entity type.")]
Guid? EntityTypeID { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Guid> |
Name
The unique user friendly name of this template
Declaration
[EntityProperty(SQLType.NVarChar, (short)500, false)]
[EntityDescription("The unique user friendly name of this template.")]
[Required]
string Name { get; set; }
Property Value
Type | Description |
---|---|
System.String |
QueryRunnerID
Indicates this is a template for data exported straight from this specified IQueryRunner.
Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.QueryRunner, "ID", SingleJoinType.ZeroToOne, "Template For Query Runner", "Templates", DeleteWithRelationship = true, PartOfParentSet = true, LinkToItemInSet = true, InheritPermissions = false)]
[EntityDescription("Indicates this is a template for data exported straight from this specified Query Runner.")]
Guid? QueryRunnerID { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Guid> |
SQLWrapperID
Indicates this is a template for data exported straight from this specified ISQLWrapper.
Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.SQLWrapper, "ID", SingleJoinType.ZeroToOne, "Template For SQL Wrapper", "Templates", DeleteWithRelationship = true, PartOfParentSet = true, LinkToItemInSet = true, InheritPermissions = false)]
[EntityDescription("Indicates this is a template for data exported straight from this specified SQL Wrapper.")]
Guid? SQLWrapperID { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Guid> |
Type
The type of document template this data is exported into
Declaration
[EntityProperty(SQLType.SmallInt, false)]
[EntityDescription("The type of document template this data is exported into.")]
DataTemplateType Type { get; set; }
Property Value
Type | Description |
---|---|
DataTemplateType |