Interface ICustomGridColumn

The system entity for a Custom Grid Column, which belongs to a ICustomGrid holding the design for a grid

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

Inherited Members
Namespace: LemonEdge.API.Entities.Design
Assembly: LemonEdge.API.dll
Syntax
[EntityDefinition(EntityID.CustomGridColumn, "dbo.LT_CustomGridColumns", "CustomGridColumn", LabelColumn = "PropName", IsStandingDataEntity = true)]
[DefaultEntityIcon(ImageType.DataTableColumn)]
[EntityIndex(Name = "CustromColumns", ColumnNames = new string[] { "CustomGridID" }, IndexOrder = new IndexOrder[] { IndexOrder.Ascending }, IsClustered = false, IsUnique = false)]
public interface ICustomGridColumn : IShareAcrossAccounts, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties

Properties

AggregateFunction

Indicates any aggregate function to apply to footer/groupings of this column.

Declaration
[EntityProperty(SQLType.SmallInt, false)]
[EntityDescription("Indicates any aggregate function to apply to footer/groupings of this column.")]
[HardCodedDefaultValueOnNew("0")]
AggregateFunction AggregateFunction { get; set; }
Property Value
Type Description
AggregateFunction

AllowFiltering

Indicates if the user can filter by this column.

Declaration
[EntityProperty(SQLType.Bit, false)]
[EntityDescription("Indicates if the user can filter by this column.")]
[HardCodedDefaultValueOnNew("1")]
bool AllowFiltering { get; set; }
Property Value
Type Description
bool

AllowSorting

Indicates if the user can sort by this column.

Declaration
[EntityProperty(SQLType.Bit, false)]
[EntityDescription("Indicates if the user can sort by this column.")]
[HardCodedDefaultValueOnNew("1")]
bool AllowSorting { get; set; }
Property Value
Type Description
bool

CustomGridID

[Key] Links to ICustomGrid. The parent custom grid this entity is a member of

Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.CustomGrid, "ID", SingleJoinType.ZeroToOne, "Custom Grid", "Columns", DeleteWithRelationship = true, PartOfParentSet = true, InheritPermissions = true)]
[EntityKeyProperty]
Guid? CustomGridID { get; set; }
Property Value
Type Description
Guid?

CustomLookupQueryFilterID

[Key] Links to ICustomLookupQuery. The custom lookup query to use for selecting this value

Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.CustomLookupQuery, "ID", SingleJoinType.ZeroToOne, "Custom Lookup Query", "Custom Views", DeleteWithRelationship = false, PartOfParentSet = false, LinkToItemInSet = true, InheritPermissions = false)]
[EntityDescription("The custom lookup query to use for selecting this value.")]
Guid? CustomLookupQueryFilterID { get; set; }
Property Value
Type Description
Guid?

Format

Any custom formatting to apply to the display for this column.

Declaration
[EntityProperty(SQLType.NVarChar, 50, true)]
[EntityDescription("Any custom formatting to apply to the display for this column.")]
string Format { get; set; }
Property Value
Type Description
string

FormulaValue

The formula to use to evaluate the value that should be displayed against this control

Declaration
[EntityProperty(SQLType.NVarChar, true)]
[EntityDescription("The formula to use to evaluate the value that should be displayed against this control.")]
[PropertyValidation("!string.IsNullOrEmpty(MyItem.PropertyType)", "!string.IsNullOrEmpty(MyItem.FormulaValue)", "You must enter a FormulaValue for use with a PropertyType.")]
string FormulaValue { get; set; }
Property Value
Type Description
string

GroupinName

The grouping name to apply to this column header.

Declaration
[EntityProperty(SQLType.NVarChar, 500, true)]
[EntityDescription("The grouping name to apply to this column header.")]
string GroupinName { get; set; }
Property Value
Type Description
string

IsEditable

Indicates if the user has permission that they can edit the data in this column. If they don't have permissions they will be unable to edit this field regardless if it is true or not.

Declaration
[EntityProperty(SQLType.Bit, false)]
[EntityDescription("Indicates if the data in this column can be edited by the user.")]
[HardCodedDefaultValueOnNew("1")]
bool IsEditable { get; set; }
Property Value
Type Description
bool

IsVisible

Indicates if this column should initially be visible to the user.

If not the user can still make it visible through our standard grid commands and can see the data when exporting the grid to excel.

Declaration
[EntityProperty(SQLType.Bit, false)]
[EntityDescription("Indicates if this column is visible by default to the user.")]
[HardCodedDefaultValueOnNew("1")]
bool IsVisible { get; set; }
Property Value
Type Description
bool

PropName

The name of the property you want to appear as a column in the grid.

The system provides a drop down list of all properties against the Entity Type of this Custom Grid.

Declaration
[EntityProperty(SQLType.NVarChar, 500, true)]
[EntityDescription("The property of the entity to display in this custom grid.")]
[PropertyValidation("string.IsNullOrEmpty(MyItem.PropName)", "!string.IsNullOrEmpty(MyItem.PropertyType)", "You must select PropertyName or a PropertyType with a FormulaValue.")]
string PropName { get; set; }
Property Value
Type Description
string

PropertyEntityType

The type of entity if this control is using a formula that returns an id to a unique entity in the system

Declaration
[EntityProperty(SQLType.UniqueIdentifier, true, IsEntityTypeLink = true)]
[EntityDescription("The type of entity if this control is using a formula that returns an id to a unique entity in the system.")]
Guid? PropertyEntityType { get; set; }
Property Value
Type Description
Guid?

PropertyType

The type of property for this control if using a formula. Can be blank if using a direct Property instead

Declaration
[EntityProperty(SQLType.NVarChar, 500, true)]
[EntityDescription("The type of property for this control if using a formula. Should be blank if using a direct Property instead.")]
[PropertyValidation("string.IsNullOrEmpty(MyItem.PropertyType)", "!string.IsNullOrEmpty(MyItem.PropName)", "You must select PropertyName or a PropertyType with a FormulaValue.")]
string PropertyType { get; set; }
Property Value
Type Description
string

Sequence

[Key] The sequence specifies which order this column should appear in the grid.

This field is hidden in the grid, but you can show it using our standard grid commands. You can easily change it using the Move Up/Down commands too.

Declaration
[EntityProperty(SQLType.SmallInt, false)]
[EntityDescription("Holds the order of this column within the whole custom grid.")]
[EntitySequence]
[EntityKeyProperty]
short Sequence { get; set; }
Property Value
Type Description
short

SortOrder

Indicates the default order for the grid

Declaration
[EntityProperty(SQLType.SmallInt, false, "0", FriendlyLabel = "Order")]
[EntityDescription("Indicates the default order for the grid.")]
Order SortOrder { get; set; }
Property Value
Type Description
Order

Tooltip

By default the tooltip will be the description (if any) of this property against the entity in the design. You can override that by putting a custom tooltip here.

Declaration
[EntityProperty(SQLType.NVarChar, 500, true)]
[EntityDescription("A custom tooltip for this column - overrides the default.")]
string Tooltip { get; set; }
Property Value
Type Description
string

TransactionCodeID

Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.TransactionCode, "ID", SingleJoinType.ZeroToOne, "Custom View", "Transaction Code", DeleteWithRelationship = true, PartOfParentSet = true, InheritPermissions = true)]
[EntityKeyProperty]
Guid? TransactionCodeID { get; set; }
Property Value
Type Description
Guid?

UserFriendlyLabel

The column name will by default be the property name or the user friendly version of it. You can override that by putting a custom column header name here.

Declaration
[EntityProperty(SQLType.NVarChar, 500, true)]
[EntityDescription("A custom user friendly label for this column - overrides the default.")]
string UserFriendlyLabel { get; set; }
Property Value
Type Description
string

Width

The width of this column.

Declaration
[EntityProperty(SQLType.Int, false)]
[EntityDescription("The width of this column.")]
int Width { get; set; }
Property Value
Type Description
int

Extension Methods

See Also