Class EditActionDeleteAllFieldValues

Represents a single edit action which can be applied to a TU.

Inheritance

object

EditAction

EditActionDeleteAllFieldValues

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: SdlSdl.LanguagePlatformTranslationMemoryEditScripts

Assembly: Sdl.LanguagePlatform.TranslationMemory.dll

Syntax

[DataContract]
public class EditActionDeleteAllFieldValues : EditAction

Constructors

EditActionDeleteAllFieldValues()

Initializes a new instance with default values.

Declaration

public EditActionDeleteAllFieldValues()

EditActionDeleteAllFieldValues(bool)

Initializes a new instance with the specified values.

Declaration

public EditActionDeleteAllFieldValues(bool deleteSystemFields)

Parameters

Type	Name	Description
bool	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

[DataMember]
public bool DeleteSystemFields { get; set; }

Property Value

Type	Description
bool

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
bool	true if a change was made to the TU, and false otherwise.

Overrides

EditAction.Apply(TranslationUnit)

Validate(IFieldDefinitions, bool)

Validates the edit action against the provided field definitions.

Declaration

public override bool Validate(IFieldDefinitions fields, bool throwIfInvalid)

Parameters

Type	Name	Description
IFieldDefinitions	fields	The field definitions to validate against.
bool	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
bool	true if the edit action is valid, given the provided field definitions, and false otherwise.

Overrides

EditAction.Validate(IFieldDefinitions, bool)