Class AnswersController

Inheritance
object
ModelViewController
BaseGridController
BaseGridControllerAny<IAnswer>
BaseGridController<IAnswer>
BaseGridAnyRelatedCollectionController<IAnswer>
AnswersController
Implements
Inherited Members
Namespace: LemonEdge.Client.Core.Views.Controllers
Assembly: LemonEdge.ClientEntities.dll
Syntax
[ViewSerializedParam(typeof(AnswersParam))]
public class AnswersController : BaseGridAnyRelatedCollectionController<IAnswer>, IBaseGridController, ICollectionExportable, INewGridItemImplementor<IAnswer>, ICopyGridItemImplementor<IAnswer>, IGrid, IDeleteGridItemImplementor<IAnswer>, ISearchController, IModelViewController

Constructors

AnswersController(IBaseGridAnyRelatedCollection<IAnswer>)

Declaration
public AnswersController(IBaseGridAnyRelatedCollection<IAnswer> view)
Parameters
Type Name Description
IBaseGridAnyRelatedCollection<IAnswer> view

Properties

AllowCopyCommand

Indicates that by default selected entities can be copied by the user with the copy command

Declaration
public override bool AllowCopyCommand { get; }
Property Value
Type Description
bool
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridController<LemonEdge.API.Entities.Questionaire.IAnswer>.AllowCopyCommand

AllowDeleteCommand

Indicates that by default selected entities can be deleted by the user with the delete command

Declaration
public override bool AllowDeleteCommand { get; }
Property Value
Type Description
bool
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridController<LemonEdge.API.Entities.Questionaire.IAnswer>.AllowDeleteCommand

AllowNewCommand

Indicates that by default entities can be created by the user with the new command

Declaration
public override bool AllowNewCommand { get; }
Property Value
Type Description
bool
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridController<LemonEdge.API.Entities.Questionaire.IAnswer>.AllowNewCommand

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
LemonEdge.Client.Core.Views.Core.BaseGridController<LemonEdge.API.Entities.Questionaire.IAnswer>.AllowOpenCommand

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 IAnswer is an entity that is not a IsStandingDataEntity

Declaration
public override bool AutoOpenNewItemInTab { get; }
Property Value
Type Description
bool
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<LemonEdge.API.Entities.Questionaire.IAnswer>.AutoOpenNewItemInTab

CheckIsLockedForCanWrite

Indicates the controller should check if the item is locked before allowing CanWrite to be true. Defaults to true.

Declaration
protected override bool CheckIsLockedForCanWrite { get; }
Property Value
Type Description
bool
Overrides

CollectionRelationshipColumnName

This is the property on the IAnswer 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<T>)

Declaration
public override string CollectionRelationshipColumnName { get; }
Property Value
Type Description
string
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridAnyRelatedCollectionController<LemonEdge.API.Entities.Questionaire.IAnswer>.CollectionRelationshipColumnName

CollectionRelationshipColumnNameLabel

Holds the label column for the CollectionRelationshipColumnName

Declaration
public override string CollectionRelationshipColumnNameLabel { get; }
Property Value
Type Description
string
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridAnyRelatedCollectionController<LemonEdge.API.Entities.Questionaire.IAnswer>.CollectionRelationshipColumnNameLabel

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

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
LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<LemonEdge.API.Entities.Questionaire.IAnswer>.AlterColumnInfo(LemonEdge.Client.UI.API.Controls.ControlDisplayInfo)

AlterLoadedItems(IEnumerable<IAnswer>)

Provides a mechanism for an inhetiring class to alter all the loaded items before they are sent to the GridView to be displayed

Declaration
protected override Task<IEnumerable<IAnswer>> AlterLoadedItems(IEnumerable<IAnswer> items)
Parameters
Type Name Description
IEnumerable<IAnswer> items

The items loaded for display into the GridView
Returns
Type Description
Task<IEnumerable<IAnswer>>
Overrides

AlterQuery(QueryableExecuter<IAnswer>)

Additionally alters the base query alteration by ensuring all entities returned are related to the SingleItem by having their CollectionRelationshipColumnName have the same value as the SingleItem ID

Declaration
protected override QueryableExecuter<IAnswer> AlterQuery(QueryableExecuter<IAnswer> query)
Parameters
Type Name Description
QueryableExecuter<IAnswer> query

The existing query to return all the results that will populate the grid
Returns
Type Description
QueryableExecuter<IAnswer>

An altered query that also ensures all entities returned are related to the SingleItem by having their CollectionRelationshipColumnName have the same value as the SingleItem ID
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridAnyRelatedCollectionController<LemonEdge.API.Entities.Questionaire.IAnswer>.AlterQuery(LemonEdge.Utils.QueryableExecuter<LemonEdge.API.Entities.Questionaire.IAnswer>)

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 this
Declaration
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
LemonEdge.Client.Core.Views.Core.BaseGridControllerAny<LemonEdge.API.Entities.Questionaire.IAnswer>.ColumnNames()

InitAsync()

Provides the controller a chance to initialize any dependant data. Called once by the system after controller creation.

Declaration
public override Task InitAsync()
Returns
Type Description
Task

A task indicating the completion of the operation
Overrides

InitCommands(IList<ViewCommand>)

Adds the following commands, if the associated AllowXXXCommand property returns true: A public toggle, multi-select row, open, column visiblitiy, transfer visible, search, view cancelled, view system, export, new, copy, move up/down, xml export, and delete commands

Declaration
protected override void InitCommands(IList<ViewCommand> commands)
Parameters
Type Name Description
IList<ViewCommand> commands

The initial set of commands for this 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
Overrides

UpdateNewItem(IAnswer)

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(IAnswer newItem)
Parameters
Type Name Description
IAnswer newItem
Returns
Type Description
Task

A task indicating the completion of the operation
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridAnyRelatedCollectionController<LemonEdge.API.Entities.Questionaire.IAnswer>.UpdateNewItem(LemonEdge.API.Entities.Questionaire.IAnswer)

Implements

Extension Methods