Interface ITypedKeyValueContainer
Simplified interface for retrieving field values.
An object that has field values associated with it should implement this interface (such as TranslationUnit).
Namespace: Sdl.LanguagePlatform.TranslationMemory
Assembly: Sdl.LanguagePlatform.TranslationMemory.dll
Syntax
public interface ITypedKeyValueContainer
Methods
GetType(String)
Returns the type of the field with name "fieldName". If the object does not have a value for that field, returns FieldValueType.Unknown.
Declaration
FieldValueType GetType(string fieldName)
Parameters
Type | Name | Description |
---|---|---|
System.String | fieldName | The field name. |
Returns
Type | Description |
---|---|
FieldValueType | The type of that field, or FieldValueType.Unknown if it doesn't exist. |
GetValue(String)
Returns the value of field with name "fieldName". The return value can be any field type.
Declaration
FieldValue GetValue(string fieldName)
Parameters
Type | Name | Description |
---|---|---|
System.String | fieldName | The field name. |
Returns
Type | Description |
---|---|
FieldValue | The value of the field, or null if not defined. |
GetValue(String, FieldValueType)
Returns the value of field with name "fieldName", given the field value type t.
Declaration
FieldValue GetValue(string fieldName, FieldValueType t)
Parameters
Type | Name | Description |
---|---|---|
System.String | fieldName | The field name |
FieldValueType | t | The field type to return the value for. |
Returns
Type | Description |
---|---|
FieldValue | null if no value is defined. Throws exception if value is of a different type. |