Class ExcelExportInfo

Used to provide a popup to the user in the client allowing the selection of columns, and possible filtering of results from a entity type or sql wrapper

Inheritance
object
ExcelExportInfo
Inherited Members
Namespace: LemonEdge.Client.Core.Commands
Assembly: LemonEdge.ClientCore.dll
Syntax
public class ExcelExportInfo

Constructors

ExcelExportInfo(IModelViewController, EntityDescriptor, IModelLayoutCommon)

Creates a new excel export info for the specified entity type (forType). Can be null if PromptForExportInfo(bool, bool, DateTimeOffset?, Guid?, QueryableExecuter) has a query executer type to use instead

Declaration
public ExcelExportInfo(IModelViewController controller, EntityDescriptor forType, IModelLayoutCommon host)
Parameters
Type Name Description
IModelViewController controller

The current controller this popup appears from for context
EntityDescriptor forType

The type of entity to provide a filter for
IModelLayoutCommon host

The current owner

Properties

AlowAsOfDateInExcelExport

Indicates if the as of date is allowed for use

Declaration
public bool AlowAsOfDateInExcelExport { get; set; }
Property Value
Type Description
bool

Columns

A list of all columns in the result set and if they are visible by default for inclusion

Declaration
public IEnumerable<ControlDisplayVisibilityInfo> Columns { get; }
Property Value
Type Description
IEnumerable<ControlDisplayVisibilityInfo>

Controller

The controller this popup operates from within

Declaration
public IModelViewController Controller { get; }
Property Value
Type Description
IModelViewController

ForType

The entity type to filter by

Declaration
public EntityDescriptor ForType { get; }
Property Value
Type Description
EntityDescriptor

Groups

A list of the grouping heirarchy the result columns belong to for easy filtering

Declaration
public IEnumerable<GridColumnGroup> Groups { get; }
Property Value
Type Description
IEnumerable<GridColumnGroup>

Methods

PromptForExportInfo(bool, bool, DateTimeOffset?, Guid?, QueryableExecuter)

Prompts the user to select column, and optional filtering for the results of this data set

Declaration
public Task<(IEnumerable<ColumnDescriptor> Columns, DateTimeOffset? AsOfDate, Guid? CanvasID, GroupType FiltersGroupBy, IEnumerable<QueryableFilter> Filters, bool IncludeTotalCount, bool OkClicked)> PromptForExportInfo(bool useTotalCount, bool allowColumnFilter, DateTimeOffset? asOfDate, Guid? canvasID, QueryableExecuter queryFilter)
Parameters
Type Name Description
bool useTotalCount

Indicates the query should retrieve the total count first before executing
bool allowColumnFilter

Indicates the user should be able to select the results
DateTimeOffset? asOfDate

The as of date to run the query as of
Guid? canvasID

The canvas to run the query within
QueryableExecuter queryFilter

The default filter to use currently for the query
Returns
Type Description
Task<(IEnumerable<ColumnDescriptor> Columns, DateTimeOffset? AsOfDate, Guid? CanvasID, GroupType FiltersGroupBy, IEnumerable<QueryableFilter> Filters, bool IncludeTotalCount, bool OkClicked)>

A tuple of the selected columns, as ofdate, canvas, filter root group type and filtering to use on the query

SetColumnInfo(IEnumerable<ControlDisplayVisibilityInfo>, IEnumerable<GridColumnGroup>)

Sets the specified column info to allow the user to select the columns to return included in the result set

Declaration
public void SetColumnInfo(IEnumerable<ControlDisplayVisibilityInfo> columns, IEnumerable<GridColumnGroup> groups)
Parameters
Type Name Description
IEnumerable<ControlDisplayVisibilityInfo> columns

A list of all columns in the result set and if they are visible by default for inclusion
IEnumerable<GridColumnGroup> groups

A list of the grouping heirarchy the result columns belong to for easy filtering

Extension Methods