Interface ICustomGrid

The system entity for a Custom Grid, which holds the design for a grid

See https://help.lemonedge.com/help/api/auto-code-designers/custom-grids/intro.html for more information

Inherited Members
Namespace: LemonEdge.API.Entities.Design
Assembly: LemonEdge.API.dll
Syntax
[EntityDefinition(EntityID.CustomGrid, "dbo.LT_CustomGrids", "CustomGrid", LabelColumn = "Name", IsStandingDataEntity = true, HelpURL = "help/api/auto-code-designers/custom-grids/intro.html")]
[DefaultEntityIcon(ImageType.Grid)]
public interface ICustomGrid : IBaseEntityWithPermissions, ISetCopier, IShareAcrossAccounts, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties

Properties

AllowAutoCreateLookupEntity

Indicates user should be allowed to create a new row linked to the lookup column, or provided an option to create a new instance of the lookup item and link to the new instance.

Declaration
[EntityProperty(SQLType.Bit, false, "0")]
[EntityDescription("Indicates user should be allowed to create a new row linked to the lookup column, or provided an option to create a new instance of the lookup item and link to the new instance.")]
bool AllowAutoCreateLookupEntity { get; set; }
Property Value
Type Description
bool

AutoOpenNewItems

This indicates when a new item is created in the grid if it should open in its own tab too

Declaration
[EntityProperty(SQLType.Bit, false, "0")]
[EntityDescription("This indicates when a new item is created in the grid if it should open in its own tab too.")]
bool AutoOpenNewItems { get; set; }
Property Value
Type Description
bool

CodeSnippetID

[Key] Links to ICodeSnippet. An optional code snippet for processing custom process in this custom grid

Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.CodeSnippet, "ID", SingleJoinType.ZeroToOne, "Code Snippet", "Custom Grids", DeleteWithRelationship = false, PartOfParentSet = false, InheritPermissions = false, LinkToItemInSet = true)]
Guid? CodeSnippetID { get; set; }
Property Value
Type Description
Guid?

DefaultColumnToSortBy

Name of column to sort by

Declaration
[EntityProperty(SQLType.NVarChar, 500, true)]
[EntityDescription("Name of column to sort by default.")]
string DefaultColumnToSortBy { get; set; }
Property Value
Type Description
string

DefaultSortDirection

The default order to sort the default column by.

Declaration
[EntityProperty(SQLType.SmallInt, false)]
[EntityDescription("The default order to sort the default column by.")]
Order DefaultSortDirection { get; set; }
Property Value
Type Description
Order

Description

A user friendly description of this grid

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

EnableCreateNewItem

This indicates if create new item option is enabled or not in the grid

Declaration
[EntityProperty(SQLType.Bit, false, "1")]
[EntityDescription("This indicates if create new item button is enabled or not in the grid.")]
[HardCodedDefaultValueOnNew("True")]
bool EnableCreateNewItem { get; set; }
Property Value
Type Description
bool

EnableDeleteItem

This indicates if delete item option is enabled or not in the grid

Declaration
[EntityProperty(SQLType.Bit, false, "1")]
[EntityDescription("This indicates if delete item button is enabled or not in the grid.")]
[HardCodedDefaultValueOnNew("True")]
bool EnableDeleteItem { get; set; }
Property Value
Type Description
bool

EntityTypeID

Indicates which entity you want to design a grid for.

Declaration
[EntityProperty(SQLType.UniqueIdentifier, false, IsEntityTypeLink = true)]
[RequiredNoDefaultIDValidation]
[EntityDescription("Holds the entity type this view ccan display information for.")]
Guid EntityTypeID { get; set; }
Property Value
Type Description
Guid

HelpURL

A custom url for help on this view

Declaration
[EntityProperty(SQLType.NVarChar, 500, true)]
string HelpURL { get; set; }
Property Value
Type Description
string

IconID

The icon for this grid

Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityDescription("The icon for this view.")]
Guid IconID { get; set; }
Property Value
Type Description
Guid

LoadDynamically

This indicates the system will dynamically load your Grid into UI client applications immediately.

The alternative is the designer can provide you the actual code for this grid.You can incorporate that code in your own DLL and add that as an Add-In to the platform itself using our Add-In Modules.

Declaration
[EntityProperty(SQLType.Bit, false, "0")]
[EntityDescription("Indicates this custom grid definition is to be dynamically loaded into the system. When set to false, you can export the code and incorporate into your own addin dll.")]
bool LoadDynamically { get; set; }
Property Value
Type Description
bool

Name

[Key] A friendly uniquely identifying name for this grid

Declaration
[EntityProperty(SQLType.NVarChar, 500, false)]
[EntityKeyProperty]
[EntityDescription("The unique name of this custom grid.")]
[Unique]
[Required]
string Name { get; set; }
Property Value
Type Description
string

PopulateNewFromLookupColumnName

Indicates a popup should auto display allow selection of the item for any new item.

Declaration
[EntityProperty(SQLType.NVarChar, 500, true)]
[EntityDescription("Indicates a popup should auto display allow selection of the item for any new item.")]
string PopulateNewFromLookupColumnName { get; set; }
Property Value
Type Description
string

RelatedParentEntityTypeID

Indicates the parent entity these entites in the grid are related to.

Declaration
[EntityProperty(SQLType.UniqueIdentifier, true, IsEntityTypeLink = true)]
[EntityDescription("Indicates the parent entity these entites in the grid are related to.")]
Guid? RelatedParentEntityTypeID { get; set; }
Property Value
Type Description
Guid?

RelatedParentEntityTypeIDProperty

Indicates the property on these grid entites that relates them to the RelatedParentEntityTypeID.

Declaration
[EntityProperty(SQLType.NVarChar, 500, true)]
[EntityDescription("Indicates the property on these grid entites that relates them to the RelatedParentEntityTypeID.")]
[PropertyValidation("MyItem.RelatedParentEntityTypeID.HasValue", "!string.IsNullOrEmpty(MyItem.RelatedParentEntityTypeIDProperty)", "The related parent entity property must have a relationship value selected from the EntityType to the RelatedParentEntityType.")]
string RelatedParentEntityTypeIDProperty { get; set; }
Property Value
Type Description
string

ReplaceCoreView

Provides a list of other grids in the system for this Entity Type. You can override any of those grids with this Custom Grid. Whenever the system would load that grid, if you've overridden it, then it will load this one instead.

Declaration
[EntityProperty(SQLType.NVarChar, 250, true, FriendlyLabel = "Replace System View")]
[EntityDescription("Indicates this grid should replace the specified system view, whenever it is referenced in a layout, this view will be used instead.")]
string ReplaceCoreView { get; set; }
Property Value
Type Description
string

Extension Methods

See Also