The Field class represents the name and value of a field on a Relativity object.
Inheritance Hierarchy
kCura.Relativity.Client.Field
Namespace: kCura.Relativity.Client
Assembly: kCura.Relativity.Client (in kCura.Relativity.Client.dll) Version: 640db774aa42dfbe1785add27fbb41844ec5c7d4
Syntax
The Field type exposes the following members.
Constructors
Name | Description | |
---|---|---|
![]() | Field() |
Default constructor for the Field class. It creates an empty object.
|
![]() | Field(List<Guid>) |
Creates a new Field with the specified artifactGuids.
|
![]() | Field(Guid) |
Creates a new Field with the specified artifactGuid.
|
![]() | Field(Int32) |
Creates a new Field with the specified artifactID.
|
![]() | Field(String) |
Creates a new Field with the specified name.
|
![]() | Field(List<Guid>, Object) |
Creates a new Field with the specified artifactGuids and value.
|
![]() | Field(Guid, Object) |
Creates a new Field with the specified artifactGuid and value.
|
![]() | Field(Int32, Object) |
Creates a new Field with the specified artifactID and value.
|
![]() | Field(Int32, String) |
Creates a new Field with the specified artifactID and name.
|
![]() | Field(String, Object) |
Creates a new Field with the specified name and value.
|
![]() | Field(List<Guid>, FieldCategory, FieldType) |
Creates a new Field with the specified artifactGuids, field category, and field type.
|
![]() | Field(List<Guid>, String, Object) |
Creates a new Field with the specified artifactGuid, name, and value.
|
![]() | Field(Guid, FieldCategory, FieldType) |
Creates a new Field with the specified artifactGuid, field category, and field type.
|
![]() | Field(Guid, String, Object) |
Creates a new Field with the specified artifactGuid, name, and value.
|
![]() | Field(Int32, FieldCategory, FieldType) |
Creates a new Field with the specified artifactID, field category, and field type.
|
![]() | Field(Int32, String, Object) |
Creates a new Field with the specified artifactID, name, and value.
|
![]() | Field(String, FieldCategory, FieldType) |
Creates a new Field with the specified name, field category, and field type.
|
![]() | Field(List<Guid>, Object, FieldCategory, FieldType) |
Creates a new Field with the specified artifactGuids, value, field category, and field type.
|
![]() | Field(Guid, Object, FieldCategory, FieldType) |
Creates a new Field with the specified artifactGuid, value, field category, and field type.
|
![]() | Field(Int32, Object, FieldCategory, FieldType) |
Creates a new Field with the specified artifactID, value, field category, and field type.
|
![]() | Field(Int32, String, FieldCategory, FieldType) |
Creates a new Field with the specified artifactID, name, field category and field type.
|
![]() | Field(String, Object, FieldCategory, FieldType) |
Creates a new Field with the specified name, value, field category, and field type.
|
![]() | Field(List<Guid>, String, Object, FieldCategory, FieldType) |
Creates a new Field with the specified artifactGuid, name, value, field category, and field type.
|
![]() | Field(Guid, String, Object, FieldCategory, FieldType) |
Creates a new Field with the specified artifactGuid, name, value, field category and field type.
|
![]() | Field(Int32, String, Object, FieldCategory, FieldType) |
Creates a new Field with the specified artifactID, name, value, field category, and field type.
|
Properties
Name | Description | |
---|---|---|
![]() ![]() | AllFields |
Returns a List of Field with a single Field set to a directive that will request that all fields be returned.
|
![]() | ArtifactGuids |
Provides a list of GUIDs representing a Field. It is optional when an ArtifactID is provided.
|
![]() | ArtifactID |
Indicates the unique identifier for a Field. It is optional when an ArtifactGuids is provided.
|
![]() | FieldCategory |
Provides the FieldCategory of the Field definition.
|
![]() | FieldType |
Provides the FieldCategory of the Field definition.
|
![]() | Name |
Gets or sets the name of the Field.
|
![]() ![]() | NoFields |
Returns a List of Field with a single Field set to a directive that will request that no fields be returned.
|
![]() ![]() | SelectedFields |
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.
|
![]() | Value |
Gets or sets the value of the Field.
|
![]() | ViewFieldID |
A unique identifier for a Field. It is optional when an ArtifactID or ArtifactGuids is provided.
|
Methods
Name | Description | |
---|---|---|
![]() | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
![]() | GetHashCode | Serves as the default hash function. (Inherited from Object.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | ToString |
Returns a String that represents the value of this Field.
(Overrides Object.ToString().) |
Remarks
See Also