Relativity.API.Foundation.IField

IField

public interface IField : IFieldRef, IArtifactRef, IArtifact

Represents a Relativity field.

Documentation

bool AllowGroupBy { get; set; }

Indicates whether the field can be used for grouping in Relativity Pivot.

bool AllowHtml { get; set; }

Indicates whether the field allows HTML parsing on its value.

bool AllowPivot { get; set; }

Indicates whether the field is available in Relativity Pivot.

int? AssociativeArtifactTypeID { get; set; }

Identifies the artifact type associated with this field.

bool AutoAddChoices { get; set; }

Indicates whether the choices associated with this field are added to an application automatically.

bool AvailableInViewer { get; set; }

Indicates whether the field is displayed in the viewer.

int? CodeTypeID { get; set; }

Identifies a single or multi-choice field.

string ColumnName { get; }

The field's SQL column name. This is populated by AvfColumnName on the ViewFieldInfo

string DisplayValueFalse { get; set; }

The text to be displayed for false yes/no field values.

string DisplayValueTrue { get; set; }

The text to be displayed for true yes/no field values.

bool EnableDataGrid { get; set; }

Indicates if the field stores its data in Data Grid or SQL.

int FieldArtifactTypeID { get; set; }

The Artifact Type that the Field is on.

FieldCategory FieldCategory { get; }

Defines the category of the field. This category will not change once the field has been created.

int FieldDisplayTypeID { get; set; }

Defines how the field should be displayed.

int? FieldTreeView { get; set; }

Identifies a view that determines the values displayed in the field tree browser, and the order in which they are displayed.

FieldType FieldType { get; set; }

Specifies the FieldType of the field.

string FilterType { get; set; }

Determines the filter type available for the field.

string FormatString { get; set; }

Determines the format used to display Date or Whole Number fields.

string FriendlyName { get; set; }

A user-friendly label for relational fields.

FieldImportBehavior? ImportBehavior { get; set; }

Determines how blank relational field values are handled during import.

bool IsArtifactBaseField { get; set; }

Indicates if the field is a base system artifact field.

bool IsAvailableInChoiceTree { get; set; }

Indicates whether the field and its choices are displayed in the Field Tree.

bool IsAvailableToAssociativeObjects { get; set; }

Indicates whether the field can be displayed on associated objects.

bool IsEditable { get; set; }

Indicates if the field can be edited.

bool IsGroupByEnabled { get; set; }

Indicates if group by operations are enabled on the field.

bool IsIndexEnabled { get; set; }

Indexates whether values are added to a SQL text index.

bool IsLinked { get; set; }

Indicates if the field is displayed as a hyperlink.

bool IsReflected { get; }

Indicates if the field is reflected or multi-reflected.

bool IsRemovable { get; set; }

Indicates if the field can be deleted.

bool IsRequired { get; set; }

Indicates if the field is required.

bool IsSortable { get; set; }

Indicates if the field values can be sorted.

bool IsSystemField { get; }

Indicates if the field is a system managed field.

bool IsSystemOrRelationalField { get; }

Indicates if the field is a system or relational field.

bool IsVisible { get; set; }

Indicates if the field is visible.

IKeyboardShortcut KeyboardShortcut { get; set; }

Metadata for a keyboard shortcut for a document field.

int LinkLayoutArtifactID { get; set; }

The layout artifact ID to target from the field's link.

int? MaxLength { get; set; }

The maximum length of a fixed-length test field.

bool? OverlayBehavior { get; set; }

Determines how multiple value fields are handled during overlay imports.

int? PopupPickerView { get; set; }

Indicates that a popup picker is used when choosing values for the field.

int? RelationalIndexViewArtifactID { get; set; }

The view ID of the relational item pane.

bool UseUnicodeEncoding { get; set; }

Indicates if unicode encoding should be used when storing the field's text value.

object Value { get; set; }

The value of the field for an instance of an object.

string Width { get; set; }

Indicates the width, in pixels, of the column displaying the field's contents in a view.

bool Wrapping { get; set; }

Indicates whether the text ina field is displayed in multiple lines.