DataExportHelper MembersKentico 8.1 API Reference
The DataExportHelper type exposes the following members.
Constructors

  NameDescription
Protected methodDataExportHelper 
Default constructor.
Public methodDataExportHelper(DataSet)
Constructor initializing data source.
Back to Top
Methods

  NameDescription
Public methodStatic memberCreateColumnName
Creates column name from column number ("1" -> "A")
Public methodStatic memberCreateColumnReference
Creates column reference from column and row numbers.
Public methodOnlineEquals
Determines whether the specified OnlineObject is equal to the current OnlineObject.
(Inherited from OnlineObject.)
Public methodExportData(DataExportFormatEnum, Stream)
Exports data stored in DataSource property, writes it to given stream.
Public methodExportData(DataExportFormatEnum, HttpResponse)
Exports data stored in DataSource property, writes it to given response.
Public methodExportToCSV(DataSet, Int32, Stream)
Exports specified table of given DataSet to CSV format.
Public methodExportToCSV(DataSet, Int32, Stream, Boolean)
Exports specified table of given DataSet to CSV format.
Protected methodOnlineFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from OnlineObject.)
Protected methodGetColumnCaptionText
Gets a caption for given column name.
Protected methodGetColumnIndex
Gets index of a column corresponding to columns actually selected to export.
Public methodStatic memberGetColumnName
Returns name of column from given cell reference (ex. "B4" -> "B")
Public methodStatic memberGetColumnNumber
Gets number of given column name ("A" -> "1")
Public methodStatic memberGetDataExportFormatContentType
Returns content type for given format.
Public methodStatic memberGetDataExportFormatEnum
Returns DataExportFormat enum.
Public methodStatic memberGetDataExportFormatString
Returns DataExportFormat string.
Protected methodGetExportedColumns
Gets columns that should be exported.
Protected methodGetExportedData
Gets the DataSet with the formatted exported data
Protected methodGetExportedValue
Gets the exported value for the given
Public methodOnlineGetHashCode
Serves as a hash function for a particular type.
(Inherited from OnlineObject.)
Public methodStatic memberGetRowNumber
Returns number of a row from given cell reference (ex. "B4" -> "4")
Public methodOnlineGetType
Gets the OnlineType of the current instance.
(Inherited from OnlineObject.)
Protected methodGetXMLElementName
Normalizes header text to be usable as element name.
Protected methodOnlineMemberwiseClone
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
Protected methodRaiseError
Raises error event.
Public methodOnlineToString
Returns a string that represents the current object.
(Inherited from OnlineObject.)
Back to Top
Extension Methods

  NameDescription
Public Extension MethodAsValue
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.)
Public Extension MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Back to Top
Fields

  NameDescription
Protected fieldStatic memberDEFAULT_COLUMN_NAME
Name of element representing column used when there is no other name available.
Protected fieldStatic memberDEFAULT_TEMPLATE_NAME
Default name of Excel export template.
Protected fieldStatic memberMAX_EXCEL_CELL_SIZE
Maximum size of Excel cell.
Protected fieldmDataExportTemplatePath
Holds path leading to Excel export template.
Protected fieldmDataSource
Source of data.
Protected fieldmExportedColumns
Holds actually exported columns.
Protected fieldmFileName
File of name to export (without extension).
Protected fieldmFileNameWithExtension
File of name to export with extension.
Protected fieldmMacroResolver
Holds macro resolver.
Protected fieldmUseSharedStringStorage
Indicates whether to use shared string table during Excel export.
Back to Top
Properties

  NameDescription
Public propertyAllowExportEmptyDataSource
Determines whether to allow export empty data source or raise an error
Public propertyCSVDelimiter
Defines delimiter for CSV format.
Public propertyDataExportTemplateFolder
Gets a startup path for template lookup.
Public propertyDataExportTemplatePath
Gets a relative path leading to template.
Public propertyDataSource
Gets or sets the source of data to export.
Public propertyFileName
Name of exported file (without extension).
Public propertyFileNameWithExtension
Name of exported file with extension.
Public propertyGenerateHeader
Indicates whether to generate also a header row.
Public propertyMacroResolver
Gets or sets macro resolver.
Public propertyTopN
Top N rows to export.
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.
Public propertyUseTemplate
Indicates whether to use XLSX template.
Back to Top
Events

  NameDescription
Public eventError
Error handler.
Protected eventExternalDataBound
External data bound handler.
Back to Top
See Also