Class CustomObjectIndexColumnsController
Inheritance
Implements
Inherited Members
Namespace: LemonEdge.Client.Core.Views.Controllers
Assembly: LemonEdge.ClientEntities.dll
Syntax
public class CustomObjectIndexColumnsController : BaseGridRelatedCollectionController<ICustomObjectIndex, ICustomObjectIndexColumn>, IBaseGridController, ICollectionExportable, INewGridItemImplementor<ICustomObjectIndexColumn>, ICopyGridItemImplementor<ICustomObjectIndexColumn>, IGrid, IDeleteGridItemImplementor<ICustomObjectIndexColumn>, ISearchController, IModelViewControllerConstructors
CustomObjectIndexColumnsController(IBaseGridRelatedCollection<ICustomObjectIndex, ICustomObjectIndexColumn>, ILogger<CustomObjectIndexColumnsController>)
Declaration
public CustomObjectIndexColumnsController(IBaseGridRelatedCollection<ICustomObjectIndex, ICustomObjectIndexColumn> view, ILogger<CustomObjectIndexColumnsController> logger)Parameters
| Type | Name | Description |
|---|---|---|
| IBaseGridRelatedCollection<ICustomObjectIndex, ICustomObjectIndexColumn> | view | |
| ILogger<CustomObjectIndexColumnsController> | logger |
Properties
AllowOpenCommand
Indicates that by default selected entities can be opened by the user with the open command
Declaration
public override bool AllowOpenCommand { get; }Property Value
| Type | Description |
|---|---|
| bool |
Overrides
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 ICustomObjectIndexColumn is an entity that is not a IsStandingDataEntity
Declaration
public override bool AutoOpenNewItemInTab { get; }Property Value
| Type | Description |
|---|---|
| bool |
Overrides
CollectionRelationshipColumnName
This is the property on the ICustomObjectIndexColumn entities that holds a relationship value that points to the SingleItem type
This controller will automatically use that to filter the correct entities for the grid in AlterQuery(QueryableExecuter<TCollection>)
Declaration
public override string CollectionRelationshipColumnName { get; }Property Value
| Type | Description |
|---|---|
| string |
Overrides
Methods
AlterColumnInfo(ControlDisplayInfo)
Provides an inheriting controller the opportunity to alter the specified column before it is added to the IBaseGrid<T>
This is used in conjunction with columns defined via ColumnNames(), rather than Columns() which explicitly defines all information
The default operation provides a CustomComboItems if the column is against a property that is a link to an entity type (IsEntityLink)Declaration
protected override void AlterColumnInfo(ControlDisplayInfo info)Parameters
| Type | Name | Description |
|---|---|---|
| ControlDisplayInfo | info | The definition of the column that can be updated before being created in the IBaseGrid<T> |
Overrides
ColumnNames()
A list of all the columns to be dynamically created in the IBaseGrid<T>
This is used by the system to create the actual ControlDisplayInfo classes required from the Columns() property
You can override this to provide a simple definition of each column (combined with AlterControlInfo(ControlDisplayInfo) for more detail), or you can just override Columns() and ignore thisDeclaration
protected override IEnumerable<ControlDisplayInfoLight> ColumnNames()Returns
| Type | Description |
|---|---|
| IEnumerable<ControlDisplayInfoLight> | A list of all the columns to be dynamically created in the IBaseGrid<T> |
Overrides
UpdateNewItem(ICustomObjectIndexColumn)
Updates any new item created in this grid to also have the CollectionRelationshipColumnName property hold the value of the SingleItem ID
Declaration
protected override Task UpdateNewItem(ICustomObjectIndexColumn item)Parameters
| Type | Name | Description |
|---|---|---|
| ICustomObjectIndexColumn | item | The new item created for this grid |
Returns
| Type | Description |
|---|---|
| Task | A task indicating the completion of the operation |