Field Class

Relativity Import APIs
Represents a field, which is used to store data for documents and RDOs.
Inheritance Hierarchy

Object
  kCura.Relativity.ImportAPI.DataArtifact
    kCura.Relativity.ImportAPI.DataField

Namespace:  kCura.Relativity.ImportAPI.Data
Assembly:  Relativity.DataExchange.Client.SDK (in Relativity.DataExchange.Client.SDK.dll) Version: 1.5.0
Syntax

public class Field : Artifact

The Field type exposes the following members.

Constructors

  NameDescription
Public methodField
Top
Properties

  NameDescription
Public propertyArtifactID
Represents a unique identifier for an Artifact.
(Inherited from Artifact.)
Public propertyArtifactTypeId
Represents the identifier for the type of item that the Artifact represents.
(Inherited from Artifact.)
Public propertyAssociatedObjectTypeID
Identifies the ObjectType associated with the field.
Public propertyEnableDataGrid
Indicates if the field should be written to Data Grid
Public propertyFieldCategory
Provides the FieldCategory of the field definition.
Public propertyFieldLength
Indicates the length of a fixed-length text field.
Public propertyFieldTypeID
Represents the ID of a FieldType used to determine the functionality and presentation of the field.
Public propertyGuids
Provides a list of GUIDs used to identify an Artifact.
Public propertyName
Indicates the value of the Identifier field for the artifact.
(Inherited from Artifact.)
Public propertyParentArtifactID
Represents the identifier for the parent of the artifact.
(Inherited from Artifact.)
Public propertyUseUnicode
Indicates whether foreign language characters can be used.
Top
Methods

  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Returns a string that represents the Artifact.
(Inherited from Artifact.)
Top
See Also

Reference