Class ObjectEntitiesController<T>
An optional base object entity controller used for displaying a collection of entities that inherits from IObjectEntityBase in a consistent manner
Inheritance
Implements
Inherited Members
Namespace: LemonEdge.Client.Core.Views.Controllers
Assembly: LemonEdge.ClientCore.dll
Syntax
public abstract class ObjectEntitiesController<T> : BaseGridController<T>, IBaseGridController, ICollectionExportable, INewGridItemImplementor<T>, ICopyGridItemImplementor<T>, IGrid, IDeleteGridItemImplementor<T>, ISearchController, IModelViewController where T : IObjectEntityBase
Type Parameters
Name | Description |
---|---|
T | The entity base object type that inherits from IObjectEntityBase |
Constructors
ObjectEntitiesController(IBaseGrid<T>)
Creates a new ObjectEntitiesController
Declaration
public ObjectEntitiesController(IBaseGrid<T> view)
Parameters
Type | Name | Description |
---|---|---|
IBaseGrid<T> | view | The IBaseGrid view implementation using the UI components of the client application |
Properties
AllowYearEnd
Indicates the optional year end control should be visible
Declaration
protected virtual bool AllowYearEnd { get; }
Property Value
Type | Description |
---|---|
bool |
AutoOpenNewItemInTab
Indicates when creating a new item in the grid that it should automatically be opened in a new tab as well
The default is true if the type T is an entity that is not a IsStandingDataEntity
Declaration
public override bool AutoOpenNewItemInTab { get; }
Property Value
Type | Description |
---|---|
bool |
Overrides
DefaultSearchColumn
The name of the column to use in the default search of text in the grid
Declaration
protected override string DefaultSearchColumn { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
Methods
AlterQuery(QueryableExecuter<T>)
Alters the query to load the object entities ordered by Name
Declaration
protected override QueryableExecuter<T> AlterQuery(QueryableExecuter<T> query)
Parameters
Type | Name | Description |
---|---|---|
QueryableExecuter<T> | query | The query to be altered |
Returns
Type | Description |
---|---|
QueryableExecuter<T> | The query to execute to load all object entities that should be displayed against this grid view |
Overrides
ColumnNames()
Adds the Name, Code, LegalName, and CurrencyID as columns to the grid
Declaration
protected override IEnumerable<ControlDisplayInfoLight> ColumnNames()
Returns
Type | Description |
---|---|
IEnumerable<ControlDisplayInfoLight> | The columns to be displayed against this grid view |
Overrides
OnTrackedItemChanged(object, string)
Provids a mechanism for handling changes for any item in the context
By default this is used to apply changes made to a selected item automatically to all other selected items in the grid (if multi-select is enabled)
Declaration
protected override void OnTrackedItemChanged(object item, string propName)
Parameters
Type | Name | Description |
---|---|---|
object | item | The item that changed |
string | propName | The property name of the changed value |