Class ReportParamController<T>

A controller for displaying the ExecuteReportParameter parameters to the user for choosing the data they would like to export

Inheritance
object
PopupWindowController
PopupWindowController<T>
ParamViewerController<T>
ParamSingleViewerController<T>
ReportParamController<T>
DevExpressReportParamController
ExpressReportParamController
SSRSReportParamController
Implements
Inherited Members
Namespace: LemonEdge.Client.Core.Tasks.Params
Assembly: LemonEdge.ClientCore.dll
Syntax
public abstract class ReportParamController<T> : ParamSingleViewerController<T>, IPopupWindowController<T>, IParamViewerController, IPopupWindowController, IController where T : ExecuteReportParameter
Type Parameters
Name Description
T A controller for displaying the parameters to the user for choosing the data they would like to export

Constructors

ReportParamController(IParamSingleViewer<T>, T)

Creates a new report data parameter controller

Declaration
protected ReportParamController(IParamSingleViewer<T> window, T param)
Parameters
Type Name Description
IParamSingleViewer<T> window

The parameter popup window for displaying these parameters
T param

The initial parameters to display

Methods

Controls()

Creates all the controls for the parameters for this report along with any custom parameters from the parameter class itself

Declaration
protected override IEnumerable<ControlDisplayInfo> Controls()
Returns
Type Description
IEnumerable<ControlDisplayInfo>

All controls to be displayed
Overrides
LemonEdge.Client.UI.API.Controllers.ParamSingleViewerController<T>.Controls()

CreateCustomControls(Dictionary<ResultType, short>, short)

Provides the inheriting controller a chance to create any custom controls to be displayed that are bound to properties against a ISQLWrapperResult and should increment resultTypePropertyIndexes accordingly for each property type

Declaration
protected abstract IEnumerable<ControlDisplayInfo> CreateCustomControls(Dictionary<SQLWrapperInterpretor.ResultType, short> resultTypePropertyIndexes, short controlIndex)
Parameters
Type Name Description
Dictionary<SQLWrapperInterpretor.ResultType, short> resultTypePropertyIndexes

The index to be used for the next bound property value. Should be incremented for each control type created
short controlIndex

The index of the next control to create
Returns
Type Description
IEnumerable<ControlDisplayInfo>

All custom controls to be displayed

Display()

Displays all the parameters defined against the IReport as controls

Declaration
public override Task Display()
Returns
Type Description
Task

A task indicating the completion of the operation
Overrides
LemonEdge.Client.UI.API.Controllers.ParamSingleViewerController<T>.Display()

OnOk(object)

Retrieves all values from custom controls and writes them to the parameter values in OriginalParams

Declaration
public override void OnOk(object result)
Parameters
Type Name Description
object result

The current parameter values
Overrides

SetCustomPropertiesForDisplay(T, ISQLWrapperResult)

Provides the implementing parameter controller a chance to set any custom property values against the displayedValues

Declaration
protected abstract void SetCustomPropertiesForDisplay(T paramValues, ISQLWrapperResult displayedValues)
Parameters
Type Name Description
T paramValues

The values to display from this parameter
ISQLWrapperResult displayedValues

The class that holds the values being displayed in the viewer

SetCustomPropertiesFromDisplay(ISQLWrapperResult, T)

Provides the implementing parameter controller a chance to get any custom property values from the displayedValues and set them back to the parameter

Declaration
protected abstract void SetCustomPropertiesFromDisplay(ISQLWrapperResult displayedValues, T paramValues)
Parameters
Type Name Description
ISQLWrapperResult displayedValues

The class that holds the values being displayed in the viewer, that we should retrieve if any
T paramValues

The values from this parameter that should be set with any custom ones from the display

Implements

Extension Methods