Class EditActionDeleteAllFieldValues

Deletes all field values, optionally including system fields, such as context information. Will not alter core system fields (creation date, use count, etc.)

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

Constructors

EditActionDeleteAllFieldValues()

Initializes a new instance with default values.

Declaration
public EditActionDeleteAllFieldValues()

EditActionDeleteAllFieldValues(Boolean)

Initializes a new instance with the specified values.

Declaration
public EditActionDeleteAllFieldValues(bool deleteSystemFields)
Parameters
Type Name Description
System.Boolean deleteSystemFields

Determines whether or not to delete system field values as well. Note that a storage implementation may prohibit the deletion of system field values.

Properties

DeleteSystemFields

Gets or sets a flag whether or not to delete system field values. Note that a storage implementation may prohibit the deletion of system field values.

Declaration
public bool DeleteSystemFields { get; set; }
Property Value
Type Description
System.Boolean

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). Always returns true for instances of this class.

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