Represents a field, which is used to store document metadata and a coding selections made by a reviewer.
Inheritance Hierarchy
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
The Field type exposes the following members.
Constructors
Name | Description | |
---|---|---|
![]() | Field() |
Initializes a new instance of the Field class.
|
![]() | Field(List<Guid>) |
Initializes a new instance of the Field class with the given list of Artifact GUIDs.
|
![]() | Field(Guid) |
Initializes a new instance of the Field class with the given Artifact GUID.
|
![]() | Field(Int32) |
Initializes a new instance of the Field class with the given ArtifactID.
|
Properties
Name | Description | |
---|---|---|
![]() | AllowGroupBy |
Indicates whether the field can be used for grouping in Relativity Pivot.
|
![]() | AllowHTML |
Indicates whether the field allows HTML code to execute within the field.
|
![]() | AllowPivot |
Indicates whether the field is available in Relativity Pivot.
|
![]() | AllowSortTally |
Indicates whether the field can be used to sort document lists.
|
![]() | ArtifactID |
Represents a unique identifier for an Artifact.
(Inherited from Artifact.) |
![]() | ArtifactTypeGuids |
Provides a list of GUIDs defined for the ArtifactType.
(Inherited from Artifact.) |
![]() | ArtifactTypeID |
Represents the identifier for the type of item that the Artifact represents.
(Inherited from Artifact.) |
![]() | ArtifactTypeName |
Indicates name of the ArtifactType used to define the Artifact.
(Inherited from Artifact.) |
![]() | AssociativeObjectType |
Identifies the ObjectType associated with this field.
|
![]() | AutoAddChoices |
Indicates whether all choices associated with a Single or Multiple Choice field are added to an application.
|
![]() | AvailableInFieldTree |
Indicates whether the field and its choices are displayed in the Field Tree browser.
|
![]() | AvailableInViewer |
Indicates whether the field is displayed in the viewer.
|
![]() | Choices |
Used to return a list of valid Choices that a Field of type Choice accepts.
|
![]() | ChoiceTypeID |
Identifies a Single Choice Field or Multi-Choice Field.
|
![]() | EnableDataGrid |
Determines where the data is stored.
|
![]() | Fields |
Provides a collection of FieldValue objects representing the field values on an Artifact instance.
(Inherited from Artifact.) |
![]() | FieldTreeView |
Identifies a view that determines the values displayed in the Field Tree browse, and the order in which they are displayed.
|
![]() | FieldTypeID |
Represents the ID of a FieldType used to determine the functionality and presentation of the Field.
|
![]() | FilterType |
Determines the filter type available for the field.
|
![]() | Formatting |
Determines the format used to display Date or Whole Number fields.
|
![]() | FriendlyName |
Provides a user-friendly label for a relational field.
|
![]() | Guids |
Provides a list of GUIDs used to identify an Artifact.
(Inherited from Artifact.) |
![]() | IgnoreWarnings |
Indicates if Create should succeed when warning messages are returned.
|
![]() | ImportBehavior |
Determines how blank values are handled during imports through the Relativity Desktop Client.
|
![]() | IncludeInTextIndex |
Indicates whether field values are added to SQL text index in a workspace.
|
![]() | IsIdentifier |
Indicates whether the field is a unique identifier for a workspace.
|
![]() | IsRelational |
Indicates if the field is a relational field.
|
![]() | IsRequired |
Determines whether the reviewer must populate the field with information in order to continue with the review process.
|
![]() | Item[Guid] |
Provides a shortcut to the field collection of an Artifact by using the GUID assigned to Fields.
(Inherited from Artifact.) |
![]() | Item[Int32] |
Provides a shortcut to a field collection of an Artifact by using the ArtifactID assigned to Fields.
(Inherited from Artifact.) |
![]() | Item[String] |
Provides a shortcut to a field collection of an Artifact by using the ArtifactTypeName.
(Inherited from Artifact.) |
![]() | KeyboardShortcut |
Defines a keyboard shortcut for a document field.
|
![]() | Length |
Indicates the length of a fixed-length text field.
|
![]() | Linked |
Indicates if the field is set as a hyperlink.
|
![]() | Name |
Represents the name of the field.
|
![]() | NoValue |
Determines how the text for no values for a Field of type Yes/No is displayed.
|
![]() | ObjectType |
Determines the object that Relativity uses to classify the field.
|
![]() | OpenToAssociations |
Determines whether an object field can display its information on an associated object field.
|
![]() | Order |
Determines the position of the Pane Icon on the Related Items pane of the viewer.
|
![]() | OverlayBehavior |
Determines how multiple-value fields are handled during overlay imports through the Relativity Desktop Client.
|
![]() | PaneIcon |
Determines the icon displayed in the Related Items pane of the viewer.
|
![]() | ParentArtifact |
Indicates the parent of an Artifact.
(Inherited from Artifact.) |
![]() | PopupPickerView |
Determines the items are available in the popup picker view.
|
![]() | PropagateTo |
Identifies a delimited list of related fields, which have their values automatically coded with the same value as this field.
|
![]() | RelationalView |
Determines the view that appears in the Related Items pane of the viewer.
|
![]() | RelativityApplications |
Represents a Multiple Object field specifying the Relativity Application objects associated with this ObjectType.
|
![]() | SystemCreatedBy |
Identifies the User who created the Artifact. This property is available on the Fields property of the Artifact.
(Inherited from Artifact.) |
![]() | SystemCreatedOn |
Represents the DateTime in UTC when the Artifact was created. This property is available on the Fields property of the Artifact.
(Inherited from Artifact.) |
![]() | SystemLastModifiedBy |
Identifies the User who last modified the Artifact. This property is available in the Fields property of the Artifact.
(Inherited from Artifact.) |
![]() | SystemLastModifiedOn |
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.) |
![]() | TextIdentifier |
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.) |
![]() | Unicode |
Indicates if foreign language characters are allowed.
|
![]() | Visible |
Indicates if the field is visible.
|
![]() | Width |
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.
|
![]() | Wrapping |
Indicates whether the text in a field is displayed in multiple lines.
|
![]() | YesValue |
Determines how the text for yes values for a Field of type Yes/No is displayed.
|
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 current Artifact.
(Inherited from Artifact.) |
Remarks
See Also