Click or drag to resize
UniGridExportHelper Class
Helper for exporting data from UniGrid view
Inheritance Hierarchy
SystemObject
  CMS.BaseCoreMethods
    CMS.ImportExportDataExportHelper
      CMS.UIControlsUniGridExportHelper

Namespace: CMS.UIControls
Assembly: CMS.UIControls (in CMS.UIControls.dll) Version: 13.0.131
Syntax
C#
public class UniGridExportHelper : DataExportHelper

The UniGridExportHelper type exposes the following members.

Constructors
  NameDescription
Public methodUniGridExportHelper
Default constructor.
Top
Fields
  NameDescription
Protected fieldmAvailableColumns
Holds columns available for export.
Protected fieldmDataExportTemplatePath
Holds path leading to Excel export template.
(Inherited from DataExportHelper.)
Protected fieldmDataSource
Source of data.
(Inherited from DataExportHelper.)
Protected fieldmExportedColumns
Holds actually exported columns.
(Inherited from DataExportHelper.)
Protected fieldmFileName
File of name to export (without extension).
(Inherited from DataExportHelper.)
Protected fieldmFileNameWithExtension
File of name to export with extension.
(Inherited from DataExportHelper.)
Protected fieldmMacroResolver
Holds macro resolver.
(Inherited from DataExportHelper.)
Protected fieldmUseSharedStringStorage
Indicates whether to use shared string table during Excel export.
(Inherited from DataExportHelper.)
Top
Properties
  NameDescription
Public propertyAllColumns
Allows to explicitly specify all columns that can be retrieved from UniGrid Comma-separated value e.g. "ItemID, ItemName"
Public propertyAllowExportEmptyDataSource
Determines whether to allow export empty data source or raise an error
(Inherited from DataExportHelper.)
Public propertyAvailableColumns
Gets a list of columns that are available for export.
Public propertyBoundFields
Gets all bound fields from UniGrid.
Public propertyColumns
Allows to explicitly set exported columns.
Public propertyCSVDelimiter
Defines delimiter for CSV format.
(Inherited from DataExportHelper.)
Public propertyCurrentPageOnly
Determines whether to export just current page.
Public propertyDataExportTemplateFolder
Gets a startup path for template lookup.
(Inherited from DataExportHelper.)
Public propertyDataExportTemplatePath
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.)
Public propertyDataSource
Retrieves data from UniGrid control (applying data properties).
(Overrides DataExportHelperDataSource.)
Public propertyExportRawData
Defines whether to export raw table data.
Public propertyFileName
Name of exported file (without extension).
(Overrides DataExportHelperFileName.)
Public propertyFileNameWithExtension
Name of exported file with extension.
(Inherited from DataExportHelper.)
Public propertyGenerateHeader
Indicates whether to generate also a header row.
(Inherited from DataExportHelper.)
Public propertyMacroResolver
Gets or sets macro resolver.
(Overrides DataExportHelperMacroResolver.)
Protected propertyObjectType
Gets original object type from type info of info object used by UniGrid.
Public propertyOrderBy
Order by clause.
Public propertyRecords
Number of exported records (in case CurrentPageOnly is false).
Protected propertySafeObjectType
Safe version of object type
Public propertySiteName
Site name used for export template lookup.
Public propertyTopN
Top N rows to export.
(Inherited from DataExportHelper.)
Public propertyUniGrid
Holds an instance of UniGrid control.
Public propertyUseGridFilter
Whether to use current UniGrid's where condition.
Public propertyUseSharedStringStorage
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.)
Public propertyUseTemplate
Indicates whether to use XLSX template.
(Inherited from DataExportHelper.)
Public propertyWhereCondition
Additional where condition.
Top
Methods
  NameDescription
Public methodExportData(DataExportFormatEnum, Stream)
Exports data stored in DataSource property, writes it to given stream.
(Inherited from DataExportHelper.)
Public methodExportData(DataExportFormatEnum, HttpResponse)
Exports data stored in DataSource property, writes it to given response.
(Inherited from DataExportHelper.)
Public methodExportToCSV(DataSet, Int32, Stream)
Exports first table of given DataSet to CSV format.
(Inherited from DataExportHelper.)
Public methodExportToCSV(DataSet, Int32, Stream, Boolean)
Exports specified table of given DataSet to CSV format.
(Inherited from DataExportHelper.)
Protected methodGetColumnCaptionText
Gets a caption for given column name.
(Overrides DataExportHelperGetColumnCaptionText(Int32, String).)
Protected methodGetColumnIndex
Gets index of a column corresponding to columns actually selected to export.
(Overrides DataExportHelperGetColumnIndex(String, String).)
Protected methodGetColumnIndexInternal
Gets index of a column corresponding to columns actually selected to export.
Protected methodGetColumnNameByIndex
Gets column name by given index from table specified by name.
Protected methodGetExportedColumns
Gets columns that should be exported.
(Overrides DataExportHelperGetExportedColumns(String).)
Protected methodGetExportedData
Gets the DataSet with the formatted exported data
(Overrides DataExportHelperGetExportedData(DataSet, Boolean).)
Protected methodGetExportedValue
Gets the exported value for the given
(Overrides DataExportHelperGetExportedValue(DataRowView, String, DataRow).)
Protected methodGetXMLElementName
Normalizes header text to be usable as element name.
(Inherited from DataExportHelper.)
Protected methodRaiseError
Raises error event.
(Inherited from DataExportHelper.)
Protected methodUniGridExportHelper_ExternalDataBound
Performs external data binding on the data
Top
Events
  NameDescription
Public eventError
Error handler.
(Inherited from DataExportHelper.)
Protected eventExternalDataBound
External data bound handler.
(Inherited from DataExportHelper.)
Top
See Also