Table of Contents

Class EntityListViewBase<T>

Namespace
The.Web.Entities
Assembly
Instagile.Web.Client.dll

Shared scaffolding and command features for list tables (EntityListView<T>) or stacks (EntityListViews<T>).

public abstract class EntityListViewBase<T> : ComponentBase, IComponent, IHandleEvent, IHandleAfterRender where T : IEntity<T>

Type Parameters

T
Inheritance
EntityListViewBase<T>
Implements
Derived
Inherited Members

Fields

_Columns 

protected IReadOnlyList<ColumnModel> _Columns

Field Value

IReadOnlyList<ColumnModel>

_IncludedRelationships 

protected HashSet<RelationshipPath> _IncludedRelationships

Field Value

HashSet<RelationshipPath>

_Ordering 

protected IReadOnlyList<ListOrdering> _Ordering

Field Value

IReadOnlyList<ListOrdering>

_Virtualize

The markup's Virtualize<TItem>, captured for pushed-update refreshes.

protected Virtualize<BindingResult<T>>? _Virtualize

Field Value

Virtualize<BindingResult<T>>

Properties

AllowDirtyReads

Loads entity data without a transaction.

[Parameter]
public bool AllowDirtyReads { get; set; }

Property Value

bool

Count

Item count for Query, if the caller already knows it. Fetched automatically otherwise.

[Parameter]
public int? Count { get; set; }

Property Value

int?

Logger 

protected ILogger Logger { get; }

Property Value

ILogger

LoggerFactory 

[Inject]
protected ILoggerFactory LoggerFactory { get; set; }

Property Value

ILoggerFactory

Options 

[Inject]
protected Options Options { get; set; }

Property Value

Options

Query

The entities to list.

[Parameter]
[EditorRequired]
public required IEntityQuery<T> Query { get; set; }

Property Value

IEntityQuery<T>

Services 

[Inject]
protected IServices Services { get; set; }

Property Value

IServices

Type

Type of the entities to list. See IListSpec to customise the generated columns.

[Parameter]
[EditorRequired]
public required IEntityInfo Type { get; set; }

Property Value

IEntityInfo

Methods

GetCommands(ICommandContext) 

protected IEnumerable<Command> GetCommands(ICommandContext context)

Parameters

context ICommandContext

Returns

IEnumerable<Command>

GetRowClass(Message?) 

protected string GetRowClass(Message? message)

Parameters

message Message?

Returns

string

GetRowCommands(ICommandContext, T) 

protected IEnumerable<Command> GetRowCommands(ICommandContext context, T rowValue)

Parameters

context ICommandContext
rowValue T

Returns

IEnumerable<Command>

GetRowMessage(T)

The scaffolded status message for a row, or null for the default (untinted) presentation.

protected Message? GetRowMessage(T rowValue)

Parameters

rowValue T

Returns

Message?

OnColumnsExtracted()

Hook that runs once, immediately after the column set has been extracted.

protected virtual void OnColumnsExtracted()

OnListParametersSet()

Hook that runs on every parameter set, before the column set is ensured.

protected virtual void OnListParametersSet()

OnParametersSet()

Method invoked when the component has received parameters from its parent in the render tree, and the incoming values have been assigned to properties.

protected override void OnParametersSet()

OnQueryUpdated()

Handles OnUpdated by refetching the pager's rows from the updated cache.

protected Task OnQueryUpdated()

Returns

Task