FieldResponse Class

Relativity Services API
Represents the results of a read operation on a field.
Inheritance Hierarchy

System.Object
  Relativity.Services.Interfaces.Shared.Models.ObjectIdentifier
    Relativity.Services.Interfaces.Shared.Models.DisplayableObjectIdentifier
      Relativity.Services.Interfaces.Field.Models.FieldResponse

Namespace:  Relativity.Services.Interfaces.Field.Models
Assembly:  Relativity.Services.Interfaces (in Relativity.Services.Interfaces.dll) Version: 640db774aa42dfbe1785add27fbb41844ec5c7d4
Syntax

public class FieldResponse : DisplayableObjectIdentifier

The FieldResponse type exposes the following members.

Constructors

  NameDescription
Public methodFieldResponse
Initializes a new instance of the FieldResponse class
Top
Properties

  NameDescription
Public propertyActions
Gets a list of RESTful operations that a user has permissions to perform on the field.
Public propertyAllowGroupBy
Gets or sets if the field is available to the group by when using Pivot.
Public propertyAllowHtml
Gets whether HTML code is allowed to execute within the field.
Public propertyAllowPivot
Gets or sets if the field is available to pivot on.
Public propertyAllowSortTally
Gets or sets sorting document lists based on the field.
Public propertyALT
Gets or Sets whether the ctrl key is used in the keyboard shortcut for the field.
Public propertyArtifactID (Inherited from ObjectIdentifier.)
Public propertyAssociativeObjectType
Gets the associated object to this field.
Public propertyAutoAddChoices
Gets whether the field should add all choices associated with the single or multiple choice field to an application. Returns false if the field is not a choice field type.
Public propertyAvailableInFieldTree
Gets or sets whether to place the field and its choices in the Field Tree Browser.
Public propertyAvailableInViewer
Gets whether the field is displayed in the viewer.
Public propertyCreatedBy
Gets the Artifact ID and name of the user who created the field.
Public propertyCreatedOn
Gets the date and time when the field was added to Relativity.
Public propertyCTRL
Gets or Sets whether the ctrl key is used in the keyboard shortcut for the field.
Public propertyDisplayValueFalse
Gets the display text for the False value of the field.
Public propertyDisplayValueTrue
Gets the display text for the True value of the field.
Public propertyEnableDataGrid
Gets if all data in this field should be imported to Data Grid.
Public propertyFieldTreeView
Gets or sets a view for Field Tree View.
Public propertyFieldType
Gets the type of the field.
Public propertyFilterType
Gets or sets the type of filter available for the field.
Public propertyFormatting
Gets or sets how the field value will be formatted when displayed.
Public propertyFriendlyName
Gets or sets a label for the relational field that users can easily understand.
Public propertyGuids (Inherited from ObjectIdentifier.)
Public propertyHasUnicode
Gets or sets if the field has unicode.
Public propertyImportBehavior
Gets or sets how blank values are handled when importing through the Relativity Desktop Client.
Public propertyIncludeInTextIndex
Gets whether the field values are added to the workspace’s SQL text index, making the field searchable via keyword search.
Public propertyIsIdentifier
Gets whether the field is the workspace’s unique identifier.
Public propertyIsLinked
Gets whether the field appears as a hyperlink within a list view.
Public propertyIsRelational
Gets or sets whether the field is relational.
Public propertyIsRequired
Gets whether the field is required.
Public propertyKey
The key used along with SHIFT, ALT, and/or CTRL keys in the keyboard shortcut for the field.
Public propertyKeywords
Gets optional words or phrase used to describe the field.
Public propertyLastModifiedBy
Gets the Artifact ID and name of the user who recently updated the field.
Public propertyLastModifiedOn
Gets the date and time when the field was most recently updated.
Public propertyLength
Gets the max length of the field.
Public propertyMeta
Gets a list of unsupported and read-only properties on the current field.
Public propertyName (Inherited from DisplayableObjectIdentifier.)
Public propertyNotes
Gets optional words or phrase used to describe the field.
Public propertyObjectType
Gets the identifier for the object type associated with the field.
Public propertyOpenToAssociations
Gets whether an object field can display its information on an associated object field.
Public propertyOrder
Gets or sets the pane icon order on the bottom of the Related Items pane.
Public propertyOverlayBehavior
Gets or sets the field overlay behavior.
Public propertyPaneIcon
Gets or sets an icon for display in the Related Items pane of the core reviewer interface.
Public propertyPopupPickerView
Gets or sets the items available in the pop-up picker view.
Public propertyPropagateTo
Gets the specified fields that coding values should be propagated to.
Public propertyRelationalView
Gets or sets the view that appears in the Related Items pane.
Public propertyRelativityApplications
Gets or sets a list of identifiers of associated Relativity Applications for the field.
Public propertySHIFT
Gets or Sets whether the ctrl key is used in the keyboard shortcut for the field.
Public propertySource
Gets or sets which processing field is mapped to the field.
Public propertyWidth
Gets or sets the width (in pixels) of the column in the view.
Public propertyWrapping
Gets or sets text wrapping for the field.
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
See Also

Reference