UniGridExportHelper Class

Helper for exporting data from UniGrid view

Inheritance Hierarchy

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

Namespace: CMS.UIControls
Assembly: CMS.UIControls (in CMS.UIControls.dll) Version: 8.2.23

Syntax

public class UniGridExportHelper : DataExportHelper

The UniGridExportHelper type exposes the following members.

Constructors

	Name	Description
Public method	UniGridExportHelper	Default constructor.

Methods

	Name	Description
Public method	ExportData(DataExportFormatEnum, Stream)	Exports data stored in DataSource property, writes it to given stream. (Inherited from DataExportHelper.)
Public method	ExportData(DataExportFormatEnum, HttpResponse)	Exports data stored in DataSource property, writes it to given response. (Inherited from DataExportHelper.)
Public method	ExportToCSV(DataSet, Int32, Stream)	Exports specified table of given DataSet to CSV format. (Inherited from DataExportHelper.)
Public method	ExportToCSV(DataSet, Int32, Stream, Boolean)	Exports specified table of given DataSet to CSV format. (Inherited from DataExportHelper.)
Protected method	GetColumnCaptionText	Gets a caption for given column name. (Overrides DataExportHelper.GetColumnCaptionText(Int32, String).)
Protected method	GetColumnIndex	Gets index of a column corresponding to columns actually selected to export. (Overrides DataExportHelper.GetColumnIndex(String, String).)
Protected method	GetColumnIndexInternal	Gets index of a column corresponding to columns actually selected to export.
Protected method	GetColumnNameByIndex	Gets column name by given index from table specified by name.
Protected method	GetExportedColumns	Gets columns that should be exported. (Overrides DataExportHelper.GetExportedColumns(String).)
Protected method	GetExportedData	Gets the DataSet with the formatted exported data (Overrides DataExportHelper.GetExportedData(DataSet, Boolean).)
Protected method	GetExportedValue	Gets the exported value for the given (Overrides DataExportHelper.GetExportedValue(DataRowView, String, DataRow).)
Protected method	GetXMLElementName	Normalizes header text to be usable as element name. (Inherited from DataExportHelper.)
Protected method	RaiseError	Raises error event. (Inherited from DataExportHelper.)
Protected method	UniGridExportHelper_ExternalDataBound	Performs external data binding on the data

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

	Name	Description
Protected field	mAvailableColumns	Holds columns available for export.
Protected field	mDataExportTemplatePath	Holds path leading to Excel export template. (Inherited from DataExportHelper.)
Protected field	mDataSource	Source of data. (Inherited from DataExportHelper.)
Protected field	mExportedColumns	Holds actually exported columns. (Inherited from DataExportHelper.)
Protected field	mFileName	File of name to export (without extension). (Inherited from DataExportHelper.)
Protected field	mFileNameWithExtension	File of name to export with extension. (Inherited from DataExportHelper.)
Protected field	mMacroResolver	Holds macro resolver. (Inherited from DataExportHelper.)
Protected field	mUseSharedStringStorage	Indicates whether to use shared string table during Excel export. (Inherited from DataExportHelper.)

Properties

	Name	Description
Public property	AllColumns	Allows to explicitly specify all columns that can be retrieved from UniGrid Comma-separated value e.g. "ItemID, ItemName"
Public property	AllowExportEmptyDataSource	Determines whether to allow export empty data source or raise an error (Inherited from DataExportHelper.)
Public property	AvailableColumns	Gets a list of columns that are available for export.
Public property	BoundFields	Gets all bound fields from UniGrid.
Public property	Columns	Allows to explicitly set exported columns.
Public property	CSVDelimiter	Defines delimiter for CSV format. (Inherited from DataExportHelper.)
Public property	CurrentPageOnly	Determines whether to export just current page.
Public property	DataExportTemplateFolder	Gets a startup path for template lookup. (Inherited from DataExportHelper.)
Public property	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.)
Public property	DataSource	Retrieves data from UniGrid control (applying data properties). (Overrides DataExportHelper.DataSource.)
Public property	ExportRawData	Defines whether to export raw table data.
Public property	FileName	Name of exported file (without extension). (Overrides DataExportHelper.FileName.)
Public property	FileNameWithExtension	Name of exported file with extension. (Inherited from DataExportHelper.)
Public property	GenerateHeader	Indicates whether to generate also a header row. (Inherited from DataExportHelper.)
Public property	MacroResolver	Gets or sets macro resolver. (Overrides DataExportHelper.MacroResolver.)
Protected property	ObjectType	Gets original object type from type info of info object used by UniGrid.
Public property	OrderBy	Order by clause.
Public property	Records	Number of exported records (in case CurrentPageOnly is false).
Protected property	SafeObjectType	Safe version of object type
Public property	SiteName	Site name used for export template lookup.
Public property	TopN	Top N rows to export. (Inherited from DataExportHelper.)
Public property	UniGrid	Holds an instance of UniGrid control.
Public property	UseGridFilter	Whether to use current UniGrid's where condition.
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. (Inherited from DataExportHelper.)
Public property	UseTemplate	Indicates whether to use XLSX template. (Inherited from DataExportHelper.)
Public property	WhereCondition	Additional where condition.

Events

	Name	Description
Public event	Error	Error handler. (Inherited from DataExportHelper.)
Protected event	ExternalDataBound	External data bound handler. (Inherited from DataExportHelper.)