Search Results for

    Show / Hide Table of Contents

    Class SingleStringFieldValue

    Represents a field value, which is a combination of a field name, a field value type, and the actual field values. This class is abstract.

    Inheritance
    object
    FieldValue
    SingleStringFieldValue
    Inherited Members
    FieldValue.Name
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetType()
    object.MemberwiseClone()
    Namespace: Sdl.LanguagePlatform.TranslationMemory
    Assembly: Sdl.LanguagePlatform.TranslationMemory.dll
    Syntax
    [DataContract]
    public class SingleStringFieldValue : FieldValue

    Constructors

    SingleStringFieldValue()

    Initializes a new instance with default values. Required for serialization.

    Declaration
    public SingleStringFieldValue()

    SingleStringFieldValue(SingleStringFieldValue)

    Initializes a new instance from another SingleStringFieldValue value.

    Declaration
    public SingleStringFieldValue(SingleStringFieldValue other)
    Parameters
    Type Name Description
    SingleStringFieldValue other

    The other instance.

    SingleStringFieldValue(string)

    Initializes a new instance with the specified field name.

    Declaration
    public SingleStringFieldValue(string name)
    Parameters
    Type Name Description
    string name

    The field name.

    SingleStringFieldValue(string, string)

    Initializes a new instance of the SingleStringFieldValue class with the specified name and value.

    Declaration
    public SingleStringFieldValue(string name, string v)
    Parameters
    Type Name Description
    string name

    The field name.

    string v

    The field value.

    Properties

    Value

    Gets or sets the value for this instance.

    Declaration
    [DataMember]
    public string Value { get; set; }
    Property Value
    Type Description
    string

    ValueType

    Gets the field value type.

    Declaration
    public override FieldValueType ValueType { get; set; }
    Property Value
    Type Description
    FieldValueType
    Overrides
    FieldValue.ValueType

    Methods

    Add(FieldValue)

    Adds another field value to the current value. The other value must be of the same type.

    Declaration
    public override bool Add(FieldValue rhs)
    Parameters
    Type Name Description
    FieldValue rhs

    The field value to add.

    Returns
    Type Description
    bool

    true

    Overrides
    FieldValue.Add(FieldValue)

    Add(string)

    Adds another string to this instance's value list, if this instance is of any of the multiple valued types.

    Declaration
    public override bool Add(string s)
    Parameters
    Type Name Description
    string s

    The new value to be added.

    Returns
    Type Description
    bool

    true if this instance was changed, false otherwise.

    Overrides
    FieldValue.Add(string)

    Clear()

    Resets this instance to the default value.

    Declaration
    public override void Clear()
    Overrides
    FieldValue.Clear()

    Duplicate()

    Creates a new instance that is a deep copy of this instance.

    Declaration
    public override FieldValue Duplicate()
    Returns
    Type Description
    FieldValue

    A new instance that is a deep copy of this instance.

    Overrides
    FieldValue.Duplicate()

    Equals(object)

    System.Object.Equals(object)

    Declaration
    public override bool Equals(object obj)
    Parameters
    Type Name Description
    object obj

    The object to compare with the current object.

    Returns
    Type Description
    bool

    true if the specified object is equal to the current object; otherwise, false.

    Overrides
    object.Equals(object)

    GetHashCode()

    System.Object.GetHashCode(object)

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    int
    Overrides
    object.GetHashCode()

    GetValueString()

    Compute a string which represents the field value without the field name in a way which can be reversed through parsing. This should only be used internally by the field expression parser. UI-level presentation should use the field value's .ToString() method to get the field value display string.

    Declaration
    public override string GetValueString()
    Returns
    Type Description
    string

    A serialized string representation of the field value, which is suitable for persisting, and can be parsed through Parse(string).

    Overrides
    FieldValue.GetValueString()

    Merge(FieldValue)

    Merges this instance with another field value, which must be of the same type.

    Declaration
    public override bool Merge(FieldValue rhs)
    Parameters
    Type Name Description
    FieldValue rhs

    The object to merge with.

    Returns
    Type Description
    bool

    true if this instance was changed, false otherwise.

    Overrides
    FieldValue.Merge(FieldValue)

    Parse(string)

    Initializes this instance from a string (deserialization).

    Declaration
    public override void Parse(string s)
    Parameters
    Type Name Description
    string s

    The string that contains the serialized form.

    Overrides
    FieldValue.Parse(string)

    Substract(FieldValue)

    Substracts a field value from this instance's field value. Both field values must be of the same type.

    Declaration
    public override bool Substract(FieldValue rhs)
    Parameters
    Type Name Description
    FieldValue rhs

    The field value to substract.

    Returns
    Type Description
    bool

    true if this instance was changed, false otherwise.

    Overrides
    FieldValue.Substract(FieldValue)

    ToString()

    ToString()

    Declaration
    public override string ToString()
    Returns
    Type Description
    string

    A string representation of the object, for display purposes.

    Overrides
    object.ToString()
    In this article
    • Constructors
      • SingleStringFieldValue()
      • SingleStringFieldValue(SingleStringFieldValue)
      • SingleStringFieldValue(string)
      • SingleStringFieldValue(string, string)
    • Properties
      • Value
      • ValueType
    • Methods
      • Add(FieldValue)
      • Add(string)
      • Clear()
      • Duplicate()
      • Equals(object)
      • GetHashCode()
      • GetValueString()
      • Merge(FieldValue)
      • Parse(string)
      • Substract(FieldValue)
      • ToString()
    Back to top Generated by DocFX