Delegate RelatedItemQueryFilter

The delegate to provide a custom query filter for a ControlDisplayInfo.GetFilter

The query filter is returned when requested as it may depend on several context values

Namespace: LemonEdge.Client.UI.API.Misc
Assembly: LemonEdge.Client.UI.API.dll
Syntax
public delegate Task<QueryableFilter> RelatedItemQueryFilter(IBaseEntity currentItem, IBaseEntity parentItem, IEntityRetriever context)
Parameters
Type Name Description
IBaseEntity currentItem

The current item that this query is being executed within a context of
IBaseEntity parentItem

The parent item this query will be executed within the context of
IEntityRetriever context

The actual IEntityRetriever context that will be used to execute the query (will contain modified items that may be relevant for the query filter)
Returns
Type Description
Task<QueryableFilter>

A task holding a new filter (if any) that should be applied to the execution of the query

Constructors

RelatedItemQueryFilter(object, IntPtr)

Declaration
public RelatedItemQueryFilter(object @object, IntPtr method)
Parameters
Type Name Description
object object
IntPtr method

Methods

BeginInvoke(IBaseEntity, IBaseEntity, IEntityRetriever, AsyncCallback, object)

Declaration
public virtual IAsyncResult BeginInvoke(IBaseEntity currentItem, IBaseEntity parentItem, IEntityRetriever context, AsyncCallback callback, object @object)
Parameters
Type Name Description
IBaseEntity currentItem
IBaseEntity parentItem
IEntityRetriever context
AsyncCallback callback
object object
Returns
Type Description
IAsyncResult

EndInvoke(IAsyncResult)

Declaration
public virtual Task<QueryableFilter> EndInvoke(IAsyncResult result)
Parameters
Type Name Description
IAsyncResult result
Returns
Type Description
Task<QueryableFilter>

Invoke(IBaseEntity, IBaseEntity, IEntityRetriever)

Declaration
public virtual Task<QueryableFilter> Invoke(IBaseEntity currentItem, IBaseEntity parentItem, IEntityRetriever context)
Parameters
Type Name Description
IBaseEntity currentItem
IBaseEntity parentItem
IEntityRetriever context
Returns
Type Description
Task<QueryableFilter>

Extension Methods