Interface ICustomGrid

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

See https://web.lemonedge.com/help/custom-grids/ 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.CustomGrid, "dbo.LT_CustomGrids", "CustomGrid", LabelColumn = "Name", IsStandingDataEntity = true, HelpURL = "custom-grids")]
[DefaultEntityIcon(ImageType.Grid)]
public interface ICustomGrid : IBaseEntityWithPermissions, ISetCopier, IShareAcrossAccounts, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties

Properties

DefaultColumnToSortBy

Name of column to sort by

Declaration
[EntityProperty(SQLType.NVarChar, (short)500, true)]
[EntityDescription("Name of column to sort by default.")]
string DefaultColumnToSortBy { get; set; }
Property Value
Type Description
System.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, (short)2000, true)]
[EntityDescription("A user friendly description of this custom view.")]
string Description { get; set; }
Property Value
Type Description
System.String

EntityTypeID

Indicates which entity you want to design a grid for.

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

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
System.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
System.Boolean

Name

[Key] A friendly uniquely identifying name for this grid

Declaration
[EntityProperty(SQLType.NVarChar, (short)500, false)]
[EntityDescription("The unique name of this custom grid.")]
[Required]
string Name { get; set; }
Property Value
Type Description
System.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, (short)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
System.String

Extension Methods

See Also