DataExportHelper Class

Provides DataSet export functionality to formats defined by DataExportFormatEnum.

Inheritance Hierarchy

System.Object
  CMS.Base.CoreMethods
    CMS.ImportExport.DataExportHelper
      CMS.UIControls.UniGridExportHelper

Namespace: CMS.ImportExport
Assembly: CMS.ImportExport (in CMS.ImportExport.dll) Version: 12.0.0

Syntax

public class DataExportHelper : CoreMethods

The DataExportHelper type exposes the following members.

Constructors

	Name	Description
Protected method	DataExportHelper()	Default constructor.
Public method	DataExportHelper(DataSet)	Constructor initializing data source.

Fields

	Name	Description
Protected field Static member	DEFAULT_COLUMN_NAME	Name of element representing column used when there is no other name available.
Protected field Static member	DEFAULT_TEMPLATE_NAME	Default name of Excel export template.
Protected field Static member	MAX_EXCEL_CELL_SIZE	Maximum size of Excel cell.
Protected field	mDataExportTemplatePath	Holds path leading to Excel export template.
Protected field	mDataSource	Source of data.
Protected field	mExportedColumns	Holds actually exported columns.
Protected field	mFileName	File of name to export (without extension).
Protected field	mFileNameWithExtension	File of name to export with extension.
Protected field	mMacroResolver	Holds macro resolver.
Protected field	mUseSharedStringStorage	Indicates whether to use shared string table during Excel export.

Properties

	Name	Description
Public property	AllowExportEmptyDataSource	Determines whether to allow export empty data source or raise an error
Public property	CSVDelimiter	Defines delimiter for CSV format.
Public property	DataExportTemplateFolder	Gets a startup path for template lookup.
Public property	DataExportTemplatePath	Gets a relative path leading to template.
Public property	DataSource	Gets or sets the source of data to export.
Public property	FileName	Name of exported file (without extension).
Public property	FileNameWithExtension	Name of exported file with extension.
Public property	GenerateHeader	Indicates whether to generate also a header row.
Public property	MacroResolver	Gets or sets macro resolver.
Public property	TopN	Top N rows to export.
Public property	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.
Public property	UseTemplate	Indicates whether to use XLSX template.

Methods

	Name	Description
Public method Static member	CreateColumnName	Creates column name from column number ("1" -> "A")
Public method Static member	CreateColumnReference	Creates column reference from column and row numbers.
Public method	ExportData(DataExportFormatEnum, Stream)	Exports data stored in DataSource property, writes it to given stream.
Public method	ExportData(DataExportFormatEnum, HttpResponse)	Exports data stored in DataSource property, writes it to given response.
Public method	ExportToCSV(DataSet, Int32, Stream)	Exports specified table of given DataSet to CSV format.
Public method	ExportToCSV(DataSet, Int32, Stream, Boolean)	Exports specified table of given DataSet to CSV format.
Protected method	GetColumnCaptionText	Gets a caption for given column name.
Protected method	GetColumnIndex	Gets index of a column corresponding to columns actually selected to export.
Public method Static member	GetColumnName	Returns name of column from given cell reference (ex. "B4" -> "B")
Public method Static member	GetColumnNumber	Gets number of given column name ("A" -> "1")
Public method Static member	GetDataExportFormatContentType	Returns content type for given format.
Public method Static member	GetDataExportFormatEnum	Returns DataExportFormat enum.
Public method Static member	GetDataExportFormatString	Returns DataExportFormat string.
Protected method	GetExportedColumns	Gets columns that should be exported.
Protected method	GetExportedData	Gets the DataSet with the formatted exported data
Protected method	GetExportedValue	Gets the exported value for the given
Public method Static member	GetRowNumber	Returns number of a row from given cell reference (ex. "B4" -> "4")
Protected method	GetXMLElementName	Normalizes header text to be usable as element name.
Protected method	RaiseError	Raises error event.

Events

	Name	Description
Public event	Error	Error handler.
Protected event	ExternalDataBound	External data bound handler.