Interface ICustomImage
The system entity for a Custom Image, which holds images that can be configured to be used throughout the application
See https://web.lemonedge.com/help/custom-images/ 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.CustomImages, "dbo.LT_CustomImages", "CustomImage", LabelColumn = "Name", IsStandingDataEntity = true, HelpURL = "custom-images")]
[DefaultEntityIcon(ImageType.Image)]
public interface ICustomImage : IBaseEntityWithPermissions, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties
Properties
Description
A helpful description of the image
Declaration
[EntityProperty(SQLType.NVarChar, (short)2500, true)]
[EntityDescription("Description of this image.")]
string Description { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Image
The image file to use.
Declaration
[EntityProperty(SQLType.VarBinary, false)]
[EntityDescription("The custom image.")]
byte[] Image { get; set; }
Property Value
Type | Description |
---|---|
System.Byte[] |
ImageID
This is the unique ID for this image to be used when referring to it from code. This ID enables the Custom Image to be reused across multiple different databases and still referenced by the same AddIn Modules and custom code.
Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
Guid ImageID { get; set; }
Property Value
Type | Description |
---|---|
System.Guid |
Name
A unique user friendly name to identify this image.
Declaration
[EntityProperty(SQLType.NVarChar, (short)500, false)]
[EntityDescription("The unique name of this custom image.")]
[Required]
string Name { get; set; }
Property Value
Type | Description |
---|---|
System.String |