Class Canvas

Inheritance
object
BaseEntity
BaseEntityWithPermissions
Canvas
Implements
Inherited Members
Namespace: LemonEdge.API.Entities.Data
Assembly: LemonEdge.API.Entities.Auto.dll
Syntax
[DataContract]
public class Canvas : BaseEntityWithPermissions, ICanvas, IUserSpecific, IBaseEntityWithPermissions, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties, ICloneableAsync<ICanvas>, IUserSpecificPublicToggle

Constructors

Canvas()

Declaration
public Canvas()

Properties

Color

Hex color value to display for this value in the title bar when in use

Declaration
[StringLength(10)]
public string Color { get; set; }
Property Value
Type Description
string

Description

A user friendly description of the purpose of this canvas

Declaration
[StringLength(2000)]
public string Description { get; set; }
Property Value
Type Description
string

IsPublic

Indicates if this entity is visible to all users (public), or just the current user (private).

Directly maps to UserID property

Declaration
[NotMapped]
public bool IsPublic { get; set; }
Property Value
Type Description
bool

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
public DateTimeOffset? LockAsOfDate { get; set; }
Property Value
Type Description
DateTimeOffset?

Name

[Key] The unique user friendly name for this canvas

Declaration
[Unique]
[Required]
[StringLength(500)]
public string Name { get; set; }
Property Value
Type Description
string

Status

The status for this canvas - only archived canvases can be deleted, and they are not visible by default in the UI

Declaration
[EnumDataType(typeof(CanvasStatus))]
public CanvasStatus Status { get; set; }
Property Value
Type Description
CanvasStatus

Status_Tooltip

Declaration
[NotMapped]
public string Status_Tooltip { get; set; }
Property Value
Type Description
string

UserID

Links to IUser. Indicates if this entity record is private to just the specified user, or if it is public to everyone (holding null)

Declaration
public Guid? UserID { get; set; }
Property Value
Type Description
Guid?

UserID_Label

Declaration
public string UserID_Label { get; set; }
Property Value
Type Description
string

UserID_Label_Silent

Declaration
[NotMapped]
public string UserID_Label_Silent { get; set; }
Property Value
Type Description
string

Methods

CopyFromEntity(IBaseEntity)

Declaration
protected override void CopyFromEntity(IBaseEntity src)
Parameters
Type Name Description
IBaseEntity src
Overrides

CopyFromSource(ICanvas)

Updates all properties in this item to have the same properties as the source object.

Declaration
public void CopyFromSource(ICanvas source)
Parameters
Type Name Description
ICanvas source

The source object to copy all values from.

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides

Implements

Extension Methods