Class AddIn

Inheritance
object
BaseEntity
AddIn
Implements
Inherited Members
Namespace: LemonEdge.API.Entities.Design
Assembly: LemonEdge.API.Entities.Auto.dll
Syntax
[DataContract]
[MultipleUnique(new string[] { "Name", "AddInModuleID" })]
public class AddIn : BaseEntity, IAddIn, IShareAcrossAccounts, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties, ICloneableAsync<IAddIn>

Constructors

AddIn()

Declaration
public AddIn()

Properties

Active

Indicates whether or not this AddIn is active and should be loaded by the LemonEdge platform. Inactive AddIns are ignored.

Declaration
public bool Active { get; set; }
Property Value
Type Description
bool

AddInData

Holds the actuall raw .net custom dll. If null then the addin is asssumed to come from NuGet repositories.

Declaration
public byte[] AddInData { get; set; }
Property Value
Type Description
byte[]

AddInModuleID

Links to IAddInModule. The parent module this add in belongs to

Declaration
[RequiredNoDefaultIDValidation]
public Guid AddInModuleID { get; set; }
Property Value
Type Description
Guid

AddInModuleID_Label

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

AddInModuleID_Label_Silent

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

BaseHelpURL

A custom base url for help on this addin. Overrides the settings at the module level

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

Description

A user friendly description of this add in

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

IsConsoleOnlyUI

Indicates this contains UI code that can only be shown by the console application and thus will only be loaded by that client application. If you create a custom view you will need to create that custom view for all client applications that will need to access it.

Declaration
[PropertyValidation("MyItem.IsConsoleOnlyUI == true", "MyItem.IsWPFOnlyUI == false && MyItem.IsXamarinOnlyUI == false && MyItem.IsCore == false", "Console UI can only be marked as true if WPF and Xamarin are false.")]
public bool IsConsoleOnlyUI { get; set; }
Property Value
Type Description
bool

IsCore

Indicates this dll is core and should be loaded in all services/clients/etc as it contains entity class definitions, processes and core functionality.

Declaration
[PropertyValidation("MyItem.IsCore == true", "MyItem.IsWPFOnlyUI == false && MyItem.IsXamarinOnlyUI == false && MyItem.IsConsoleOnlyUI == false", "Is Core can only be marked as true if WPF and Xamarin UI are false.")]
public bool IsCore { get; set; }
Property Value
Type Description
bool

IsCoreUI

Indicates this dll has core UI implementations and should be loaded in all clients applications (android/ios/console/windows/etc).

Declaration
[PropertyValidation("MyItem.IsCoreUI == true", "MyItem.IsCore == false", "Is Core UI can only be marked as true if IsCore is set to false. Core UI dlls can not be loaded into services/etc.")]
[PropertyValidation("MyItem.IsCoreUI == true", "MyItem.IsWPFOnlyUI == false && MyItem.IsXamarinOnlyUI == false && MyItem.IsConsoleOnlyUI == false", "Is Core UI can only be marked as true if individual UI's are false. Is Core UI indicates they will be loaded into all clients (xamarin/console/wpf) regardless.")]
public bool IsCoreUI { get; set; }
Property Value
Type Description
bool

IsFromNuget

Indicates whether or not this AddIn is fetched from Nuget Package Manager.

Declaration
public bool IsFromNuget { get; set; }
Property Value
Type Description
bool

IsShared

Indicates this record is a shared record. Only the root account can edit items that are shared records

Declaration
public bool IsShared { get; set; }
Property Value
Type Description
bool

IsWPFOnlyUI

Indicates this contains UI code that can only be shown by the WPF Windows only application and thus will only be loaded by that client application. If you create a custom view you will need to create that custom view for all client applications that will need to access it.

Declaration
[PropertyValidation("MyItem.IsWPFOnlyUI == true", "MyItem.IsXamarinOnlyUI == false && MyItem.IsConsoleOnlyUI == false && MyItem.IsCore == false", "WPF UI can only be marked as true if Xamarin, Console and IsCore are false.")]
public bool IsWPFOnlyUI { get; set; }
Property Value
Type Description
bool

IsXamarinOnlyUI

Indicates this contains UI code that can only be shown by the mobile xamarin application and thus will only be loaded by that client application. If you create a custom view you will need to create that custom view for all client applications that will need to access it.

Declaration
[PropertyValidation("MyItem.IsXamarinOnlyUI == true", "MyItem.IsWPFOnlyUI == false && MyItem.IsConsoleOnlyUI == false && MyItem.IsCore == false", "Xamarin UI can only be marked as true if WPF, Console and IsCore are false.")]
public bool IsXamarinOnlyUI { get; set; }
Property Value
Type Description
bool

Name

The unique friendly name of this add in

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

Sequence

The sequence this AddIn is loaded in to the system relative to other addin within this AddIn Module.

Declaration
public short Sequence { get; set; }
Property Value
Type Description
short

Methods

CopyFromEntity(IBaseEntity)

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

CopyFromSource(IAddIn)

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

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

The source object to copy all values from.

ToString()

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

Implements

Extension Methods