DataHelper Class

Methods to work with the Data.

Inheritance Hierarchy

System.Object
  CMS.Base.CoreMethods
    CMS.Helpers.DataHelper

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

Syntax

public class DataHelper : CoreMethods

The DataHelper type exposes the following members.

Constructors

	Name	Description
Public method	DataHelper

Methods

	Name	Description
Public method Static member	CompareByteArrays	Compares two byte arrays.
Public method Static member	ConvertColumnToDateTime	Converts the specified column to Date time type.
Public method Static member	ConvertToDataTable<T>	Method to convert LINQ result to DataTable
Public method Static member	ConvertValue(Object, Type)	Converts the value to a specific type.
Public method Static member	ConvertValue(Object, Type, Object)	Converts the value to a specific type. Returns true if conversion was possible, otherwise false.
Public method Static member	ConvertValueToDefaultCulture	Converts value to its equivalent string representation using default culture format. Can be used to convert Double, Decimal, DateTime or TimeSpan values.
Public method Static member	CopyColumnValues	Copies column values from source column to target column.
Public method Static member	CreateUniqueTableColumn	Creates column with unique name int he given table.
Public method Static member	DataSetPivot	Converts data set to it's pilot.
Public method Static member	DataSourceIsEmpty(DataSet)	Returns true if the given data source is empty.
Public method Static member	DataSourceIsEmpty(Object)	Returns true if the given data source is empty.
Public method Static member	DeleteRows(DataSet, String)	Deletes the table rows matching the given where condition.
Public method Static member	DeleteRows(DataTable, String)	Deletes the table rows matching the given where condition.
Public method Static member	EnsureCodenames	Ensures Codename values in specified column.
Public method Static member	EnsureColumn	Ensures specified column.
Public method Static member	EnsureGUIDs	Ensures GUID values in specified column.
Public method Static member	EnsureIdentifiers	Ensures identifier values in specified column.
Public method Static member	EnsureRandomValues	Ensures random values in specified int column.
Public method Static member	EnsureStringValues	Ensures Codename values in specified column.
Public method Static member	ExtendParameters	Extends the parameters array for new items.
Public method Static member	FileSizeFormat	Formats file size in human readable format.
Public method Static member	ForEachRow	Executes the given action for each row in the given DataSet
Public method Static member	FromBase64String	Converts the string from Base64 string to the byte array.
Public method Static member	GetBoolValue(ISimpleDataContainer, String)	Gets the bool variable from given data container.
Public method Static member	GetBoolValue(DataRow, String, Boolean)	Gets the bool variable from given DataRow.
Public method Static member	GetBoolValue(ISimpleDataContainer, String, Boolean)	Gets the bool variable from given data container.
Public method Static member	GetColumns	Gets the columns of the given table as the string array.
Public method Static member	GetDataContainer	Gets the data container able to read the given data object
Public method Static member	GetDataContainerItem	Returns data from datarow, datarowview or ISimpleDataContainer objects for specified column.
Public method Static member	GetDataRowValue	Returns the value from the DataRow field, or DBNull.Value if the field does not exist in the datarow.
Public method Static member	GetDataRowViewValue	Returns the value from the DataRowView field, or null if the field does not exist in the datarow.
Public method Static member	GetDataSetFromXml	Gets DataSet from the given XML string.
Public method Static member	GetDataTable	Returns the DataTable from the given data source.
Public method Static member	GetDataView	Returns the DataView from the given data source.
Public method Static member	GetDateTimeValue(ISimpleDataContainer, String)	Gets the DateTime variable from given data container.
Public method Static member	GetDateTimeValue(DataRow, String, DateTime)	Gets the DateTime variable from given DataRow.
Public method Static member	GetDBNull	Converts the standard null value to DBNull.value, keeps the object value if not null.
Public method Static member	GetGuidValue(ISimpleDataContainer, String)	Gets the guid variable from given data container.
Public method Static member	GetGuidValue(DataRow, String, Guid)	Gets the guid variable from given DataRow.
Public method Static member	GetIntegerValues(DataTable, String)	Gets the array of integer values from the given data table.
Public method Static member	GetIntegerValues(DataView, String)	Gets the array of integer values from the given data table.
Public method Static member	GetIntValue(ISimpleDataContainer, String)	Gets the integer variable from given Data container.
Public method Static member	GetIntValue(DataRow, String, Int32)	Gets the integer variable from given DataRow.
Public method Static member	GetItemsCount	Gets the items count in the specified data source.
Public method Static member	GetMaximumValue<T>(DataTable, String)	Gets the maximum value from the given column.
Public method Static member	GetMaximumValue<T>(DataView, String)	Gets the maximum value from the given column.
Public method Static member	GetMinimumValue<T>	Gets the minimum value from the given column.
Public method Static member	GetNewItemsInList(String, String)	Gets the list of new items in the given list as list separated by semicolon.
Public method Static member	GetNewItemsInList(String, String, Char)	Gets the list of new items in the given list as list separated by separator.
Public method Static member	GetNotEmpty	Returns second parameter if the first is null or "".
Public method Static member	GetNotZero(Object, Int32)	Returns the object converted to integer or default value when the result of conversion equals zero.
Public method Static member	GetNotZero(Object, Object)	Returns the object converted to integer or default value when the result of conversion equals zero.
Public method Static member	GetNull	Converts the DBNull.value to standard null, keeps the object value if not null.
Public method Static member	GetObjectSize	Gets the size of the given object.
Public method Static member	GetObjectString(Object, Int32)	Gets the object as a string (for structured objects the object type and its size).
Public method Static member	GetObjectString(Object, Int32, Int32)	Gets the object as a string (for structured objects the object type and its size).
Public method Static member	GetParentPath	Returns the parent path for the specified path (any kind of path with "/" as a separator)
Public method Static member	GetPartialValue	Gets value from string that has values separated by separator.
Public method Static member	GetRowSize	Returns the row data size (size of the contained data).
Public method Static member	GetScalarValue	Gets the first value from the given DataSet.
Public method Static member	GetSingleColumnDataSet	Returns a DataSet containing single table with single column.
Public method Static member	GetSizeString(Int64)	Returns the string for the specified file size.
Public method Static member	GetSizeString(Int64, FileSizeUnitsEnum)	Returns the string for the specified file size.
Public method Static member	GetStringValue(ISimpleDataContainer, String)	Gets the string variable from given data container.
Public method Static member	GetStringValue(DataRow, String, String)	Gets the string variable from given DataRow.
Public method Static member	GetStringValues	Gets the array of string values from the given data table.
Public method Static member	GetTableSize	Returns the table data size (size of the contained data).
Public method Static member	GetTopNForPage	Gets the TOPN value to be able to get the specific page out of the paged results with old paging (through TOPN only).
Public method Static member	GetUniqueRows	Gets the list of unique rows based on given column value.
Public method Static member	GetUniqueValues	Gets the list of unique values based on given column value.
Public method Static member	GetValues<T>	Gets the array of the values from the given data table.
Public method Static member	GetViewSize	Returns the view data size (size of the contained data).
Public method Static member	ChangeBooleanValues(DataTable, String, Boolean, String)	Changes the boolean value in the given table.
Public method Static member	ChangeBooleanValues(DataTable, String, Boolean, Boolean, String)	Changes the boolean value in the given table.
Public method Static member	ChangeStringValues(DataTable, String, String, String)	Changes the string value in the given table.
Public method Static member	ChangeStringValues(DataTable, String, String, String, String)	Changes the string value in the given table.
Public method Static member	ChangeValuesToNull	Changes the value in the given table to NULL.
Public method Static member	IsEmpty	Returns true, if the given value is empty (null, DBNull, or "").
Public method Static member	IsValid	Tests if value is valid to given data type
Public method Static member	IsValidID	Returns true if the given value is a valid ID
Public method Static member	IsZero	Returns true, if the given value is zero (null, DBNull, or 0).
Public method Static member	LockDataSet	Makes the given DataSet read-only
Public method Static member	LowerCaseTableNames	Converts the table names of given DataSet to lowercase representation.
Public method Static member	MarkDuplicitRows	Marks the duplicit rows in the data table.
Public method Static member	Merge<T, K, V>	Merges two objects implementing the IDictionary interface of type T with key of type K and value of type V.
Public method Static member	MergeHashtables	Merges two hashtables.
Public method Static member	ReadDataSetFromXml(DataSet, XmlReader, DataHelper.ActionCallback, Object[])	Reads the DataSet from given XML reader (expects "NewDataSet" as a root node).
Public method Static member	ReadDataSetFromXml(DataSet, XmlReader, DataHelper.ActionCallback, Object[], String, List<String>)	Reads the DataSet from given XML reader.
Public method Static member	ReadDataSetFromXml(DataSet, XmlReader, DataHelper.ActionCallback, Object[], String, List<String>, String)	Reads the DataSet from given XML reader.
Public method Static member	ReduceDataSetData	Reduces the data set data. Works in two modes: 1 - remove records (when calculateAverage is FALSE) 2 - calculate average values for the intervals (when calculateAverage is TRUE)
Public method Static member	RenameTable	Renames the table in the given DataSet.
Public method Static member	RestrictRows(DataSet, Int32)	Restricts the number of rows to the top N items.
Public method Static member	RestrictRows(DataSet, Int32, Int32, Int32)	Restricts the given DataSet to only given rows starting with the offset, and leaving only maximum defined number of rows.
Public method Static member	SelectRowsByString	Selects the table rows by string values.
Public method Static member	SetColumnValues	Sets column values to specified value.
Public method Static member	SetDataRowValue	Sets value to data row. If value is null, DBNull will be used.
Public method Static member	SetPartialValue	Sets new value to string that is separates by separator.
Public method Static member	SetTableName	Sets the table name in the specified DataSet.
Public method Static member	ShiftValuesUp	Shifts the values in the column of Data table one row up.
Public method Static member	SortDataTable	Sorts the Data table using given OrderBy expression.
Public method Static member	TransferTable	Transfers tables from source DataSet to the destination DataSet and sets the source table name to specified value.
Public method Static member	TransferTableRows	Transfers table rows between two tables.
Public method Static member	TransferTables	Transfers tables from source DataSet to the destination DataSet.
Public method Static member	TranslateBinaryColumn	Translates the binary column within data table from its string representation to byte[].
Public method Static member	TrimDataSetPage	Trims first data table from source to fit into page.
Public method Static member	TrimLastIdFromList(String)	Trims last ID from ID list (delimited by semicolon). Returns trimmed list
Public method Static member	TrimLastIdFromList(String, Int32)	Trims last ID from ID list. Returns trimmed list.
Public method Static member	TryGetDataRowValue	Returns the value from the DataRow field.
Public method Static member	TryGetDataRowViewValue	Returns the value from the DataRowView field.
Public method Static member	Union	Creates the union of two Datasets, the values are compared for uniqueness by the given ID column name.
Public method Static member	WriteDataSetToXml	Writes the DataSet from given XML reader.

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
Public field Static member	DATETIME_NOT_SELECTED	No datetime selected constant.
Public field Static member	FAKE_ID	Fake ID to use when the ID column requires a value, and needs to be faked