Interface ICollectionExportable

An interface that allows a controller the possibility of implementing that determines what can be exported from the controller when the ExportData command is used

Grid controllers implement this to allow the export of just the data in the grid rather than re-running data from the server

Namespace: LemonEdge.Client.Core.Views.Core
Assembly: LemonEdge.ClientCore.dll
Syntax
public interface ICollectionExportable

Properties

CollectionType

Indicates the type of entity that can be exported from this collection

Declaration
Type CollectionType { get; }
Property Value
Type Description
Type

CurrentGridItems

The current data that can be exported from this collection

Declaration
IEnumerable CurrentGridItems { get; }
Property Value
Type Description
IEnumerable

OnlyExportFromQuery

Indicates only the data from GetQueryForExcelResults() should be exported and not the current data from the grid

Declaration
bool OnlyExportFromQuery { get; }
Property Value
Type Description
bool

OnlyExportGrid

Indicates only the data from CurrentGridItems should be exportable, and not the data returned from running the query

Declaration
bool OnlyExportGrid { get; }
Property Value
Type Description
bool

PagerRequired

Indicates the CurrentGridItems exceeded the max rows in the displayable grid data so a pager was required

Declaration
bool PagerRequired { get; }
Property Value
Type Description
bool

Methods

ColumnGroups()

A list of all groups the columns belong to

Declaration
IEnumerable<GridColumnGroup> ColumnGroups()
Returns
Type Description
IEnumerable<GridColumnGroup>

A list of all groups the columns belong to

GetExportableColumnInfo(IEnumerable<ColumnDescriptor>)

Returns a list of all columns that can be exported from this record type, including their visible status

Used by grids to export only visible columns by default, instead of all properties/columns possible from the queried data

Declaration
Task<IEnumerable<ControlDisplayVisibilityInfo>> GetExportableColumnInfo(IEnumerable<ColumnDescriptor> visibleColumns)
Parameters
Type Name Description
IEnumerable<ColumnDescriptor> visibleColumns

A list of what columns are currently visible to the user
Returns
Type Description
Task<IEnumerable<ControlDisplayVisibilityInfo>>

A list of all columns that can be exported from this record type, including their visible status

GetQueryForExcelResults()

The current query that results in the records within this collection

Declaration
QueryableExecuter GetQueryForExcelResults()
Returns
Type Description
QueryableExecuter

The current query that results in the records within this collection

GetVisibleColumnNames()

Returns all the currently visible columns in the collection that should be selected by default as data that is returned when exporting the results

Declaration
Task<IEnumerable<ControlDisplayInfo>> GetVisibleColumnNames()
Returns
Type Description
Task<IEnumerable<ControlDisplayInfo>>

All the currently visible columns in the collection that should be selected by default as data that is returned when exporting the results

Extension Methods