Attributes

Attributes can be assigned to fields in model classes to modify their behavior on both the front end and the back end.

UIName

The UIName attribute sets the name of the record when searching for records in a select box from the UI.

Project.Common / Entities / Widget.cs

[Table(nameof(Widget))]
public class Widget
{
    public Guid WidgetId { get; set; }
    [UIName]
    public string WidgetName { get; set; }
}

[Table(nameof(Order))]
public class Order
{
    public Guid OrderId { get; set; }
    public Guid WidgetId { get; set; }
    public Widget Widget { get; set; }
    public int Quantity { get; set; }
}

UIDescription

The UIDescription attribute sets the description of the record when searching for records in a select box from the UI.

Project.Common / Entities / Widget.cs

[Table(nameof(Widget))]
public class Widget
{
    public Guid WidgetId { get; set; }
    [UIName]
    public string WidgetName { get; set; }
    [UIDescription]
    public string Information { get; set; }
}

[Table(nameof(Order))]
public class Order
{
    public Guid OrderId { get; set; }
    public Guid WidgetId { get; set; }
    public Widget Widget { get; set; }
    public int Quantity { get; set; }
}

UIDisplayName

The UIDisplayName attribute sets the label for the field on forms in the user interface (UI).

Project.Common / Entities / Widget.cs

[Table(nameof(Widget))]
public class Widget
{
    public Guid WidgetId { get; set; }
    [UIDisplayName("Serial Number")]
    public string Name { get; set; }
    public decimal Price { get; set; }
}

The UIRequired attribute ensures that a value is provided both on the UI and the backend. An asterisk will appear on the form, along with form validation. If the value is not provided and sent to the server, the server will return a 400 error.

Project.Common / Entities / Widget.cs

[Table(nameof(Widget))]
public class Widget
{
    public Guid WidgetId { get; set; }
    [UIRequired] // Add the UIRequired attribute to a field
    public string Name { get; set; }
    public decimal Price { get; set; }
}

UIRecommended

The UIRecommended attribute displays a blue cross, indicating to the user that filling out the field is recommended.

Project.Common / Entities / Widget.cs

[Table(nameof(Widget))]
public class Widget
{
    public Guid WidgetId { get; set; }
    public string Name { get; set; }
    [UIRecommended]
    public decimal Price { get; set; }
}

UIHide

The UIHide attribute ensures that a field is accessible only on the server within the service layer of your application. This field cannot be displayed in the user interface or queried from JavaScript.

Project.Common / Entities / Widget.cs

[Table(nameof(Widget))]
public class Widget
{
    public Guid WidgetId { get; set; }
    public string Name { get; set; }
    [UIHide] // Hide this field from the UI
    public decimal Price { get; set; }
}

The field can be made queryable by passing a value of true into the first parameter.

Project.Common / Entities / Widget.cs

[Table(nameof(Widget))]
public class Widget
{
    public Guid WidgetId { get; set; }
    public string Name { get; set; }
    [UIHide(true)] // Cannot but read from the UI but can be filtered on
    public decimal Price { get; set; }
}

UIReadOnly

The UIReadOnly attribute ensures that a field can only be read from the UI, even if the user has Update or Create permissions. The only way to update read-only fields is by using the DbContext directly to bypass the Service Logic pipeline.

Project.Common / Entities / Widget.cs

[Table(nameof(Widget))]
public class Widget
{
    public Guid WidgetId { get; set; }
    public string Name { get; set; }
    [UIReadOnly] // Field is read only from the UI
    public decimal Price { get; set; }
}

UIOption

The UIOption attribute allows the selection of an option record. Options are created from the Admin Dashboard.

Project.Common / Entities / Widget.cs

[Table(nameof(Widget))]
public class Widget
{
    public Guid WidgetId { get; set; }
    public string Name { get; set; }
    [UIOption("WidgetType")]
    public Guid? WidgetTypeId { get; set; }
    public Option WidgetType { get; set; }
}

UIDateFormat

The UIDateFormat attribute defines the display format for DateTime fields.

Set this parameter to any valid Day.js format.

Project.Common / Entities / Order.cs

[Table(nameof(Order))]
public class Order
{
    public Guid OrderId { get; set; }
    public Guid WidgetId { get; set; }
    public Widget Widget { get; set; }
    public int Quantity { get; set; }
    [UIDateFormat("lll")]
    public DateTime OrderDate { get; set; }
}