Field Class

Relativity Services API
Represents a field, which is used to store document metadata and a coding selections made by a reviewer.
Inheritance Hierarchy

System.Object
  kCura.Relativity.Client.DTOs.Artifact
    kCura.Relativity.Client.DTOs.Field

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

public class Field : Artifact

The Field type exposes the following members.

Constructors

  NameDescription
Public methodField()
Initializes a new instance of the Field class.
Public methodField(List<Guid>)
Initializes a new instance of the Field class with the given list of Artifact GUIDs.
Public methodField(Guid)
Initializes a new instance of the Field class with the given Artifact GUID.
Public methodField(Int32)
Initializes a new instance of the Field class with the given ArtifactID.
Top
Properties

  NameDescription
Public propertyAllowGroupBy
Indicates whether the field can be used for grouping in Relativity Pivot.
Public propertyAllowHTML
Indicates whether the field allows HTML code to execute within the field.
Public propertyAllowPivot
Indicates whether the field is available in Relativity Pivot.
Public propertyAllowSortTally
Indicates whether the field can be used to sort document lists.
Public propertyArtifactID
Represents a unique identifier for an Artifact.
(Inherited from Artifact.)
Public propertyArtifactTypeGuids
Provides a list of GUIDs defined for the ArtifactType.
(Inherited from Artifact.)
Public propertyArtifactTypeID
Represents the identifier for the type of item that the Artifact represents.
(Inherited from Artifact.)
Public propertyArtifactTypeName
Indicates name of the ArtifactType used to define the Artifact.
(Inherited from Artifact.)
Public propertyAssociativeObjectType
Identifies the ObjectType associated with this field.
Public propertyAutoAddChoices
Indicates whether all choices associated with a Single or Multiple Choice field are added to an application.
Public propertyAvailableInFieldTree
Indicates whether the field and its choices are displayed in the Field Tree browser.
Public propertyAvailableInViewer
Indicates whether the field is displayed in the viewer.
Public propertyChoices
Used to return a list of valid Choices that a Field of type Choice accepts.
Public propertyChoiceTypeID
Identifies a Single Choice Field or Multi-Choice Field.
Public propertyEnableDataGrid
Determines where the data is stored.
Public propertyFields
Provides a collection of FieldValue objects representing the field values on an Artifact instance.
(Inherited from Artifact.)
Public propertyFieldTreeView
Identifies a view that determines the values displayed in the Field Tree browse, and the order in which they are displayed.
Public propertyFieldTypeID
Represents the ID of a FieldType used to determine the functionality and presentation of the Field.
Public propertyFilterType
Determines the filter type available for the field.
Public propertyFormatting
Determines the format used to display Date or Whole Number fields.
Public propertyFriendlyName
Provides a user-friendly label for a relational field.
Public propertyGuids
Provides a list of GUIDs used to identify an Artifact.
(Inherited from Artifact.)
Public propertyIgnoreWarnings
Indicates if Create should succeed when warning messages are returned.
Public propertyImportBehavior
Determines how blank values are handled during imports through the Relativity Desktop Client.
Public propertyIncludeInTextIndex
Indicates whether field values are added to SQL text index in a workspace.
Public propertyIsIdentifier
Indicates whether the field is a unique identifier for a workspace.
Public propertyIsRelational
Indicates if the field is a relational field.
Public propertyIsRequired
Determines whether the reviewer must populate the field with information in order to continue with the review process.
Public propertyItem[Guid]
Provides a shortcut to the field collection of an Artifact by using the GUID assigned to Fields.
(Inherited from Artifact.)
Public propertyItem[Int32]
Provides a shortcut to a field collection of an Artifact by using the ArtifactID assigned to Fields.
(Inherited from Artifact.)
Public propertyItem[String]
Provides a shortcut to a field collection of an Artifact by using the ArtifactTypeName.
(Inherited from Artifact.)
Public propertyKeyboardShortcut
Defines a keyboard shortcut for a document field.
Public propertyLength
Indicates the length of a fixed-length text field.
Public propertyLinked
Indicates if the field is set as a hyperlink.
Public propertyName
Represents the name of the field.
Public propertyNoValue
Determines how the text for no values for a Field of type Yes/No is displayed.
Public propertyObjectType
Determines the object that Relativity uses to classify the field.
Public propertyOpenToAssociations
Determines whether an object field can display its information on an associated object field.
Public propertyOrder
Determines the position of the Pane Icon on the Related Items pane of the viewer.
Public propertyOverlayBehavior
Determines how multiple-value fields are handled during overlay imports through the Relativity Desktop Client.
Public propertyPaneIcon
Determines the icon displayed in the Related Items pane of the viewer.
Public propertyParentArtifact
Indicates the parent of an Artifact.
(Inherited from Artifact.)
Public propertyPopupPickerView
Determines the items are available in the popup picker view.
Public propertyPropagateTo
Identifies a delimited list of related fields, which have their values automatically coded with the same value as this field.
Public propertyRelationalView
Determines the view that appears in the Related Items pane of the viewer.
Public propertyRelativityApplications
Represents a Multiple Object field specifying the Relativity Application objects associated with this ObjectType.
Public propertySystemCreatedBy
Identifies the User who created the Artifact. This property is available on the Fields property of the Artifact.
(Inherited from Artifact.)
Public propertySystemCreatedOn
Represents the DateTime in UTC when the Artifact was created. This property is available on the Fields property of the Artifact.
(Inherited from Artifact.)
Public propertySystemLastModifiedBy
Identifies the User who last modified the Artifact. This property is available in the Fields property of the Artifact.
(Inherited from Artifact.)
Public propertySystemLastModifiedOn
Represents the DateTime in UTC when the Artifact was last modified. This property is available on the Fields property of the Artifact.
(Inherited from Artifact.)
Public propertyTextIdentifier
Indicates the value of the IdentifierFieldName field available in Fields property of the Artifact. This field may also be available as a Name property for many Artifacts.
(Inherited from Artifact.)
Public propertyUnicode
Indicates if foreign language characters are allowed.
Public propertyVisible
Indicates if the field is visible.
Public propertyWidth
Indicates the width (in pixels) of the column displaying the field's contents in a view. Must be a numeric value passed as a string.
Public propertyWrapping
Indicates whether the text in a field is displayed in multiple lines.
Public propertyYesValue
Determines how the text for yes values for a Field of type Yes/No is displayed.
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 current Artifact.
(Inherited from Artifact.)
Top
Remarks

The Field class supports create, read, delete, and query operations.
See Also

Reference