Class BaseReportParametersController<T>

Inheritance
object
ModelViewController
BaseGridController
BaseGridControllerAny<ISQLTypeWrapper>
BaseGridController<ISQLTypeWrapper>
BaseGridRelatedCollectionController<T, ISQLTypeWrapper>
BaseReportParametersController<T>
DevReportParametersController
ExpressReportParametersController
ReportParametersController
SSRSReportParametersController
Implements
Inherited Members
Namespace: LemonEdge.Client.Core.Views.Controllers
Assembly: LemonEdge.ClientEntities.dll
Syntax
public abstract class BaseReportParametersController<T> : BaseGridRelatedCollectionController<T, ISQLTypeWrapper>, IBaseGridController, ICollectionExportable, INewGridItemImplementor<ISQLTypeWrapper>, ICopyGridItemImplementor<ISQLTypeWrapper>, IGrid, IDeleteGridItemImplementor<ISQLTypeWrapper>, ISearchController, IModelViewController where T : IReportBase
Type Parameters
Name Description
T

Constructors

BaseReportParametersController(IBaseGridRelatedCollection<T, ISQLTypeWrapper>)

Declaration
public BaseReportParametersController(IBaseGridRelatedCollection<T, ISQLTypeWrapper> view)
Parameters
Type Name Description
IBaseGridRelatedCollection<T, ISQLTypeWrapper> 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.Reporting.ISQLTypeWrapper>.AllowCopyCommand

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.Reporting.ISQLTypeWrapper>.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.Reporting.ISQLTypeWrapper>.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 ISQLTypeWrapper 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.Reporting.ISQLTypeWrapper>.AutoOpenNewItemInTab

CollectionRelationshipColumnName

This is the property on the ISQLTypeWrapper 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
LemonEdge.Client.Core.Views.Core.BaseGridRelatedCollectionController<T, LemonEdge.API.Entities.Reporting.ISQLTypeWrapper>.CollectionRelationshipColumnName

ContextHelpURL

An optional associated url of a help file for the view this controller works with

Declaration
public override string ContextHelpURL { get; }
Property Value
Type Description
string
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

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.Reporting.ISQLTypeWrapper>.AlterColumnInfo(LemonEdge.Client.UI.API.Controls.ControlDisplayInfo)

AlterLoadedItems(IEnumerable<ISQLTypeWrapper>)

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<ISQLTypeWrapper>> AlterLoadedItems(IEnumerable<ISQLTypeWrapper> items)
Parameters
Type Name Description
IEnumerable<ISQLTypeWrapper> items

The items loaded for display into the GridView
Returns
Type Description
Task<IEnumerable<ISQLTypeWrapper>>
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 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.Reporting.ISQLTypeWrapper>.ColumnNames()

GetSQLTypeWrapperParamComboItems(SQLTypeWrapper)

Declaration
public KeyValuePair<string, string>[] GetSQLTypeWrapperParamComboItems(SQLTypeWrapper item)
Parameters
Type Name Description
SQLTypeWrapper item
Returns
Type Description
KeyValuePair<string, string>[]

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

UpdateNewItem(ISQLTypeWrapper)

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(ISQLTypeWrapper item)
Parameters
Type Name Description
ISQLTypeWrapper item

The new item created for this grid
Returns
Type Description
Task

A task indicating the completion of the operation
Overrides
LemonEdge.Client.Core.Views.Core.BaseGridRelatedCollectionController<T, LemonEdge.API.Entities.Reporting.ISQLTypeWrapper>.UpdateNewItem(LemonEdge.API.Entities.Reporting.ISQLTypeWrapper)

Implements

Extension Methods