Show / Hide Table of Contents

Class Field

Represents the base field object.

Inheritance
System.Object
Artifact
NamedArtifact
Field
CurrencyField
DateField
DecimalField
FileField
FixedLengthTextField
LongTextField
MultipleChoiceField
MultipleObjectField
SingleChoiceField
SingleObjectField
UserField
WholeNumberField
YesNoField
Implements
IHasName
Inherited Members
NamedArtifact.Name
Artifact.ArtifactID
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Relativity.Testing.Framework.Models
Assembly: Relativity.Testing.Framework.dll
Syntax
[ObjectTypeName("Field")]
public class Field : NamedArtifact, IHasName

Properties

| Improve this Doc View Source

AllowGroupBy

Gets or sets a value indicating whether this Field is available for grouping in Pivot.

Declaration
public bool AllowGroupBy { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

AllowPivot

Gets or sets a value indicating whether a pivot can be performed on this Field.

Declaration
public bool AllowPivot { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

ArtifactTypeName

Gets or sets the artifact type name.

Declaration
public string ArtifactTypeName { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

FieldType

Gets or sets the type of the field, such as date, fixed-length text, long text, or others.

Declaration
public FieldType FieldType { get; set; }
Property Value
Type Description
FieldType
| Improve this Doc View Source

IsIdentifier

Gets or sets a value indicating whether field is identifier.

Declaration
public bool IsIdentifier { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsRequired

Gets or sets a value indicating whether the user must set a value on this Field.

Declaration
public bool IsRequired { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Linked

Gets or sets a value indicating whether a hyperlink for the field is available for this Field.

Declaration
[FieldName("IsLinked")]
public bool Linked { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

ObjectType

Gets or sets the object type.

Declaration
public ObjectType ObjectType { get; set; }
Property Value
Type Description
ObjectType
| Improve this Doc View Source

ParentArtifact

Gets or sets the parent artifact.

Declaration
public Artifact ParentArtifact { get; set; }
Property Value
Type Description
Artifact
| Improve this Doc View Source

PropagateTo

Gets or sets the PropagateTo Field.

Declaration
public FieldPropagate PropagateTo { get; set; }
Property Value
Type Description
FieldPropagate
| Improve this Doc View Source

Width

Gets or sets the number of pixels used for the column width of a field when it is displayed in the view.

Declaration
public virtual string Width { get; set; }
Property Value
Type Description
System.String

Implements

IHasName

Extension Methods

FieldExtensions.ToCategoryField(Field)
  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX