TranslationHelper Class

Class to provide objects translation interface ID - CodeName.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.TranslationHelper

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

Syntax

public class TranslationHelper

The TranslationHelper type exposes the following members.

Constructors

	Name	Description
Public method	TranslationHelper()	Constructor.
Public method	TranslationHelper(DataTable)	Constructor. Creates the helper initialized with given translation table.

Methods

	Name	Description
Public method	AddIDTranslation	Adds the ID translation to the translation table.
Public method	Clear	Clears the translation table.
Public method	FilterExistingRecords	Filters the existing records from the given array.
Public method	GetCodeName(String, Int32)	Returns the code name of the specified object.
Public method	GetCodeName(String, Int32, String)	Returns the code name of the specified object.
Public method Static member	GetCodeNameColumn	Gets the code name column for specified object type.
Public method Static member	GetCodeNameFromDB	Gets the object code name from the database.
Public method	GetCodeNamesFromDB	Gets the code names from database and returns Hastable of couples [ID] -> [Codename]
Public method	GetDefaultValue	Gets default value.
Public method Static member	GetEmptyTable	Returns empty translation table.
Public method Static member	GetGroupIDColumn	Gets the group ID column for specified object type.
Public method	GetID(String, String, String, Int32, Int32)	Returns the object ID for specified record.
Public method	GetID(String, String, String, Int32, Int32, Int32)	Returns the object ID for specified record.
Public method Static member	GetIDColumn	Gets the ID column for specified object type.
Public method Static member	GetIDFromDB	Gets the object ID from the database.
Public method	GetNewID(String, Int32, String, Int32, String, String, String)	Gets the new ID for given old ID.
Public method	GetNewID(String, Int32, String, Int32, String, String, String, Boolean, Int32)	Gets the new ID for given old ID.
Public method Static member	GetParentIDColumn	Gets the parent ID column for specified object type.
Public method Static member	GetParentType	Gets the parent object type for specified object type.
Public method	GetRecord(String, Int32)	Gets the record by ID.
Public method	GetRecord(String, String, String, Int32, Int32)	Gets the record by ID.
Public method Static member	GetSafeClassName	Gets the safe class name.
Public method Static member	GetSiteIDColumn	Gets the site id column for specified object type.
Public method	HasRecords	Returns true if the helper contains some records.
Public method	ChangeCodeName	Changes the object code name in the table.
Public method Static member	IsEmpty	Determines whether the given translation helper contains any translations or not.
Public method Static member	IsExcluded	Returns true of the column is excluded.
Public method	RecordExists(String, Int32)	Returns true if specified record exists in translation table.
Public method	RecordExists(String, String, String, Int32, Int32)	Returns true if specified record exists in translation table.
Public method	RegisterDynamicRecords(DataTable, String, String, String, String[])	Registers the dynamic records from the given table.
Public method	RegisterDynamicRecords(DataView, String, String, String, String[])	Registers the records from the given table.
Public method	RegisterRecord(String, Int32, String, Int32)	Registers the record within given translation table.
Public method	RegisterRecord(String, Int32, String, String, Int32, String, Int32)	Registers the record within given translation table.
Public method	RegisterRecords(DataTable, String, String, String)	Registers the records from the given table.
Public method	RegisterRecords(String, IList<Int32>, String, String[])	Registers the records from the given ID list.
Public method	RegisterRecords(DataTable, String, String, String, String[])	Registers the records from the given table.
Public method	RegisterRecords(DataView, String, String, String, String[])	Registers the records from the given table.
Public method	RegisterRecords(DataTable, String, String, String, String, String, String)	Registers the records from the given table.
Public method	RemoveDefaultValue	Removes default value.
Public method	SetDefaultValue	Sets default value.
Public method	TranslateColumn(DataRow, String, String, Int32)	Translates the DataRow column.
Public method	TranslateColumn(GeneralizedInfo, String, String, Int32, Boolean, Boolean)	Translates the column value of the given info object.
Public method	TranslateColumn(IDataContainer, String, String, Int32, Boolean, Boolean)	Translates the column value of the given container.
Public method	TranslateColumns	Translates all reference object columns.
Public method	TranslateListColumn	Translates the column value with list of IDs of the given info object.

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	AUTO_PARENTID	Automatic parent ID.
Public field Static member	AUTO_SITEID	Automatic site ID.
Public field Static member	AUTO_SITENAME	Automatic site name (Get by SiteIDs from DB).
Protected field	mConnection	Connection object used to access data.
Public field	mIDConversion	ID conversion table [objectType.ToLowerCSafe()] -> Hashtable [OldID -> [NewID, NewGroupID]]
Public field Static member	NO_SITE	No site condition for registering records.
Public field Static member	TRANSLATION_TABLE	Name of translation table

Properties

	Name	Description
Public property	IDConversion	ID conversion table [objectType.ToLowerCSafe()] -> Hashtable [OldID -> NewID]
Public property	TranslationTable	Returns the translation table.
Public property	UseDisplayNameAsCodeName	If true, display name is used instead of the code name.