Relativity.Services.Interfaces.Field.Models.FieldResponse

public class FieldResponse : DisplayableObjectIdentifier

Represents the results of a read operation on a field.

Documentation

public List<Action> Actions { get; set; }

Gets a list of RESTful operations that a user has permissions to perform on the field.

public bool AllowGroupBy { get; set; }

Gets or sets if the field is available to the group by when using Pivot.

public bool AllowHtml { get; set; }

Gets whether HTML code is allowed to execute within the field.

public bool AllowPivot { get; set; }

Gets or sets if the field is available to pivot on.

public bool AllowSortTally { get; set; }

Gets or sets sorting document lists based on the field.

public bool ALT { get; set; }

Gets or Sets whether the ctrl key is used in the keyboard shortcut for the field.

public ObjectTypeIdentifier AssociativeObjectType { get; set; }

Gets the associated object to this field.

public bool AutoAddChoices { get; set; }

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 bool AvailableInFieldTree { get; set; }

Gets or sets whether to place the field and its choices in the Field Tree Browser.

public bool AvailableInViewer { get; set; }

Gets whether the field is displayed in the viewer.

public DisplayableObjectIdentifier CreatedBy { get; set; }

Gets the Artifact ID and name of the user who created the field.

public DateTime CreatedOn { get; set; }

Gets the date and time when the field was added to Relativity.

public bool CTRL { get; set; }

Gets or Sets whether the ctrl key is used in the keyboard shortcut for the field.

public string DisplayValueFalse { get; set; }

Gets the display text for the False value of the field.

public string DisplayValueTrue { get; set; }

Gets the display text for the True value of the field.

public bool EnableDataGrid { get; set; }

Gets if all data in this field should be imported to Data Grid.

public Securable<DisplayableObjectIdentifier> FieldTreeView { get; set; }

Gets or sets a view for Field Tree View.

public FieldType FieldType { get; set; }

Gets the type of the field.

public FilterType FilterType { get; set; }

Gets or sets the type of filter available for the field.

public Formatting Formatting { get; set; }

Gets or sets how the field value will be formatted when displayed.

public string FriendlyName { get; set; }

Gets or sets a label for the relational field that users can easily understand.

public bool HasUnicode { get; set; }

Gets or sets if the field has unicode.

public ImportBehavior ImportBehavior { get; set; }

Gets or sets how blank values are handled when importing through the Relativity Desktop Client.

public bool IncludeInTextIndex { get; set; }

Gets whether the field values are added to the workspace’s SQL text index, making the field searchable via keyword search.

public bool IsIdentifier { get; set; }

Gets whether the field is the workspace’s unique identifier.

public bool IsLinked { get; set; }

Gets whether the field appears as a hyperlink within a list view.

public bool IsRelational { get; set; }

Gets or sets whether the field is relational.

public bool IsRequired { get; set; }

Gets whether the field is required.

public string Key { get; set; }

The key used along with SHIFT, ALT, and/or CTRL keys in the keyboard shortcut for the field.

public string Keywords { get; set; }

Gets optional words or phrase used to describe the field.

public DisplayableObjectIdentifier LastModifiedBy { get; set; }

Gets the Artifact ID and name of the user who recently updated the field.

public DateTime LastModifiedOn { get; set; }

Gets the date and time when the field was most recently updated.

public int Length { get; set; }

Gets the max length of the field.

public Meta Meta { get; set; }

Gets a list of unsupported and read-only properties on the current field.

public string Notes { get; set; }

Gets optional words or phrase used to describe the field.

public ObjectTypeIdentifier ObjectType { get; set; }

Gets the identifier for the object type associated with the field.

public bool OpenToAssociations { get; set; }

Gets whether an object field can display its information on an associated object field.

public int Order { get; set; }

Gets or sets the pane icon order on the bottom of the Related Items pane.

public OverlayBehavior OverlayBehavior { get; set; }

Gets or sets the field overlay behavior.

public PaneIcon PaneIcon { get; set; }

Gets or sets an icon for display in the Related Items pane of the core reviewer interface.

public Securable<DisplayableObjectIdentifier> PopupPickerView { get; set; }

Gets or sets the items available in the pop-up picker view.

public SecurableList<DisplayableObjectIdentifier> PropagateTo { get; set; }

Gets the specified fields that coding values should be propagated to.

public Securable<DisplayableObjectIdentifier> RelationalView { get; set; }

Gets or sets the view that appears in the Related Items pane.

public SecurableList<DisplayableObjectIdentifier> RelativityApplications { get; set; }

Gets or sets a list of identifiers of associated Relativity Applications for the field.

public bool SHIFT { get; set; }

Gets or Sets whether the ctrl key is used in the keyboard shortcut for the field.

public FieldSource Source { get; set; }

Gets or sets which processing field is mapped to the field.

public int? Width { get; set; }

Gets or sets the width (in pixels) of the column in the view.

public bool Wrapping { get; set; }

Gets or sets text wrapping for the field.

public FieldResponse()