Interface IExportQuery
A custom popup window for filtering all the data of a query before executing and downloading the results
Controlled by the ExportQueryController and ExportQueryResult parameters
Inherited Members
Namespace: LemonEdge.Client.Core.Support
Assembly: ClientCore.dll
Syntax
public interface IExportQuery : IPopupWindow<ExportQueryResult>, IWindow
Methods
Init(IModelLayoutCommon, EntityDescriptor, String, IEnumerable<GridColumnGroup>, IEnumerable<ControlDisplayVisibilityInfo>, Boolean, Nullable<DateTimeOffset>, Boolean, Nullable<Guid>, Boolean, QueryableExecuter)
Initializes the popup window with the current filters for the result set, allowing the user to fully customize them
Declaration
Task Init(IModelLayoutCommon host, EntityDescriptor descriptor, string header, IEnumerable<GridColumnGroup> columnGroups, IEnumerable<ControlDisplayVisibilityInfo> columns, bool allowColumnFilter, DateTimeOffset? asOfDate, bool allowAsOf, Guid? canvasID, bool includeTotal, QueryableExecuter filter)
Parameters
Type | Name | Description |
---|---|---|
IModelLayoutCommon | host | The host of this popup window |
EntityDescriptor | descriptor | The entity type (if any) having its data exported |
System.String | header | The title/header for this popup window |
System.Collections.Generic.IEnumerable<GridColumnGroup> | columnGroups | A list of all groups the columns belong to. Used for heirarchical display only |
System.Collections.Generic.IEnumerable<ControlDisplayVisibilityInfo> | columns | A list of all the columns currently included in the result set |
System.Boolean | allowColumnFilter | Indicates the user can filter the columns to be included |
System.Nullable<System.DateTimeOffset> | asOfDate | An optional date that will be used to run the entire query as of some point of time in the past |
System.Boolean | allowAsOf | Indicates if the user is allowed to select an as of date for running the query as |
System.Nullable<System.Guid> | canvasID | The current canvas id the query should run in |
System.Boolean | includeTotal | Indicates if the query should execute including the total first and then all the data (can take longer but provides better progress information) |
QueryableExecuter | filter | The current filter to be applied when executing the data to retrieve all results |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | A task indicating the sucessful completion of the user selecting the data in the popup window |