Class ApiQueryParamController
A controller for displaying the ApiImportParameter parameters to the user for choosing the data they would like to export
Inheritance
ApiQueryParamController
Implements
Inherited Members
Namespace: LemonEdge.ApiConnector.UI.Views
Assembly: LemonEdge.ApiConnector.UI.dll
Syntax
public class ApiQueryParamController : ParamSingleViewerController<ApiImportParameter>, IPopupWindowController<ApiImportParameter>, IParamViewerController, IPopupWindowController, IControllerConstructors
ApiQueryParamController(IParamSingleViewer<ApiImportParameter>, ApiImportParameter)
Creates a new export data parameter controller
Declaration
public ApiQueryParamController(IParamSingleViewer<ApiImportParameter> window, ApiImportParameter param)Parameters
| Type | Name | Description |
|---|---|---|
| IParamSingleViewer<ApiImportParameter> | window | The parameter popup window for displaying these parameters |
| ApiImportParameter | param | The initial parameters to display |
Methods
Controls()
Can be overridden in a derived class to indicate all the controls to be created in this single parameter popup form
Declaration
protected override IEnumerable<ControlDisplayInfo> Controls()Returns
| Type | Description |
|---|---|
| IEnumerable<ControlDisplayInfo> | All the controls to be created in this single parameter popup form |
Overrides
LemonEdge.Client.UI.API.Controllers.ParamSingleViewerController<LemonEdge.ApiConnector.Tasks.Parameters.ApiImportParameter>.Controls()
Display()
Overridse the default display method to enumerate all the Controls() in this popup parameter form and display their values
Declaration
public override Task Display()Returns
| Type | Description |
|---|---|
| Task | A task indicating the completion of the operation |
Overrides
LemonEdge.Client.UI.API.Controllers.ParamSingleViewerController<LemonEdge.ApiConnector.Tasks.Parameters.ApiImportParameter>.Display()
OnOk(object)
Called by the popup window instance when the user has dismissed the popup form by clicking ok
Declaration
public override void OnOk(object result)Parameters
| Type | Name | Description |
|---|---|---|
| object | result | The result to return back to the caller |