Class DefaultListSpec

Namespace

The.Web.Entities

Assembly

Instagile.Web.Client.dll

Default IListSpec: scaffolds an entity's list/summary columns, producing a ColumnSpec (binding + CellSpec + read-access gate) per shown property. Override the Define* hooks to customise; applications usually subclass the typed DefaultListSpec<T>.

public class DefaultListSpec : IListSpec

Inheritance

object

DefaultListSpec

Implements

IListSpec

Derived

DefaultListSpec<T>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

CreateLoadQuery(IEntityInfo, IEntityContext)

The query that supplies the list's rows: all of the entity type by default. Hosts filter it (search criteria, reminders), and the list machinery orders, pages and preloads it.

public virtual IEntityQuery<IEntity> CreateLoadQuery(IEntityInfo metadata, IEntityContext context)

Parameters

metadata IEntityInfo

context IEntityContext

Returns

IEntityQuery<IEntity>

DefineAccess(PropertyInfo)

Returns the entity type for which read permission is required in order to display a column.

protected virtual IEntityInfo? DefineAccess(PropertyInfo metadata)

Parameters

metadata PropertyInfo

Returns

IEntityInfo

DefineAttributeBinding(AttributeInfo)

[Obsolete("Override DefineBinding(PropertyInfo) instead; this hook is only consulted by the default DefineBinding.")]
protected virtual PropertyBinding DefineAttributeBinding(AttributeInfo metadata)

Parameters

metadata AttributeInfo

Returns

PropertyBinding

DefineAttributeCell(AttributeInfo)

[Obsolete("Override DefineCell(PropertyInfo) instead; this hook is only consulted by the default DefineCell.")]
protected virtual CellSpec DefineAttributeCell(AttributeInfo metadata)

Parameters

metadata AttributeInfo

Returns

CellSpec

DefineBinding(PropertyInfo)

Describes the data of a list/summary column. Override this as well as DefineCell(PropertyInfo) when a custom cell needs a custom binding.

protected virtual PropertyBinding DefineBinding(PropertyInfo metadata)

Parameters

metadata PropertyInfo

Returns

PropertyBinding

DefineCell(PropertyInfo)

Describes the rendering of a list/summary column. Override this to customise column/cell scaffolding; branch on metadata is AttributeInfo a (or RelationshipInfo r) if necessary.

protected virtual CellSpec DefineCell(PropertyInfo metadata)

Parameters

metadata PropertyInfo

Returns

CellSpec

DefineColumns(IEntityInfo)

public virtual IEnumerable<ColumnSpec> DefineColumns(IEntityInfo metadata)

Parameters

metadata IEntityInfo

Returns

IEnumerable<ColumnSpec>

DefineInitialColumn(IEntityInfo)

protected virtual ColumnSpec DefineInitialColumn(IEntityInfo metadata)

Parameters

metadata IEntityInfo

Returns

ColumnSpec

DefineOrdering(IEntityInfo)

The sort clauses to apply to the list. Return an empty sequence to use the entity's modelled default sort (SortProperty/SortAscending).

public virtual IEnumerable<ListOrdering> DefineOrdering(IEntityInfo metadata)

Parameters

metadata IEntityInfo

Returns

IEnumerable<ListOrdering>

DefinePreloads(IEntityInfo)

The relationship paths the list's page query preloads, in addition to the paths its columns require: the list preload profile by default. Override to extend (with a base call) or replace.

public virtual IEnumerable<RelationshipPath> DefinePreloads(IEntityInfo metadata)

Parameters

metadata IEntityInfo

Returns

IEnumerable<RelationshipPath>

DefineRelationshipBinding(RelationshipInfo)

[Obsolete("Override DefineBinding(PropertyInfo) instead; this hook is only consulted by the default DefineBinding.")]
protected virtual PropertyBinding DefineRelationshipBinding(RelationshipInfo metadata)

Parameters

metadata RelationshipInfo

Returns

PropertyBinding

DefineRelationshipCell(RelationshipInfo)

[Obsolete("Override DefineCell(PropertyInfo) instead; this hook is only consulted by the default DefineCell.")]
protected virtual CellSpec DefineRelationshipCell(RelationshipInfo metadata)

Parameters

metadata RelationshipInfo

Returns

CellSpec

GetMessage(IEntityInfo, IEntity)

An optional status message for a row: table rows tint by its level and show its text as a tooltip; summary cards display it as a chip.

public virtual Message? GetMessage(IEntityInfo metadata, IEntity row)

Parameters

metadata IEntityInfo

row IEntity

Returns

Message?

Match(IEntityInfo)

public virtual bool Match(IEntityInfo metadata)

Parameters

metadata IEntityInfo

Returns

bool