Interface ICustomViewControl

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

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

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

Properties

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?

CustomViewID

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

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

Format

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

Declaration
[EntityProperty(SQLType.NVarChar, 50, true)]
[EntityDescription("Any custom formatting to apply to the display for this control.")]
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

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
int

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
bool

IsEditableFormula

A formula, that evaluates to true or false, to use to indicate if this control should be editable or not

Declaration
[EntityProperty(SQLType.NVarChar, true)]
[EntityDescription("A formula, that evaluates to true or false, to use to indicate if this control should be editable or not - overrides IsEditable settings.")]
string IsEditableFormula { get; set; }
Property Value
Type Description
string

IsHtmlContent

Indicates that the control should be rendered as a HTML page. Will resize the control to take up all available space within the view.

Declaration
[EntityProperty(SQLType.Bit, false, "0")]
[EntityDescription("Indicates that the control should be rendered as a Html content. Will resize the control to take up all available space within the view.")]
[HardCodedDefaultValueOnNew("0")]
bool IsHtmlContent { get; set; }
Property Value
Type Description
bool

IsMultiline

Indicates that the text control should allow multi-line input. Will resize the control to take up all available space within the view.

Declaration
[EntityProperty(SQLType.Bit, false, "0")]
[EntityDescription("Indicates that the text control should allow multi-line input. Will resize the control to take up all available space within the view.")]
[HardCodedDefaultValueOnNew("0")]
bool IsMultiline { get; set; }
Property Value
Type Description
bool

IsRichText

Indicates that the text control should allow rich text.

Declaration
[EntityProperty(SQLType.Bit, false, "0")]
[EntityDescription("Indicates that the text control should allow rich text.")]
[HardCodedDefaultValueOnNew("0")]
bool IsRichText { get; set; }
Property Value
Type Description
bool

IsUri

Indicates that the control should be rendered as a HTML page. Will resize the control to take up all available space within the view.

Declaration
[EntityProperty(SQLType.Bit, false, "0")]
[EntityDescription("Indicates that the control should be rendered as a web page. Will resize the control to take up all available space within the view.")]
[HardCodedDefaultValueOnNew("0")]
bool IsUri { get; set; }
Property Value
Type Description
bool

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
bool

IsVisibleFormula

A formula, that evaluates to true or false, to use to indicate if this control should be visible or not

Declaration
[EntityProperty(SQLType.NVarChar, true)]
[EntityDescription("A formula, that evaluates to true or false, to use to indicate if this control should be visible or not - overrides IsVisible settings.")]
string IsVisibleFormula { get; set; }
Property Value
Type Description
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, 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
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 control should appear in the grid.

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

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 control - 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 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, 500, true)]
[EntityDescription("A custom user friendly label for this control - overrides the default.")]
string UserFriendlyLabel { get; set; }
Property Value
Type Description
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
int

Extension Methods

See Also