TranslationHelperForeignKeyExtensions.GetForeignID Method

Returns the ID of specified object.

Namespace: CMS.DataEngine.Serialization
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 10.0.0

Syntax

public static int GetForeignID(
	this TranslationHelper translationHelper,
	TranslationReference reference
)

Parameters

translationHelper

Type: CMS.DataEngine.TranslationHelper
TranslationHelper to work with.

reference

Type: CMS.DataEngine.Serialization.TranslationReference
Information necessary to obtain the ID of an object.

Return Value

Type: Int32

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type TranslationHelper. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Remarks

The TranslationTable property contains data records that correspond with the database. For translation records identified using partially correct parameters (either the code name or GUID is different than the value in the database), the actual values are loaded from the database for all fields. An index key referencing the correct data is then created from the partial parameters. The index key is used to obtain the record in future calls.