The UniGridExportHelper type exposes the following members.
Back to Top
Back to Top
Back to Top
Back to Top
Back to Top
Back to Top
Constructors
| Name | Description | |
|---|---|---|
 | UniGridExportHelper |
Default constructor.
|
Methods
| Name | Description | |
|---|---|---|
|  Equals | (Inherited from Object.) |
| 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 specified 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.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetColumnCaptionText |
Gets a caption for given column name.
(Overrides DataExportHelper GetColumnCaptionText(Int32, String).) |
| GetColumnIndex |
Gets index of a column corresponding to columns actually selected to export.
(Overrides DataExportHelper GetColumnIndex(String, String).) |
| GetColumnNameByIndex |
Gets column name by given index from table specified by name.
|
| GetExportedColumns |
Gets columns that should be exported.
(Overrides DataExportHelper GetExportedColumns(String).) |
| GetExportedData |
Gets the DataSet with the formatted exported data
(Overrides DataExportHelper GetExportedData(DataSet, Boolean).) |
| GetExportedValue |
Gets the exported value for the given
(Overrides DataExportHelper GetExportedValue(DataRow, String, DataRow).) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the (Inherited from Type of the current instance.Object.) |
| GetXMLElementName |
Normalizes header text to be usable as element name.
(Inherited from DataExportHelper.) |
| MemberwiseClone | Creates a shallow copy of the current (Inherited from Object.Object.) |
| RaiseError |
Raises error event.
(Inherited from DataExportHelper.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| UniGridExportHelper_ExternalDataBound |
Performs external data binding on the data
|
Extension Methods
| Name | Description | |
|---|---|---|
 | AsValue |
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.) |
| GetAPIString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) |
| GetString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) |
| ToBoolean |
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToDateTime |
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToDouble |
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToGuid |
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToInteger |
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToString |
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.) |
Fields
| 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.) |
Properties
| 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 DataExportHelper DataExportTemplatePath.) |
| DataSource |
Retrieves data from UniGrid control (applying data properties).
(Overrides DataExportHelper DataSource.) |
| ExportRawData |
Defines whether to export raw table data.
|
| FileName |
Name of exported file (without extension).
(Overrides DataExportHelper FileName.) |
| 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 DataExportHelper MacroResolver.) |
 | 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.
|
Events
| Name | Description | |
|---|---|---|
 | Error |
Error handler.
(Inherited from DataExportHelper.) |
 | ExternalDataBound |
External data bound handler.
(Inherited from DataExportHelper.) |
See Also