Class CustomGridColumn
Inheritance
CustomGridColumn
Assembly: LemonEdge.API.Entities.Auto.dll
Syntax
[DataContract]
public class CustomGridColumn : BaseEntity, ICustomGridColumn, IShareAcrossAccounts, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties, ICloneableAsync<ICustomGridColumn>
Constructors
CustomGridColumn()
Declaration
public CustomGridColumn()
Properties
AggregateFunction
Indicates any aggregate function to apply to footer/groupings of this column.
Declaration
[EnumDataType(typeof(AggregateFunction))]
public AggregateFunction AggregateFunction { get; set; }
Property Value
Declaration
[NotMapped]
public string AggregateFunction_Tooltip { get; set; }
Property Value
AllowFiltering
Indicates if the user can filter by this column.
Declaration
public bool AllowFiltering { get; set; }
Property Value
AllowSorting
Indicates if the user can sort by this column.
Declaration
public bool AllowSorting { get; set; }
Property Value
CustomGridID
[Key] Links to ICustomGrid. The parent custom grid this entity is a member of
Declaration
public Guid? CustomGridID { get; set; }
Property Value
CustomGridID_Label
Declaration
public string CustomGridID_Label { get; set; }
Property Value
CustomGridID_Label_Silent
Declaration
[NotMapped]
public string CustomGridID_Label_Silent { get; set; }
Property Value
CustomLookupQueryFilterID
[Key] Links to ICustomLookupQuery. The custom lookup query to use for selecting this value
Declaration
public Guid? CustomLookupQueryFilterID { get; set; }
Property Value
CustomLookupQueryFilterID_Label
Declaration
public string CustomLookupQueryFilterID_Label { get; set; }
Property Value
CustomLookupQueryFilterID_Label_Silent
Declaration
[NotMapped]
public string CustomLookupQueryFilterID_Label_Silent { get; set; }
Property Value
Any custom formatting to apply to the display for this column.
Declaration
[StringLength(50)]
public string Format { get; set; }
Property Value
The formula to use to evaluate the value that should be displayed against this control
Declaration
[PropertyValidation("!string.IsNullOrEmpty(MyItem.PropertyType)", "!string.IsNullOrEmpty(MyItem.FormulaValue)", "You must enter a FormulaValue for use with a PropertyType.")]
public string FormulaValue { get; set; }
Property Value
GroupinName
The grouping name to apply to this column header.
Declaration
[StringLength(500)]
public string GroupinName { get; set; }
Property Value
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
public bool IsEditable { get; set; }
Property Value
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
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
public bool IsVisible { get; set; }
Property Value
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
[PropertyValidation("string.IsNullOrEmpty(MyItem.PropName)", "!string.IsNullOrEmpty(MyItem.PropertyType)", "You must select PropertyName or a PropertyType with a FormulaValue.")]
[StringLength(500)]
public string PropName { get; set; }
Property Value
PropertyEntityType
The type of entity if this control is using a formula that returns an id to a unique entity in the system
Declaration
public Guid? PropertyEntityType { get; set; }
Property Value
PropertyType
The type of property for this control if using a formula. Can be blank if using a direct Property instead
Declaration
[PropertyValidation("string.IsNullOrEmpty(MyItem.PropertyType)", "!string.IsNullOrEmpty(MyItem.PropName)", "You must select PropertyName or a PropertyType with a FormulaValue.")]
[StringLength(500)]
public string PropertyType { get; set; }
Property Value
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
public short Sequence { get; set; }
Property Value
SortOrder
Indicates the default order for the grid
Declaration
[EnumDataType(typeof(Order))]
public Order SortOrder { get; set; }
Property Value
Declaration
[NotMapped]
public string SortOrder_Tooltip { get; set; }
Property Value
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
[StringLength(500)]
public string Tooltip { get; set; }
Property Value
TransactionCodeID
Declaration
public Guid? TransactionCodeID { get; set; }
Property Value
TransactionCodeID_Label
Declaration
public string TransactionCodeID_Label { get; set; }
Property Value
TransactionCodeID_Label_Silent
Declaration
[NotMapped]
public string TransactionCodeID_Label_Silent { get; set; }
Property Value
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
[StringLength(500)]
public string UserFriendlyLabel { get; set; }
Property Value
Width
The width of this column.
Declaration
public int Width { get; set; }
Property Value
Methods
CopyFromEntity(IBaseEntity)
Declaration
protected override void CopyFromEntity(IBaseEntity src)
Parameters
Overrides
CopyFromSource(ICustomGridColumn)
Updates all properties in this item to have the same properties as the source object.
Declaration
public void CopyFromSource(ICustomGridColumn source)
Parameters
| Type |
Name |
Description |
| ICustomGridColumn |
source |
The source object to copy all values from.
|
ToString()
Declaration
public override string ToString()
Returns
Overrides
Implements
Extension Methods