Click or drag to resize
TranslationHelper Class
Class to provide objects translation interface ID - CodeName.
Inheritance Hierarchy

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 11.0.0
Syntax
C#
public class TranslationHelper

The TranslationHelper type exposes the following members.

Constructors
  NameDescription
Public methodTranslationHelper
Constructor.
Public methodTranslationHelper(DataTable)
Constructor. Creates the helper initialized with given translation table.
Top
Fields
  NameDescription
Public fieldStatic memberAUTO_PARENTID
Automatic parent ID.
Public fieldStatic memberAUTO_SITEID
Automatic site ID
Public fieldStatic memberAUTO_SITENAME
Automatic site name (Get by SiteIDs from DB).
Protected fieldmConnection
Connection object used to access data.
Public fieldStatic memberNO_SITE
No site condition for registering records.
Public fieldStatic memberQUERY_OBJECT_TYPE_COLUMN
Name of the computed column that contains (real) object type of current row. Column is used in data query obtaining code names and other information based on ID and object type. Requested object type can differ from real object type when original and related object types are defined.
Public fieldStatic memberRECORD_CLASS_NAME_COLUMN
Name of column with object's class name identifier in a record's DataRow.
Public fieldStatic memberRECORD_CODE_NAME_COLUMN
Name of column with object's code name in a record's DataRow.
Public fieldStatic memberRECORD_GROUP_ID_COLUMN
Name of column with object's group identifier in a record's DataRow.
Public fieldStatic memberRECORD_GUID_COLUMN
Name of column with object's GUID in a record's DataRow.
Public fieldStatic memberRECORD_ID_COLUMN
Name of column with object's identifier in a record's DataRow.
Public fieldStatic memberRECORD_INFO_COLUMN
Name of column with object's additional information in a record's DataRow.
Public fieldStatic memberRECORD_OBJECT_TYPE_COLUMN
Name of column with object's class name in a record's DataRow.
Public fieldStatic memberRECORD_PARENT_ID_COLUMN
Name of column with object's parent identifier in a record DataRow.
Public fieldStatic memberRECORD_SITE_NAME_COLUMN
Name of column with object's site name in a record's DataRow.
Public fieldStatic memberTRANSLATION_TABLE
Name of translation table
Top
Properties
  NameDescription
Public propertyIDConversion
ID conversion table [objectType.ToLowerCSafe()] -> hash table [OldID -> NewID]
Public propertyTranslationTable
Returns the translation table.
Public propertyUseDisplayNameAsCodeName
If true, display name is used instead of the code name.
Top
Methods
  NameDescription
Public methodAddIDTranslation
Adds the ID translation to the translation table.
Public methodChangeCodeName
Changes the object code name in the table.
Public methodClear
Clears the translation table.
Public methodFilterExistingRecords
Filters the existing records from the given array.
Public methodGetCodeName(String, Int32)
Returns the code name of the specified object.
Public methodGetCodeName(String, Int32, String)
Returns the code name of the specified object.
Public methodGetDefaultValue
Gets default value.
Public methodStatic memberGetEmptyTable
Returns empty translation table.
Public methodGetID
Returns the object ID for specified record.
Public methodStatic memberGetIDFromDB
Gets the object ID from the database.
Public methodGetIDWithFallback
Returns the object ID for specified record calling GetID(TranslationParameters). If record could not be found, method falls back to GetIDFromDB(GetIDParameters, String) and eventually registers DB object in the helper. If neither attempt results into valid object ID, 0 is returned.
Public methodGetNewID(String, Int32, String, Int32, String, String, String)
Gets the new ID for given old ID.
Public methodGetNewID(String, Int32, String, Int32, String, String, String, Boolean, Int32)
Gets the new ID for given old ID.
Public methodGetNewIDs
Gets the dictionary of new IDs for the given list of old IDs [oldId => [ newId, newGroupId ]] Caches the newly retrieved items in the conversion cache
Public methodStatic memberGetParentType
Gets the parent object type for specified object type.
Public methodGetRecord(TranslationParameters)
Gets the record specified by parameters.
Public methodGetRecord(String, Int32)
Gets the record by ID.
Public methodStatic memberGetSafeClassName
Gets the safe class name.
Public methodGetTranslationsXml
Gets the translations XML
Public methodHasRecords
Returns true if the helper contains some records.
Public methodStatic memberIsEmpty
Determines whether the given translation helper contains any translations or not.
Public methodStatic memberIsExcluded
Returns true of the column is excluded.
Public methodRecordExists
Returns true if specified record exists in translation table.
Public methodRegisterDynamicRecords
Registers the records from the given table.
Public methodRegisterRecord
Registers the record within given translation table.
Public methodRegisterRecords(IListInt32, String, String, String)
Registers the records from the given list.
Public methodRegisterRecords(String, IListInt32, String, String)
Registers the records from the given ID list.
Public methodRegisterRecords(DataTable, String, String, String, String)
Registers the records from the given table.
Public methodRemoveDefaultValue
Removes default value.
Public methodSetDefaultValue
Sets default value.
Public methodTranslateColumn(DataRow, String, String, Int32)
Translates the DataRow column.
Public methodTranslateColumn(GeneralizedInfo, String, String, Int32, Boolean, Boolean)
Translates the column value of the given info object.
Public methodTranslateColumn(IDataContainer, String, String, Int32, Boolean, Boolean)
Translates the column value of the given container.
Public methodTranslateColumns
Translates all reference object columns.
Public methodTranslateListColumn
Translates the column value with list of IDs of the given info object.
Top
Extension Methods
  NameDescription
Public Extension MethodGetForeignID
Returns the ID of specified object.
(Defined by TranslationHelperForeignKeyExtensions.)
Top
See Also