[DefaultOrderBy]

IntelliTect.Coalesce.DataAnnotations.DefaultOrderByAttribute

Allows setting of the default manner in which the data returned to the client will be sorted. Multiple fields can be used to sort an object by specifying an index.

This affects the sort order both when requesting a list of the model itself, as well as when the model appears as a child collection off of a navigation property of another object.

In the first case (a list of the model itself), this can be overridden by setting the orderBy or orderByDescending property on the TypeScript ListViewModel's $params.

Example Usage

public class Person
{
    public int PersonId { get; set; }
    
    public int DepartmentId { get; set; }

    [DefaultOrderBy(FieldOrder = 0, FieldName = nameof(Department.Order))]
    public Department Department { get; set; }
    
    [DefaultOrderBy(FieldOrder = 1)]
    public string LastName { get; set; }
}

public class Person
{
    public int PersonId { get; set; }
    
    public int DepartmentId { get; set; }

    [DefaultOrderBy(FieldOrder = 0, FieldName = nameof(Department.Order))]
    public Department Department { get; set; }
    
    [DefaultOrderBy(FieldOrder = 1)]
    public string LastName { get; set; }
}

Properties

// Also settable via constructor parameter #1
public int FieldOrder { get; set; } = 0; 

Specify the index of this field when sorting by multiple fields.

Lower-valued properties will be used first; higher-valued properties will be used as a tiebreaker (i.e. .ThenBy(...)).

// Also settable via constructor parameter #2
public OrderByDirections OrderByDirection { get; set; } = OrderByDirections.Ascending;

Specify the direction of the ordering for the property.

Enum values are:

• DefaultOrderByAttribute.OrderByDirections.Ascending
• DefaultOrderByAttribute.OrderByDirections.Descending

public string FieldName { get; set; }

When using the DefaultOrderByAttribute on an object property, specifies the field on the object to use for sorting. See the first example above.