Class EditActionDeleteFieldValue

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

Inheritance

object

EditAction

EditActionDeleteFieldValue

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 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
IListstring	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
string	fieldName

Properties

FieldNames

Gets or sets the names of the fields to delete.

Declaration

[DataMember]
public IList<string> FieldNames { get; set; }

Property Value

Type	Description
IListstring

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)