Class ControlDisplayInfoLight

A light weight version of the ControlDisplayInfo that holds the most commonly used properties

The system uses this in a number of places to provide quick definitions for controls to use in a view. The system can the expand these into actual ControlDisplayInfo instances as required

Inheritance
object
ControlDisplayInfoLight
Inherited Members
Namespace: LemonEdge.Client.UI.API.Controls
Assembly: LemonEdge.Client.UI.API.dll
Syntax
public class ControlDisplayInfoLight

Constructors

ControlDisplayInfoLight(string, bool)

Creates a control display info light for the specified property name

Declaration
public ControlDisplayInfoLight(string name, bool editable)
Parameters
Type Name Description
string name

The name of the property on the object that this control is bound to
bool editable

Indicates if this control should be editable by the user or not

ControlDisplayInfoLight(string, string, bool)

Creates a control display info light for the specified property name

Declaration
public ControlDisplayInfoLight(string name, string parentPropertyName, bool editable)
Parameters
Type Name Description
string name

The name of the property on the object that this control is bound to
string parentPropertyName

The name of the property on which this property sits
bool editable

Indicates if this control should be editable by the user or not

ControlDisplayInfoLight(Type, string, string, string)

Creates a read-only control display info light that is not bound to a property on the object, and is instead responsible for evaluating the specified formula at run time and displaying the result

This is only compatible with the LemonEdge.Client.Core.Views.Core.IBaseDefaultSingleView<T>, not the grid, or any other view just now.

Declaration
public ControlDisplayInfoLight(Type propertyType, string propertyFormula, string userFriendlyName, string description = null)
Parameters
Type Name Description
Type propertyType

The type of value returned from the formula
string propertyFormula

The formula to evaluate at runtime and return the value of
string userFriendlyName
string description

Properties

AggregateFunction

In the case this control is within a LemonEdge.Client.Core.Views.Core.IBaseGrid<T> this can hold any aggregate function that should be applied to the results within the grid itself

Declaration
public AggregateFunction AggregateFunction { get; set; }
Property Value
Type Description
AggregateFunction

ColumnDescriptor

This holds the column descriptor from the PropertyName if the item is a IBaseEntity.

If this is null the system will automatically generate it correctly for the ControlDisplayInfo anyway

Declaration
public ColumnDescriptor ColumnDescriptor { get; set; }
Property Value
Type Description
ColumnDescriptor

CommentPropertyBinding

Declaration
public string CommentPropertyBinding { get; set; }
Property Value
Type Description
string

Editable

Indicates if this control should be editable by the user or not

Declaration
public bool Editable { get; set; }
Property Value
Type Description
bool

Format

Any custom formatting to apply to the displayed value on this control

The LemonEdge.Client.Core.Views.Core.CustomDateTimeFormat can be used for the correct date time formats to use, otherwise standard .net culture formatting applies

Declaration
public string Format { get; set; }
Property Value
Type Description
string

FormulaValue

If this is a read-only control display info light that evaluates formula instead of being bound to a property, then this specifies the formula to evaluate dynamically at runtime

This is only compatible with the LemonEdge.Client.Core.Views.Core.IBaseDefaultSingleView<T>, not the grid, or any other view just now.

Declaration
public string FormulaValue { get; }
Property Value
Type Description
string

FromExtendedType

Declaration
public Type FromExtendedType { get; set; }
Property Value
Type Description
Type

GroupKey

In the case this control is within a LemonEdge.Client.Core.Views.Core.IBaseGrid<T> this can hold the column group key it should belong to

Declaration
public string GroupKey { get; set; }
Property Value
Type Description
string

Height

The height to display this control at in compliant client UIs.

Null means use the standard height appropriate for this control.

0 means infinite
Declaration
public double? Height { get; set; }
Property Value
Type Description
double?

ParentPropertyName

If PropertyName actually belongs to another property on the object, then this property references that property name. For example, BaseEntity.OtherData.MainProperty means PropertyName is MainProperty, and ParentPropertyName is OtherData.

Declaration
public string ParentPropertyName { get; }
Property Value
Type Description
string

PropertyName

The name of the property on the object that this control is bound to

Declaration
public string PropertyName { get; }
Property Value
Type Description
string

PropertyType

If this is a read-only control display info light that evaluates formula instead of being bound to a property, then this specifies the value of the result returned by the FormulaValue

Declaration
public Type PropertyType { get; }
Property Value
Type Description
Type

UserFriendlyColumnName

By default the label in the ui will be the Wordify(string) version of the PropertyName

This provides a more specific user friendly version that can be used instead

Declaration
public string UserFriendlyColumnName { get; set; }
Property Value
Type Description
string

Visible

Indicates whether or not this control is visible to the user

Declaration
public bool Visible { get; set; }
Property Value
Type Description
bool

Width

The width to display this control at in compliant client UIs.

Null means use the standard width appropriate for this control.

0 means infinite
Declaration
public double? Width { get; set; }
Property Value
Type Description
double?

Extension Methods