Class EditActionChangeFieldValue

An EditAction which is used to change a field's value.

Inheritance
System.Object
EditAction
EditActionChangeFieldValue
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Sdl.LanguagePlatform.TranslationMemory.EditScripts
Assembly: Sdl.LanguagePlatform.TranslationMemory.dll
Syntax
public class EditActionChangeFieldValue : EditAction

Constructors

EditActionChangeFieldValue(FieldValue, Mode)

Initializes a new instance with the specified values.

Declaration
public EditActionChangeFieldValue(FieldValue v, Mode m)
Parameters
Type Name Description
FieldValue v

The field value to apply
Mode m

The field update mode.

Properties

FieldValue

Gets or sets the field value to apply

Declaration
public FieldValue FieldValue { get; set; }
Property Value
Type Description
FieldValue

Mode

Gets or sets the field update mode to apply

Declaration
public Mode Mode { get; set; }
Property Value
Type Description
Mode

Methods

Apply(TranslationUnit)

See Apply(TranslationUnit)

Declaration
public override bool Apply(TranslationUnit tu)
Parameters
Type Name Description
TranslationUnit tu

The TU to apply the edit action to
Returns
Type Description
System.Boolean

true if a change was made to the TU, and false otherwise.
Overrides

Validate(IFieldDefinitions, Boolean)

See Validate(IFieldDefinitions, Boolean)

Declaration
public override bool Validate(IFieldDefinitions fields, bool throwIfInvalid)
Parameters
Type Name Description
IFieldDefinitions fields

The field definitions to validate against.
System.Boolean throwIfInvalid

If true, an exception will be thrown if invalid field names or other issues are encountered. If false, the return value will be set to false without an exception being thrown.
Returns
Type Description
System.Boolean

true if the edit action is valid, given the provided field definitions, and false otherwise.
Overrides