UniGridExportHelper Class |
Namespace: CMS.UIControls
public class UniGridExportHelper : DataExportHelper
The UniGridExportHelper type exposes the following members.
Name | Description | |
---|---|---|
UniGridExportHelper |
Default constructor.
|
Name | Description | |
---|---|---|
mAvailableColumns |
Holds columns available for export.
| |
mDataExportTemplatePath |
Holds path leading to Excel export template.
(Inherited from DataExportHelper.) | |
mDataSource |
Source of data.
(Inherited from DataExportHelper.) | |
mExportedColumns |
Holds actually exported columns.
(Inherited from DataExportHelper.) | |
mFileName |
File of name to export (without extension).
(Inherited from DataExportHelper.) | |
mFileNameWithExtension |
File of name to export with extension.
(Inherited from DataExportHelper.) | |
mMacroResolver |
Holds macro resolver.
(Inherited from DataExportHelper.) | |
mUseSharedStringStorage |
Indicates whether to use shared string table during Excel export.
(Inherited from DataExportHelper.) |
Name | Description | |
---|---|---|
AllColumns |
Allows to explicitly specify all columns that can be retrieved from UniGrid
Comma-separated value e.g. "ItemID, ItemName"
| |
AllowExportEmptyDataSource |
Determines whether to allow export empty data source or raise an error
(Inherited from DataExportHelper.) | |
AvailableColumns |
Gets a list of columns that are available for export.
| |
BoundFields |
Gets all bound fields from UniGrid.
| |
Columns |
Allows to explicitly set exported columns.
| |
CSVDelimiter |
Defines delimiter for CSV format.
(Inherited from DataExportHelper.) | |
CurrentPageOnly |
Determines whether to export just current page.
| |
DataExportTemplateFolder |
Gets a startup path for template lookup.
(Inherited from DataExportHelper.) | |
DataExportTemplatePath |
Gets or sets a relative path leading to template.
Priorities of lookup (get) are:
1. DataExportTemplatePath/SiteName/ObjectType/Template.xlsx
2. DataExportTemplatePath/ObjectType/Template.xlsx
3. DataExportTemplatePath/SiteName/Template.xlsx
4. DataExportTemplatePath/Template.xlsx
(Overrides DataExportHelperDataExportTemplatePath.) | |
DataSource |
Retrieves data from UniGrid control (applying data properties).
(Overrides DataExportHelperDataSource.) | |
ExportRawData |
Defines whether to export raw table data.
| |
FileName |
Name of exported file (without extension).
(Overrides DataExportHelperFileName.) | |
FileNameWithExtension |
Name of exported file with extension.
(Inherited from DataExportHelper.) | |
GenerateHeader |
Indicates whether to generate also a header row.
(Inherited from DataExportHelper.) | |
MacroResolver |
Gets or sets macro resolver.
(Overrides DataExportHelperMacroResolver.) | |
ObjectType |
Gets original object type from type info of info object used by UniGrid.
| |
OrderBy |
Order by clause.
| |
Records |
Number of exported records (in case CurrentPageOnly is false).
| |
SafeObjectType |
Safe version of object type
| |
SiteName |
Site name used for export template lookup.
| |
TopN |
Top N rows to export.
(Inherited from DataExportHelper.) | |
UniGrid |
Holds an instance of UniGrid control.
| |
UseGridFilter |
Whether to use current UniGrid's where condition.
| |
UseSharedStringStorage |
Defines whether to use shared string table for storing text values.
When value is false text is being stored as inline string.
Applies only to Excel export.
(Inherited from DataExportHelper.) | |
UseTemplate |
Indicates whether to use XLSX template.
(Inherited from DataExportHelper.) | |
WhereCondition |
Additional where condition.
|
Name | Description | |
---|---|---|
ExportData(DataExportFormatEnum, Stream) |
Exports data stored in DataSource property, writes it to given stream.
(Inherited from DataExportHelper.) | |
ExportData(DataExportFormatEnum, HttpResponse) |
Exports data stored in DataSource property, writes it to given response.
(Inherited from DataExportHelper.) | |
ExportToCSV(DataSet, Int32, Stream) |
Exports first table of given DataSet to CSV format.
(Inherited from DataExportHelper.) | |
ExportToCSV(DataSet, Int32, Stream, Boolean) |
Exports specified table of given DataSet to CSV format.
(Inherited from DataExportHelper.) | |
GetColumnCaptionText |
Gets a caption for given column name.
(Overrides DataExportHelperGetColumnCaptionText(Int32, String).) | |
GetColumnIndex |
Gets index of a column corresponding to columns actually selected to export.
(Overrides DataExportHelperGetColumnIndex(String, String).) | |
GetColumnIndexInternal |
Gets index of a column corresponding to columns actually selected to export.
| |
GetColumnNameByIndex |
Gets column name by given index from table specified by name.
| |
GetExportedColumns |
Gets columns that should be exported.
(Overrides DataExportHelperGetExportedColumns(String).) | |
GetExportedData |
Gets the DataSet with the formatted exported data
(Overrides DataExportHelperGetExportedData(DataSet, Boolean).) | |
GetExportedValue |
Gets the exported value for the given
(Overrides DataExportHelperGetExportedValue(DataRowView, String, DataRow).) | |
GetXMLElementName |
Normalizes header text to be usable as element name.
(Inherited from DataExportHelper.) | |
RaiseError |
Raises error event.
(Inherited from DataExportHelper.) | |
UniGridExportHelper_ExternalDataBound |
Performs external data binding on the data
|
Name | Description | |
---|---|---|
Error |
Error handler.
(Inherited from DataExportHelper.) | |
ExternalDataBound |
External data bound handler.
(Inherited from DataExportHelper.) |