Interface ICustomViewControl

The system entity for a Custom View Control, which belongs to a ICustomView holding the design for a view

See https://web.lemonedge.com/help/custom-view-controls-view/ 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.CustomViewControl, "dbo.LT_CustomViewControls", "CustomViewControl", LabelColumn = "PropName", IsStandingDataEntity = true)]
[DefaultEntityIcon(ImageType.CustomViewControl)]
public interface ICustomViewControl : IShareAcrossAccounts, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties

Properties

CustomViewID

[Key] Links to ICustomView. The parent view this entity belongs to

Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityRelationship(EntityID.CustomView, "ID", SingleJoinType.One, "CustomView", "CustomViewControl", DeleteWithRelationship = true, PartOfParentSet = true, InheritPermissions = true)]
Guid CustomViewID { get; set; }
Property Value
Type Description
System.Guid

Format

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

Declaration
[EntityProperty(SQLType.NVarChar, (short)50, true)]
[EntityDescription("Any custom formatting to apply to the display for this control.")]
string Format { get; set; }
Property Value
Type Description
System.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
System.String

Height

Optional. Specifies the height to use for this control.If 0 the default control height is used to ensure all controls are inline.

Declaration
[EntityProperty(SQLType.Int, false)]
[EntityDescription("The height of this control.")]
int Height { get; set; }
Property Value
Type Description
System.Int32

IsEditable

Indicates if the user has permission that they can edit the data in this control. If they do not 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 control can be edited by the user.")]
[HardCodedDefaultValueOnNew("1")]
bool IsEditable { get; set; }
Property Value
Type Description
System.Boolean

IsVisible

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

The control can also have a formula against it for conditional visibility should you require it.

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

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, (short)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
System.String

PropName

The name of the property you want to appear as a control in the view. Can be blank if using a PropertyType and Formula value instead.

Declaration
[EntityProperty(SQLType.NVarChar, (short)500, true)]
[EntityDescription("The name of the property you want to appear as a control in the view. Should be blank if using a PropertyType and Formula value instead.")]
[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
System.String

Sequence

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

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

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, (short)500, true)]
[EntityDescription("A custom tooltip for this control - overrides the default.")]
string Tooltip { get; set; }
Property Value
Type Description
System.String

UserFriendlyLabel

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

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

Width

Optional - Specifies the width to use for this control.If 0 the default control width for this type of control is used.The defaults used in the system are as follows:

  • Small: 100
  • Normal: 175
  • Large: 400
Declaration
[EntityProperty(SQLType.Int, false)]
[EntityDescription("The width of this control.")]
int Width { get; set; }
Property Value
Type Description
System.Int32

Extension Methods

See Also