This class represents the value of a field on an Artifact instance.
Inheritance Hierarchy
kCura.Relativity.Client.DTOs.FieldValue
Namespace: kCura.Relativity.Client.DTOs
Assembly: kCura.Relativity.Client (in kCura.Relativity.Client.dll) Version: 640db774aa42dfbe1785add27fbb41844ec5c7d4
Syntax
The FieldValue type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | FieldValue() |
Initializes an empty instance of the FieldValue class.
|
| FieldValue(Guid) |
Initializes a new instance of the FieldValue class given the field Guid.
|
| FieldValue(Int32) |
Initializes a new instance of the FieldValue class given the field ArtifactID.
|
| FieldValue(String) |
Initializes a new instance of the FieldValue class with the specified name.
|
| FieldValue(Guid, Object) |
Initializes a new instance of the FieldValue class given the field Guid and value.
|
| FieldValue(String, Object) |
Initializes a new instance of the FieldValue class given the field name and value.
|
| FieldValue(Guid, Object, Boolean) |
Initializes a new instance of the FieldValue class given the field Guid, value, and 'IsUpdated' flag.
|
| FieldValue(Int32, Object, Boolean) |
Initializes a new instance of the FieldValue class given the field ArtifactID, value, and 'IsUpdated' flag.
|
| FieldValue(String, Object, Boolean) |
Initializes a new instance of the FieldValue class given the field name, value, and 'IsUpdated' flag.
|
Properties
| Name | Description | |
|---|---|---|
  | AllFields |
Returns a List of FieldValue with a single FieldValue set to a directive that will request that all fields be returned.
|
| ArtifactID |
This property gets and sets the artifact ID of the field of which this is a FieldValue.
|
| FieldCategory |
This property gets and sets the field category of the field, which is a value from the FieldCategory enum.
|
| FieldType |
This property gets and sets the field type of the field, which is a value from the FieldType enum describing the type of the data contained in the field.
|
| Guids |
This property gets and sets the list of GUIDs that identify the field of which this is a FieldValue.
|
| IsUpdated |
This property indicates whether this field value has been updated, and needs to be sent back to the server when used in a request.
|
| Name |
This property gets and sets the name of the field of which this is a FieldValue.
|
| NoFields |
Returns a List of FieldValue with a single FieldValue 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.
|
| SubObjectFields |
When used in a request, this property specifies the fields to be returned on an object returned as a value in the field specified in this
FieldValue instance.
|
| Value |
This property contains the actual value of this field.
|
| ValueAsCurrency |
The typed value of the field, if it is a Currency field.
|
| ValueAsDate |
The typed value of the field, if it is a Date field.
|
| ValueAsDecimal |
The typed value of the field, if it is a Decimal field.
|
| ValueAsFixedLengthText |
The typed value of the field, if it is a Fixed Length Text field.
|
| ValueAsKeyboardShortcut |
The typed value of the field, if it is a Keyboard Shortcut field.
|
| ValueAsLongText |
The typed value of the field, if it is a Long Text field.
|
| ValueAsMultipleChoice |
The typed value of the field, if it is a Multiple Choice field.
|
| ValueAsRelationalFieldIcon |
The typed value of the field, if it is a File field.
|
| ValueAsSingleChoice |
The typed value of the field, if it is a Single Choice field.
|
| ValueAsSingleObject |
The typed value of the field, if it is a Single Object field.
|
| ValueAsUser |
The typed value of the field, if it is a User field.
|
| ValueAsWholeNumber |
The typed value of the field, if it is a Whole Number field.
|
| ValueAsXmlContainer |
The typed value of the field, if it is XmlContainer.
|
| ValueAsYesNo |
The typed value of the field, if it is a Yes \ No field.
|
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.) |
| GetValueAsMultiLineString |
Get the typed value of a multi-line string field.
|
| GetValueAsMultipleObject<T> |
Get the typed value of a multiple object field.
|
| SetValueAsMultipleObject<T> |
Set the typed value of a multiple object field.
|
| ToString |
Returns a String that represents the value of this Field.
(Overrides Object.ToString().) |
See Also