Interface ICanvas

The system entity for a Canvas

See https://web.lemonedge.com/help/canvases/ 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.Canvas, "dbo.LT_Canvases", "Canvas", LabelColumn = "Name", IsStandingDataEntity = false, HelpURL = "canvases")]
[DefaultEntityIcon(ImageType.Canvas)]
public interface ICanvas : IUserSpecific, IBaseEntityWithPermissions, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties

Properties

Description

A user friendly description of the purpose of this canvas

Declaration
[EntityProperty(SQLType.NVarChar, (short)2000, true)]
[EntityDescription("A user friendly description of this canvas function.")]
string Description { get; set; }
Property Value
Type Description
System.String

LockAsOfDate

The date/time that the canvas should use to pull data from the main system up to.

By default this is blank meaning a canvas always runs on top of the latest data from the main system.

By having a Lock As Of Date you are saying the canvas is effectively a copy of the entire system as of that point in time that you can apply changes on top of.
Declaration
[EntityProperty(SQLType.DateTimeOffset, true)]
[EntityDescription("The date time you want this 'As Of'. i.e. changes in the Main system made after this date won't be visible in the canvas. \r\nIf this is blank the canvas runs in its default mode of always surfacing changes from the main system and layering canvas changes on top.")]
DateTimeOffset? LockAsOfDate { get; set; }
Property Value
Type Description
System.Nullable<System.DateTimeOffset>

Name

[Key] The unique user friendly name for this canvas

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

Extension Methods

See Also