FieldFieldNames Class

Relativity Services API
The string names of fields used on Fields.
Inheritance Hierarchy

System.Object
  kCura.Relativity.Client.DTOs.ArtifactFieldNames
    kCura.Relativity.Client.DTOs.FieldFieldNames

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

public class FieldFieldNames : ArtifactFieldNames

The FieldFieldNames type exposes the following members.

Constructors

  NameDescription
Public methodFieldFieldNames
Initializes a new instance of the FieldFieldNames class
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 object.
(Inherited from Object.)
Top
Fields

  NameDescription
Public fieldStatic memberAllowGroupBy
Indicates whether the field can be used for grouping in Relativity Pivot.
Public fieldStatic memberAllowHTML
Indicates whether the field allows HTML code to execute within the field.
Public fieldStatic memberAllowPivot
Indicates whether the field is available in Relativity Pivot.
Public fieldStatic memberAllowSortTally
Indicates whether the field can be used to sort document lists.
Public fieldStatic memberAssociativeObjectType
Identifies the ObjectType associated with this field.
Public fieldStatic memberAutoAddChoices
Indicates whether all choices associated with a Single or Multiple Choice field are added to an application.
Public fieldStatic memberAvailableInFieldTree
Indicates whether the field and its choices are displayed in the Field Tree browser.
Public fieldStatic memberAvailableInViewer
Indicates whether the field is displayed in the viewer.
Public fieldStatic memberChoices
Used to return a list of valid Choices that a Field of type Choice accepts.
Public fieldStatic memberChoiceTypeID
Identifies a Single Choice Field or Multi-Choice Field.
Public fieldStatic memberEnableDataGrid
Determines where the text data is stored.
Public fieldStatic memberFieldTreeView
Identifies a view that determines the values displayed in the Field Tree browse, and the order in which they are displayed.
Public fieldStatic memberFieldTypeID
Represents the ID of a FieldType used to determine the functionality and presentation of the Field.
Public fieldStatic memberFilterType
Determines the filter type available for the field.
Public fieldStatic memberFormatting
Determines the format used to display Date or Whole Number fields.
Public fieldStatic memberFriendlyName
Provides a user-friendly label for a relational field.
Public fieldStatic memberIgnoreWarnings
Indicates if Create should succeed when warning messages are returned.
Public fieldStatic memberImportBehavior
Determines how blank values are handled during imports through the Relativity Desktop Client.
Public fieldStatic memberIncludeInTextIndex
Indicates whether field values are added to SQL text index in a workspace.
Public fieldStatic memberIsIdentifier
Indicates whether the field is a unique identifier for a workspace.
Public fieldStatic memberIsRelational
Indicates if the field is a relational field.
Public fieldStatic memberIsRequired
Determines whether the reviewer must populate the field with information in order to continue with the review process.
Public fieldStatic memberKeyboardShortcut
Defines a keyboard shortcut for a document field.
Public fieldStatic memberLength
Indicates the length of a fixed-length text field.
Public fieldStatic memberLinked
Indicates if the field is set as a hyperlink.
Public fieldStatic memberName
Represents the name of the field.
Public fieldStatic memberNoValue
Determines how the text for no values for a Field of type Yes/No is displayed.
Public fieldStatic memberObjectType
Determines the object that Relativity uses to classify the field.
Public fieldStatic memberOpenToAssociations
Determines whether an object field can display its information on an associated object field.
Public fieldStatic memberOrder
Determines the position of the Pane Icon on the Related Items pane of the viewer.
Public fieldStatic memberOverlayBehavior
Determines how multiple-value fields are handled during overlay imports through the Relativity Desktop Client.
Public fieldStatic memberPaneIcon
Determines the icon displayed in the Related Items pane of the viewer.
Public fieldStatic memberPopupPickerView
Determines the items are available in the popup picker view.
Public fieldStatic memberPropagateTo
Identifies a delimited list of related fields, which have their values automatically coded with the same value as this field.
Public fieldStatic memberRelationalView
Determines the view that appears in the Related Items pane of the viewer.
Public fieldStatic memberRelativityApplications
Represents a Multiple Object field specifying the Relativity Application objects associated with this ObjectType.
Public fieldStatic memberUnicode
Indicates if foreign language characters are allowed.
Public fieldStatic memberVisible
Indicates if the field is visible
Public fieldStatic memberWidth
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 fieldStatic memberWrapping
Indicates whether the text in a field is displayed in multiple lines.
Public fieldStatic memberYesValue
Determines how the text for yes values for a Field of type Yes/No is displayed.
Top
See Also

Reference