Represents the results of a read operation on a field.
Inheritance Hierarchy
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
The FieldResponse type exposes the following members.
Constructors
Name | Description | |
---|---|---|
![]() | FieldResponse | Initializes a new instance of the FieldResponse class |
Properties
Name | Description | |
---|---|---|
![]() | Actions |
Gets a list of RESTful operations that a user has permissions to perform on the field.
|
![]() | AllowGroupBy |
Gets or sets if the field is available to the group by when using Pivot.
|
![]() | AllowHtml |
Gets whether HTML code is allowed to execute within the field.
|
![]() | AllowPivot |
Gets or sets if the field is available to pivot on.
|
![]() | AllowSortTally |
Gets or sets sorting document lists based on the field.
|
![]() | ALT |
Gets or Sets whether the ctrl key is used in the keyboard shortcut for the field.
|
![]() | ArtifactID | (Inherited from ObjectIdentifier.) |
![]() | AssociativeObjectType |
Gets the associated object to this field.
|
![]() | AutoAddChoices |
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.
|
![]() | AvailableInFieldTree |
Gets or sets whether to place the field and its choices in the Field Tree Browser.
|
![]() | AvailableInViewer |
Gets whether the field is displayed in the viewer.
|
![]() | CreatedBy |
Gets the Artifact ID and name of the user who created the field.
|
![]() | CreatedOn |
Gets the date and time when the field was added to Relativity.
|
![]() | CTRL |
Gets or Sets whether the ctrl key is used in the keyboard shortcut for the field.
|
![]() | DisplayValueFalse |
Gets the display text for the False value of the field.
|
![]() | DisplayValueTrue |
Gets the display text for the True value of the field.
|
![]() | EnableDataGrid |
Gets if all data in this field should be imported to Data Grid.
|
![]() | FieldTreeView |
Gets or sets a view for Field Tree View.
|
![]() | FieldType |
Gets the type of the field.
|
![]() | FilterType |
Gets or sets the type of filter available for the field.
|
![]() | Formatting |
Gets or sets how the field value will be formatted when displayed.
|
![]() | FriendlyName |
Gets or sets a label for the relational field that users can easily understand.
|
![]() | Guids | (Inherited from ObjectIdentifier.) |
![]() | HasUnicode |
Gets or sets if the field has unicode.
|
![]() | ImportBehavior |
Gets or sets how blank values are handled when importing through the Relativity Desktop Client.
|
![]() | IncludeInTextIndex |
Gets whether the field values are added to the workspace’s SQL text index, making the field searchable via keyword search.
|
![]() | IsIdentifier |
Gets whether the field is the workspace’s unique identifier.
|
![]() | IsLinked |
Gets whether the field appears as a hyperlink within a list view.
|
![]() | IsRelational |
Gets or sets whether the field is relational.
|
![]() | IsRequired |
Gets whether the field is required.
|
![]() | Key |
The key used along with SHIFT, ALT, and/or CTRL keys in the keyboard shortcut for the field.
|
![]() | Keywords |
Gets optional words or phrase used to describe the field.
|
![]() | LastModifiedBy |
Gets the Artifact ID and name of the user who recently updated the field.
|
![]() | LastModifiedOn |
Gets the date and time when the field was most recently updated.
|
![]() | Length |
Gets the max length of the field.
|
![]() | Meta |
Gets a list of unsupported and read-only properties on the current field.
|
![]() | Name | (Inherited from DisplayableObjectIdentifier.) |
![]() | Notes |
Gets optional words or phrase used to describe the field.
|
![]() | ObjectType |
Gets the identifier for the object type associated with the field.
|
![]() | OpenToAssociations |
Gets whether an object field can display its information on an associated object field.
|
![]() | Order |
Gets or sets the pane icon order on the bottom of the Related Items pane.
|
![]() | OverlayBehavior |
Gets or sets the field overlay behavior.
|
![]() | PaneIcon |
Gets or sets an icon for display in the Related Items pane of the core reviewer interface.
|
![]() | PopupPickerView |
Gets or sets the items available in the pop-up picker view.
|
![]() | PropagateTo |
Gets the specified fields that coding values should be propagated to.
|
![]() | RelationalView |
Gets or sets the view that appears in the Related Items pane.
|
![]() | RelativityApplications |
Gets or sets a list of identifiers of associated Relativity Applications for the field.
|
![]() | SHIFT |
Gets or Sets whether the ctrl key is used in the keyboard shortcut for the field.
|
![]() | Source |
Gets or sets which processing field is mapped to the field.
|
![]() | Width |
Gets or sets the width (in pixels) of the column in the view.
|
![]() | Wrapping |
Gets or sets text wrapping for the 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.) |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
See Also