Click or drag to resize
Field Class
Represents a field declaration.
Inheritance Hierarchy

Namespace: Sdl.LanguagePlatform.TranslationMemory
Assembly: Sdl.LanguagePlatform.TranslationMemory (in Sdl.LanguagePlatform.TranslationMemory.dll) Version: 1.6.0.0 (1.7.3662.0)
Syntax
public class Field : PersistentObject, ICloneable, 
	IField

The Field type exposes the following members.

Constructors
  NameDescription
Public methodField
Initializes a new instance with default values.
Public methodField(Field)
Initializes a new instance with the values of another instance, creating a deep copy.
Public methodField(String, FieldValueType)
Initializes a new instance, with the specified name and type.
Top
Properties
  NameDescription
Public propertyFieldType
Gets the type of the field, i.e. whether it is a system or user-defined field.
Public propertyIsSystemField
Gets a flag which indicates that this field is a system field. System fields cannot be changed or deleted by the user. Setting this flag from user-code has no effect.
Public propertyName
Gets or sets the field name.

See IsValidName(String) for a detailed description of accepted identifiers.

Public propertyPicklistItemNames
The names of all picklist items for this Field. This collection will be empty if this field is not a SinglePicklist or MultiplePicklist.
Public propertyResourceId
Gets or sets the resource ID for this object.
(Inherited from PersistentObject.)
Public propertyValueType
Gets or sets the field value type
Top
Methods
  NameDescription
Protected methodCheckName
Checks the given name and throws an exception if the name is not valid.
Public methodClone
Public methodCreateValue
Creates a FieldValue instance, with the same name and type as this field declaration.
Public methodDuplicate
Creates a new instance that is a deep copy of this instance.
Public methodEquals
Determines whether this instance of Field and a specified object, which must also be a Field object, represent the same field declaration including the picklist according to type.
(Overrides ObjectEquals(Object).)
Public methodEqualsDeclaration
Determines whether this instance of Field and a specified object, which must also be a Field object, represent the same field declaration, not considering the picklist.
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodStatic memberGetFieldType
Determine the field type, given the field name.
Public methodGetHashCode
GetHashCode(object)
(Overrides ObjectGetHashCode.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodStatic memberIsPseudoFieldName
Determines whether the name is reserved for a pseudo (non-physical) field.
Public methodStatic memberIsReservedName
Determines whether the name is reserved for system purposes.
Public methodStatic memberIsSystemFieldName
Determines whether the specified name is reserved for a system (predefined) field.
Public methodStatic memberIsValidName
Determines whether a specified string can be used as a field name.

All field names are valid if they don't start or end with whitespace.

Public methodStatic memberLookupSpecialField
Looks up a special field by its name. Special fields are fields with a predefined name, which may be "virtual" fields (those computed from data at runtime) or "physical" fields (which have an actual value in the data storage). Special field names should not be used for user-defined fields. Note that special fields are a superset of system fields (i.e. not all special fields are system fields).
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodStatic memberRemoveIllegalChars
Removes those characters from an input string which are not allowed in field names, and returns the form that will be accepted as a field name identifier. This method should only be used when fields are automatically added by some process (e.g. by importing a TMX file) and that process should be robust and continue despite invalid field names.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Fields
  NameDescription
Public fieldStatic memberStructureContextFieldName
The name for the structure context field name.
Public fieldStatic memberTextContextFieldName
A pseudo-name for the text context field. Since text context values are directly stored at the TU, and not represented as field values, this pseudo field name is only relevant for edit scripts.
Top
See Also
Community
Edit

Be the first to Edit the community content of this topic.
Comments