Field Class

Relativity Services API
The Field class represents the name and value of a field on a Relativity object.
Inheritance Hierarchy

System.Object
  kCura.Relativity.Client.Field

Namespace:  kCura.Relativity.Client
Assembly:  kCura.Relativity.Client (in kCura.Relativity.Client.dll) Version: 640db774aa42dfbe1785add27fbb41844ec5c7d4
Syntax

public class Field

The Field type exposes the following members.

Constructors

  NameDescription
Public methodField()
Default constructor for the Field class. It creates an empty object.
Public methodField(List<Guid>)
Creates a new Field with the specified artifactGuids.
Public methodField(Guid)
Creates a new Field with the specified artifactGuid.
Public methodField(Int32)
Creates a new Field with the specified artifactID.
Public methodField(String)
Creates a new Field with the specified name.
Public methodField(List<Guid>, Object)
Creates a new Field with the specified artifactGuids and value.
Public methodField(Guid, Object)
Creates a new Field with the specified artifactGuid and value.
Public methodField(Int32, Object)
Creates a new Field with the specified artifactID and value.
Public methodField(Int32, String)
Creates a new Field with the specified artifactID and name.
Public methodField(String, Object)
Creates a new Field with the specified name and value.
Public methodField(List<Guid>, FieldCategory, FieldType)
Creates a new Field with the specified artifactGuids, field category, and field type.
Public methodField(List<Guid>, String, Object)
Creates a new Field with the specified artifactGuid, name, and value.
Public methodField(Guid, FieldCategory, FieldType)
Creates a new Field with the specified artifactGuid, field category, and field type.
Public methodField(Guid, String, Object)
Creates a new Field with the specified artifactGuid, name, and value.
Public methodField(Int32, FieldCategory, FieldType)
Creates a new Field with the specified artifactID, field category, and field type.
Public methodField(Int32, String, Object)
Creates a new Field with the specified artifactID, name, and value.
Public methodField(String, FieldCategory, FieldType)
Creates a new Field with the specified name, field category, and field type.
Public methodField(List<Guid>, Object, FieldCategory, FieldType)
Creates a new Field with the specified artifactGuids, value, field category, and field type.
Public methodField(Guid, Object, FieldCategory, FieldType)
Creates a new Field with the specified artifactGuid, value, field category, and field type.
Public methodField(Int32, Object, FieldCategory, FieldType)
Creates a new Field with the specified artifactID, value, field category, and field type.
Public methodField(Int32, String, FieldCategory, FieldType)
Creates a new Field with the specified artifactID, name, field category and field type.
Public methodField(String, Object, FieldCategory, FieldType)
Creates a new Field with the specified name, value, field category, and field type.
Public methodField(List<Guid>, String, Object, FieldCategory, FieldType)
Creates a new Field with the specified artifactGuid, name, value, field category, and field type.
Public methodField(Guid, String, Object, FieldCategory, FieldType)
Creates a new Field with the specified artifactGuid, name, value, field category and field type.
Public methodField(Int32, String, Object, FieldCategory, FieldType)
Creates a new Field with the specified artifactID, name, value, field category, and field type.
Top
Properties

  NameDescription
Public propertyStatic memberAllFields
Returns a List of Field with a single Field set to a directive that will request that all fields be returned.
Public propertyArtifactGuids
Provides a list of GUIDs representing a Field. It is optional when an ArtifactID is provided.
Public propertyArtifactID
Indicates the unique identifier for a Field. It is optional when an ArtifactGuids is provided.
Public propertyFieldCategory
Provides the FieldCategory of the Field definition.
Public propertyFieldType
Provides the FieldCategory of the Field definition.
Public propertyName
Gets or sets the name of the Field.
Public propertyStatic memberNoFields
Returns a List of Field with a single Field set to a directive that will request that no fields be returned.
Public propertyStatic memberSelectedFields
Returns a List of Field with a single Field set to a directive that for a query with a SavedSearch or View condition, the fields defined by the SavedSearch or View will be returned.
Public propertyValue
Gets or sets the value of the Field.
Public propertyViewFieldID
A unique identifier for a Field. It is optional when an ArtifactID or ArtifactGuids is provided.
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 value of this Field.
(Overrides Object.ToString().)
Top
Remarks

Some examples of fields on a Document include Control Number, Group Identifier, Extracted Text and System Created On.
See Also

Reference