Class EditActionDeleteFieldValue

Deletes the fields' values from the TU. Will do nothing on core system fields, but does reset TU contexts, if defined. Note that the field itself will not be deleted from the TM's setup.

Inheritance
System.Object
EditAction
EditActionDeleteFieldValue
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 EditActionDeleteFieldValue : EditAction

Constructors

EditActionDeleteFieldValue()

Initializes a new instance with an empty field name list.

Declaration
public EditActionDeleteFieldValue()

EditActionDeleteFieldValue(IList<String>)

Initializes a new instance with the specified list of field names.

Declaration
public EditActionDeleteFieldValue(IList<string> fieldNames)
Parameters
Type Name Description
System.Collections.Generic.IList<System.String> fieldNames

The list of field names to delete

EditActionDeleteFieldValue(String)

Initializes a new instance with a new field name list. The field name list will have fieldName as its single member.

Declaration
public EditActionDeleteFieldValue(string fieldName)
Parameters
Type Name Description
System.String fieldName

Properties

FieldNames

Gets or sets the names of the fields to delete.

Declaration
public IList<string> FieldNames { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<System.String>

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